Update custom ssl docs with BASE_URL guidance #206
Conversation
| @@ -7,7 +7,8 @@ To enable SSL with your custom certificate, follow the steps below: | |||
| 1. Copy your certificate and key to certs/nginx.crt and certs/nginx.key | |||
| 2. Copy your dhparam file to certs/dhparam.pem | |||
| 3. Edit conf/nginx.conf to update `__server_names__` to your domain or IP address | |||
| 4. Perform any other configuration edits that you might need | |||
| 4. Perform any other configuration edits that you might need. Be sure to update sublime.env with the BASE_URL that will be used to access Sublime, according to your DNS configuration. See [here](https://docs.sublime.security/docs/quickstart-docker#using-a-proxy) for more details. | |||
There was a problem hiding this comment.
suggest replacing
sublime.env
With tick-brackets and a bit more context
the
sublime.envfile (which should be next todocker-compose.yml)
There was a problem hiding this comment.
Hey Madi, we could also copy or link to the configuration reminder in the typical (non-custom) SSL instructions. See step 2 "Configure Sublime" here. It's pretty much what the customer needed to see.
There was a problem hiding this comment.
@patrick-siewe-sublime I wonder if we should just remove the README in this repo? It seems confusing to have it in 2 places. I'd like to change the docs to incorporate both, ideally. We could branch, starting with step 2, into 2 sections: 1) certbot, and 2) custom certs. We could either point custom certs to here, or just copy these steps to there. This README could just include a link to the docs. Thoughts?
There was a problem hiding this comment.
Agreed 100% @madirey with consolidating instructions in one place is ideal.
Only question that comes to my mind is whether this is a good use of your time; if this hasn't been an issue in the two years since this Readme was touched, maybe consolidating has low ROI and it's ok to just copy the relevant details here for now (about updating sublime.env) -- unless you feel you have the time to do the larger rewrite and to get the +1 from whoever needs to give it.
There was a problem hiding this comment.
@patrick-siewe-sublime I'm having trouble editing the Readme docs at all, so I'm gonna place this one on hold for a bit.
madirey
dismissed
patrick-siewe-sublime’s stale review
Dismissing review as we may need some significant changes.
https://www.notion.so/sublimesecurity/Update-GitHub-custom-SSL-docs-to-include-sublime-env-BASE_URL-instructions-1e404655fc9d811a96dbc1ea7b227aba