Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation: Inform about url encoded values in synology widgets #4411

Closed
wants to merge 1 commit into from

Conversation

RiKap
Copy link

@RiKap RiKap commented Dec 13, 2024

Proposed change

  • Improve documentation for synology widgets
  • Mention that username & password should be url encoded as these data will be used in url query parameter

Type of change

  • New service widget
  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Documentation only
  • Other (please explain)

Checklist:

  • If applicable, I have added corresponding documentation changes.
  • If applicable, I have reviewed the feature and / or service widget guidelines.
  • I have checked that all code style checks pass using pre-commit hooks and linting checks.
  • If applicable, I have tested my code for new features & regressions on both mobile & desktop devices, using the latest version of major browsers.

@RiKap RiKap changed the title Synology: Inform about url encoded values Documentation: Inform about url encoded values in synology widgets Dec 13, 2024
@shamoon
Copy link
Collaborator

shamoon commented Dec 13, 2024

Thanks, the way to handle this will be to actually encode the params, not expect the user to know what the heck that means. If you're interested in testing out a docker image later I will have one to try (I dont have a syno device to test).

Thanks

@shamoon shamoon closed this Dec 13, 2024
@shamoon
Copy link
Collaborator

shamoon commented Dec 13, 2024

@RiKap if you would like to test out the docker image tagged feature-syno-encode-params can you let me know if things work OK?

@shamoon
Copy link
Collaborator

shamoon commented Dec 14, 2024

Sorry to nag @RiKap , any thoughts? If you're not able to test no worries, I can ask around

@shamoon
Copy link
Collaborator

shamoon commented Dec 18, 2024

So this whole thing has sent me on a bit of a wild goose chase. But in talking with users on discord, there are at least some people for whom it is not necessary to encode the password (and none who said the opposite). So after spending some time to make the widget automatically handle this I've had to revert it, and in that case this still doesn't belong in the docs.

If we can get a very clear answer about this we can re-address. Thanks

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants