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

[Feature] add documentation related to the "serve funscripts directly" option #4850

Closed
Kyr4l opened this issue May 18, 2024 · 4 comments
Closed
Labels
documentation Instructions and support material feature request

Comments

@Kyr4l
Copy link

Kyr4l commented May 18, 2024

the current option, explain very vaguely what it does, but doesn't tell anything else, especially about how it actually works, or what is needs to function properly.

i've been trying to get this option to work, but there is absolutely zero documentation related to it.

@DogmaDragon DogmaDragon added the documentation Instructions and support material label May 18, 2024
@WithoutPants
Copy link
Collaborator

To the best of my knowledge it doesn't require much more than the Handy being on the same network and that setting being enabled.

This is the existing documentation:
When enabled, funscripts will be served directly from Stash to your Handy device without using the third party Handy server. Requires that Stash be accessible from your Handy device.

The only thing I can see that could cause people to get stuck is that if you have credentials enabled on the server then you need to have the api key generated. I can add that to the documentation.

What issue are you running into?

@Kyr4l
Copy link
Author

Kyr4l commented May 20, 2024

well from my experience this feature has never worked, the device is on 172.16.1.10/16 and the server is on 172.16.0.220/16 (these are example IPs)
as soon as the feature is enabled, stash says that the device cannot be reached. even tho both devices are on the same network, and the devices can reach each other.
maybe that feature requires an extra port opened, some other implementations actually do that, but they state which port is used.
i do have credentials enabled on the server too,

@WithoutPants
Copy link
Collaborator

i do have credentials enabled on the server too,

Have you generated an API key in stash?

@Kyr4l
Copy link
Author

Kyr4l commented May 21, 2024

i do have credentials enabled on the server too,

Have you generated an API key in stash?

i just did it and yes it works now, didn't know i needed an API key to be generated to use this feature.
may i recommend adding this requirement somewhere in the UI ? i can do a PR if needed

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Instructions and support material feature request
Projects
Status: Done
Development

No branches or pull requests

3 participants