docs: add nginx reverse-proxy example #6185

matifali · 2023-02-13T14:59:29Z

This PR adds an Nginx reverse-proxy example to deploy Coder with a wildcard tls certificate using LetsEncrypt Certbot.

This will resolve #6086, along with #6213.

Tested with a wildcard subdomain.

This PR adds nginx reverse-proxy example to provision coder with tls certificate using letsencrypt certbot. This will partially resolve #6086.

bpmct

Thanks for the contribution! I haven't tested it yet, but have some grammar/formatting feedback. We don't have a documented style guide yet, but just some change requests to make the doc read more like the rest of ours.

I can test the wildcard stuff later.

examples/web-server/nginx/README.md

Co-authored-by: Ben Potter <[email protected]>

bpmct

Another cycle of reviews. I'll probably look one more time while I test it out (beware: I may have even more formatting suggestions lol)

examples/web-server/nginx/README.md

Co-authored-by: Ben Potter <[email protected]>

matifali · 2023-02-13T19:25:19Z

updated with most of your suggestions.

0t4u · 2023-02-13T19:47:09Z

Hello, can I suggest using the $host variable when setting the Host header instead of $server_name as $server_name always passes the base domain and not the actual domain you are connecting from when wildcard subdomains are configured.

matifali · 2023-02-13T20:03:21Z

Hello, can I suggest using the $host variable when setting the Host header instead of $server_name as $server_name always passes the base domain and not the actual domain you are connecting from when wildcard subdomains are configured.

Thank you for your suggestion. This is a WIP, and I still need to test this with a wildcard domain.

I will update.

matifali · 2023-02-13T22:19:14Z

@bpmct I have tested this, and it works. You may review it and merge it after testing.

bpmct

Tried it and it worked great. 🎉 This is my final round of feedback, then I'm pretty sure we are good to publish.

Some of this feedback may be relevant to the Apache docs too, so could you change in both places?

docs/admin/configure.md

examples/web-server/nginx/README.md

bpmct · 2023-02-15T11:56:36Z

examples/web-server/nginx/README.md

+
+## Requirements
+
+1. Start a Coder deployment with a wildcard subdomain. See [this guide](https://coder.com/docs/v2/latest/admin/configure#wildcard-access-url) for more information.


I noticed it was important to have HTTP_ADDRESS as 3000. Plus the access URL is also important to set.

Suggested change

1. Start a Coder deployment with a wildcard subdomain. See [this guide](https://coder.com/docs/v2/latest/admin/configure#wildcard-access-url) for more information.

1. Start a Coder deployment and be sure to set the following [configuration values](https://coder.com/docs/v2/latest/admin/configure):

```console

CODER_HTTP_ADDRESS=127.0.0.1:3000

CODER_ACCESS_URL=https://coder.example.com

CODER_WILDCARD_ACCESS_URL=*coder.example.com

```

Throughout the guide, be sure to replace `coder.example.com` with the domain you intend to use with Coder.

What do you think about replacing all cases with CODER_SUBDOMAIN with coder.example.com? We tend to do this in other places in our docs, such as in the Caddy docs.

Yes, that is a better option. I will replace all YOUR_SUBDOMAIN with CODER_SUBDOMAIN

examples/web-server/nginx/README.md

Co-authored-by: Ben Potter <[email protected]>

examples/web-server/nginx/README.md

matifali added 3 commits February 13, 2023 17:56

docs: Add nginx reverse-proxy example

2c7f0cf

This PR adds nginx reverse-proxy example to provision coder with tls certificate using letsencrypt certbot. This will partially resolve #6086.

change nginx example to to absolute path

d29da64

Merge branch 'coder:main' into rev-proxy-auto-tls

247a060

bpmct requested changes Feb 13, 2023

View reviewed changes

matifali and others added 13 commits February 13, 2023 19:39

Update examples/web-server/nginx/README.md

3c247a5

Co-authored-by: Ben Potter <[email protected]>

Update examples/web-server/nginx/README.md

8a96176

Co-authored-by: Ben Potter <[email protected]>

Update examples/web-server/nginx/README.md

4f25817

Co-authored-by: Ben Potter <[email protected]>

Update examples/web-server/nginx/README.md

099428a

Co-authored-by: Ben Potter <[email protected]>

Update examples/web-server/nginx/README.md

d3913b3

Co-authored-by: Ben Potter <[email protected]>

Update examples/web-server/nginx/README.md

7f8d795

Co-authored-by: Ben Potter <[email protected]>

Update examples/web-server/nginx/README.md

3d306a4

Co-authored-by: Ben Potter <[email protected]>

Update examples/web-server/nginx/README.md

69eb387

Co-authored-by: Ben Potter <[email protected]>

Update examples/web-server/nginx/README.md

c1111b3

Co-authored-by: Ben Potter <[email protected]>

Update examples/web-server/nginx/README.md

af32c58

Co-authored-by: Ben Potter <[email protected]>

Update examples/web-server/nginx/README.md

b672a1f

Co-authored-by: Ben Potter <[email protected]>

Update examples/web-server/nginx/README.md

f080259

Co-authored-by: Ben Potter <[email protected]>

Update examples/web-server/nginx/README.md

838e008

Co-authored-by: Ben Potter <[email protected]>

bpmct reviewed Feb 13, 2023

View reviewed changes

examples/web-server/nginx/README.md Outdated Show resolved Hide resolved

examples/web-server/nginx/README.md Outdated Show resolved Hide resolved

examples/web-server/nginx/README.md Outdated Show resolved Hide resolved

examples/web-server/nginx/README.md Outdated Show resolved Hide resolved

matifali and others added 3 commits February 13, 2023 22:08

Update examples/web-server/nginx/README.md

23dd1e3

Co-authored-by: Ben Potter <[email protected]>

Update examples/web-server/nginx/README.md

7a7e7e4

Co-authored-by: Ben Potter <[email protected]>

refactor: replaced bullets with numbered lists

a5abc85

matifali added 2 commits February 13, 2023 22:31

remove the ambiguous ip addr.

3f1353e

fixed a typo

8e5531d

matifali added 2 commits February 13, 2023 23:19

correctly handle the wildcard subdomain

8c343f0

simplified after testing

86e7dae

matifali requested a review from bpmct February 13, 2023 22:11

matifali marked this pull request as ready for review February 13, 2023 22:11

matifali added 3 commits February 14, 2023 01:27

fmt: prettier formatting

7d28e51

Adapt to the coder style guide

a642933

fix: agent disconnection

77149bc

matifali changed the title ~~docs: Add nginx reverse-proxy example~~ docs: add nginx reverse-proxy example Feb 14, 2023

Merge branch 'coder:main' into rev-proxy-auto-tls

ff6fd37

bpmct requested changes Feb 15, 2023

View reviewed changes

matifali and others added 5 commits February 15, 2023 15:54

Update examples/web-server/nginx/README.md

4b5362c

Co-authored-by: Ben Potter <[email protected]>

Update docs/admin/configure.md

35247ed

Co-authored-by: Ben Potter <[email protected]>

Update examples/web-server/nginx/README.md

30163f4

Co-authored-by: Ben Potter <[email protected]>

updated with suggested changes

5b54368

updated with requested changes

4d0deb6

matifali requested a review from bpmct February 15, 2023 15:19

bpmct reviewed Feb 15, 2023

View reviewed changes

examples/web-server/nginx/README.md Outdated Show resolved Hide resolved

bpmct approved these changes Feb 15, 2023

View reviewed changes

add reference to certbot docs for other dns providers

065ed25

bpmct merged commit 786ad8d into coder:main Feb 15, 2023

github-actions bot locked and limited conversation to collaborators Feb 15, 2023

matifali deleted the rev-proxy-auto-tls branch February 15, 2023 20:50

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: add nginx reverse-proxy example #6185

docs: add nginx reverse-proxy example #6185

matifali commented Feb 13, 2023 •

edited

Loading

bpmct left a comment

bpmct left a comment

matifali commented Feb 13, 2023

0t4u commented Feb 13, 2023

matifali commented Feb 13, 2023

matifali commented Feb 13, 2023

bpmct left a comment •

edited

Loading

bpmct Feb 15, 2023

matifali Feb 15, 2023 •

edited

Loading


		## Requirements

		1. Start a Coder deployment with a wildcard subdomain. See [this guide](https://coder.com/docs/v2/latest/admin/configure#wildcard-access-url) for more information.

-. Start a Coder deployment with a wildcard subdomain. See [this guide](https://coder.com/docs/v2/latest/admin/configure#wildcard-access-url) for more information.
+. Start a Coder deployment and be sure to set the following [configuration values](https://coder.com/docs/v2/latest/admin/configure):
+    ```console
+    CODER_HTTP_ADDRESS=127.0.0.1:3000
+    CODER_ACCESS_URL=https://coder.example.com
+    CODER_WILDCARD_ACCESS_URL=*coder.example.com
+    ```
+    Throughout the guide, be sure to replace `coder.example.com` with the domain you intend to use with Coder.

docs: add nginx reverse-proxy example #6185

docs: add nginx reverse-proxy example #6185

Conversation

matifali commented Feb 13, 2023 • edited Loading

bpmct left a comment

Choose a reason for hiding this comment

bpmct left a comment

Choose a reason for hiding this comment

matifali commented Feb 13, 2023

0t4u commented Feb 13, 2023

matifali commented Feb 13, 2023

matifali commented Feb 13, 2023

bpmct left a comment • edited Loading

Choose a reason for hiding this comment

bpmct Feb 15, 2023

Choose a reason for hiding this comment

matifali Feb 15, 2023 • edited Loading

Choose a reason for hiding this comment

matifali commented Feb 13, 2023 •

edited

Loading

bpmct left a comment •

edited

Loading

matifali Feb 15, 2023 •

edited

Loading