opentogethertube icon indicating copy to clipboard operation
opentogethertube copied to clipboard

Improve first time setup user experience for self hosted use case

Open dyc3 opened this issue 4 years ago • 2 comments

Problem Currently, when deploying OpenTogetherTube, the user must manually edit the text config found in env/, usually env/production.env, to add various API keys. This works fine, but may not be suitable for people that aren't very technically inclined.

Solution On first run, a URL should be provided to guide the user through creating an administrator account, adding API keys, and setting other options.

After setup, the administrator account should still have access to modify the config through a web interface.

Describe alternatives you've considered The current way to configure OpenTogetherTube is adequate, but not exactly ideal when deploying in a docker container.

Additional context N/A

dyc3 avatar Apr 14 '20 16:04 dyc3

If you're still looking for recommendations on how to improve the installation guide for new users, it would be helpful to include a section on how to serve behind a reverse proxy.

I'm brand new to WebSockets, so I didn't realize that some tweaking is needed to properly serve a WebSocket-based app behind a reverse proxy. With a bit of debugging and research, I was able to get my nginx setup working, but it would have been great if OTT's installation guide had a section on it.

The fixing config settings are:

proxy_http_version 1.1;
proxy_set_header Upgrade $http_upgrade;
proxy_set_header Connection "upgrade";

Courtesy of https://chrislea.com/2013/02/23/proxying-websockets-with-nginx/

Thanks for the great project, by the way! :smiley:

mrjohnson22 avatar Jun 25 '20 00:06 mrjohnson22

I've added instructions to the github wiki. I haven't exactly tested them though, let me know if anything doesn't work.

dyc3 avatar Jun 25 '20 02:06 dyc3