fix(installer): clarify install documentation around specifying a non-default port #3126
Conversation
e605595 to
0d42f44
Compare
|
Are you testing this with a non-default client-facing port or is the non-default port only behind the reverse proxy? |
Behind the reverse proxy, the part where the port is specified in a 8000 rgument(s) to the installer (or via env). Without specifying the port in both places, the API will not even be able to start. |
|
Hmm... Then this configuration is going to produce broken user-facing links in things like emails. The actual issue is that the API should not be using the Line 32 in cf172d5 |
Heard; I think the main part of this issue is that the documentation is a little lean at best (misleading at worst?), for someone trying to set up on a non-standard port without a reverse proxy. Then. if it's misconfigured, the resulting API startup issue is a bit tricky to troubleshoot, as there is no easy indication that this is what the problem is, and how to fix it. The Troubleshooting section offers some tips on viewing log files from each service, but in this case the API seems to fail before it starts logging, and the web interface returns a 503, so there is not much to go on. What would have helped me is a paragraph discussing alternative ports, where there are URL and port config settings that need to be considered (with examples), and something indicating that this can result in the API not starting up, for those who are searching the docs for answers. An separate paragraph would also be good to cover the specifics of configuring for docker, that you pointed out. |
|
What about including such a section or tutorial instead? Talk about how to configure things and what parts of the install need to be changed |
Description
In the Admin Manual section dealing with running the installer and specifying a port other than the default, there was some incongruity in how the public URL should be specified. The port needs to be provided both as an argument to
--listen-portas well in the public URL. In particular, when used as shown, one of the examples as previously written would lead to the API not being able to start after an otherwise successful installation run, causing confusion.Testing Notes
I tested the example as shown in the updated installation document, and the system (including the API) was able to start successfully.
Links
Closes: #3113