Skip to content

docs: add nginx reverse-proxy example #6185

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.

Sign up for GitHub

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

Merged
merged 33 commits into from
Feb 15, 2023
Merged

docs: add nginx reverse-proxy example #6185

Changes from 1 commit
Commits
Show all changes
33 commits
Select commit Hold shift + click to select a range
2c7f0cf
docs: Add nginx reverse-proxy example
matifali Feb 13, 2023
d29da64
change nginx example to to absolute path
matifali Feb 13, 2023
247a060
Merge branch 'coder:main' into rev-proxy-auto-tls
matifali Feb 13, 2023
3c247a5
Update examples/web-server/nginx/README.md
matifali Feb 13, 2023
8a96176
Update examples/web-server/nginx/README.md
matifali Feb 13, 2023
4f25817
Update examples/web-server/nginx/README.md
matifali Feb 13, 2023
099428a
Update examples/web-server/nginx/README.md
matifali Feb 13, 2023
d3913b3
Update examples/web-server/nginx/README.md
matifali Feb 13, 2023
7f8d795
Update examples/web-server/nginx/README.md
matifali Feb 13, 2023
3d306a4
Update examples/web-server/nginx/README.md
matifali Feb 13, 2023
69eb387
Update examples/web-server/nginx/README.md
matifali Feb 13, 2023
c1111b3
Update examples/web-server/nginx/README.md
matifali Feb 13, 2023
af32c58
Update examples/web-server/nginx/README.md
matifali Feb 13, 2023
b672a1f
Update examples/web-server/nginx/README.md
matifali Feb 13, 2023
f080259
Update examples/web-server/nginx/README.md
matifali Feb 13, 2023
838e008
Update examples/web-server/nginx/README.md
matifali Feb 13, 2023
23dd1e3
Update examples/web-server/nginx/README.md
matifali Feb 13, 2023
7a7e7e4
Update examples/web-server/nginx/README.md
matifali Feb 13, 2023
a5abc85
refactor: replaced bullets with numbered lists
matifali Feb 13, 2023
3f1353e
remove the ambiguous ip addr.
matifali Feb 13, 2023
8e5531d
fixed a typo
matifali Feb 13, 2023
8c343f0
correctly handle the wildcard subdomain
matifali Feb 13, 2023
86e7dae
simplified after testing
matifali Feb 13, 2023
7d28e51
fmt: prettier formatting
matifali Feb 13, 2023
a642933
Adapt to the coder style guide
matifali Feb 13, 2023
77149bc
fix: agent disconnection
matifali Feb 14, 2023
ff6fd37
Merge branch 'coder:main' into rev-proxy-auto-tls
matifali Feb 15, 2023
4b5362c
Update examples/web-server/nginx/README.md
matifali Feb 15, 2023
35247ed
Update docs/admin/configure.md
matifali Feb 15, 2023
30163f4
Update examples/web-server/nginx/README.md
matifali Feb 15, 2023
5b54368
updated with suggested changes
matifali Feb 15, 2023
4d0deb6
updated with requested changes
matifali Feb 15, 2023
065ed25
add reference to certbot docs for other dns providers
matifali Feb 15, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Update examples/web-server/nginx/README.md 
Co-authored-by: Ben Potter <me@bpmct.net>
  • Loading branch information
@matifali @bpmct
matifali and bpmct authored Feb 15, 2023
commit 4b5362c59feb4cf9dfebff8520aed6ffefdd4549
2 changes: 1 addition & 1 deletion examples/web-server/nginx/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Member Author

@matifali matifali Feb 15, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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


2. Configure your DNS provider to point your YOUR_SUBDOMAIN and \*.YOUR_SUBDOMAIN to your server's public ip.
2. Configure your DNS provider to point your YOUR_SUBDOMAIN and \*.YOUR_SUBDOMAIN to your server's public IP address.

> For example, to use `coder.example.com` as your subdomain, configure `coder.example.com` and `*.coder.example.com` to point to your server's public ip. This can be done by adding A records in your DNS provider's dashboard.

Expand Down