Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

docs: fix links for revere-proxy docs#15026

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.

By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Merged
matifali merged 6 commits intomainfromatif/fix-docs
Oct 10, 2024
Merged
Show file tree
Hide file tree
Changes fromall commits
Commits
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
4 changes: 4 additions & 0 deletionsdocs/admin/setup/index.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -61,6 +61,10 @@ The Coder server can directly use TLS certificates with `CODER_TLS_ENABLE` and
accompanying configuration flags. However, Coder can also run behind a
reverse-proxy to terminate TLS certificates from LetsEncrypt.

- [Apache](../../tutorials/reverse-proxy-apache.md)
- [Caddy](../../tutorials/reverse-proxy-caddy.md)
- [NGINX](../../tutorials/reverse-proxy-nginx.md)

### Kubernetes TLS configuration

Below are the steps to configure Coder to terminate TLS when running on
Expand Down
28 changes: 0 additions & 28 deletionsdocs/admin/setup/web-server/apache/coder.conf
View file
Open in desktop

This file was deleted.

15 changes: 0 additions & 15 deletionsdocs/admin/setup/web-server/caddy/Caddyfile
View file
Open in desktop

This file was deleted.

57 changes: 0 additions & 57 deletionsdocs/admin/setup/web-server/caddy/docker-compose.yaml
View file
Open in desktop

This file was deleted.

15 changes: 15 additions & 0 deletionsdocs/manifest.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -699,6 +699,21 @@
"description": "Learn how to clone Git repositories in Coder",
"path": "./tutorials/cloning-git-repositories.md"
},
{
"title": "Use Apache as a Reverse Proxy",
"description": "Learn how to use Apache as a reverse proxy",
"path": "./tutorials/reverse-proxy-apache.md"
},
{
"title": "Use Caddy as a Reverse Proxy",
"description": "Learn how to use Caddy as a reverse proxy",
"path": "./tutorials/reverse-proxy-caddy.md"
},
{
"title": "Use NGINX as a Reverse Proxy",
"description": "Learn how to use NGINX as a reverse proxy",
"path": "./tutorials/reverse-proxy-nginx.md"
},
{
"title": "FAQs",
"description": "Miscellaneous FAQs from our community",
Expand Down
6 changes: 3 additions & 3 deletionsdocs/tutorials/faqs.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -62,9 +62,9 @@ troubleshooting.

### How do I configure NGINX as the reverse proxy in front of Coder?

[Thisdoc](../admin/setup/web-server/nginx/index.md) in ourrepo explains in
detail how toconfigure NGINX with Coder so that our Tailscale Wireguard
networking functionsproperly.
[Thistutorial](./reverse-proxy-nginx.md) in ourdocs explains in detail how to
configure NGINX with Coder so that our Tailscale Wireguard networking functions
properly.

### How do I hide some of the default icons in a workspace like VS Code Desktop, Terminal, SSH, Ports?

Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,7 @@
## Requirements

1. Start a Coder deployment and be sure to set the following
[configuration values](../../index.md):
[configuration values](../admin/setup/index.md):

```env
CODER_HTTP_ADDRESS=127.0.0.1:3000
Expand Down
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,31 +11,101 @@ certificates, you'll need a domain name that resolves to your Caddy server.
1. [Install Docker](https://docs.docker.com/engine/install/) and
[Docker Compose](https://docs.docker.com/compose/install/)

1. Start with our example configuration
2. Create a `docker-compose.yaml` file and add the following:

```yaml
services:
coder:
image: ghcr.io/coder/coder:${CODER_VERSION:-latest}
environment:
CODER_PG_CONNECTION_URL: "postgresql://${POSTGRES_USER:-username}:${POSTGRES_PASSWORD:-password}@database/${POSTGRES_DB:-coder}?sslmode=disable"
CODER_HTTP_ADDRESS: "0.0.0.0:7080"
# You'll need to set CODER_ACCESS_URL to an IP or domain
# that workspaces can reach. This cannot be localhost
# or 127.0.0.1 for non-Docker templates!
CODER_ACCESS_URL: "${CODER_ACCESS_URL}"
# Optional) Enable wildcard apps/dashboard port forwarding
CODER_WILDCARD_ACCESS_URL: "${CODER_WILDCARD_ACCESS_URL}"
# If the coder user does not have write permissions on
# the docker socket, you can uncomment the following
# lines and set the group ID to one that has write
# permissions on the docker socket.
#group_add:
# - "998" # docker group on host
volumes:
- /var/run/docker.sock:/var/run/docker.sock
depends_on:
database:
condition: service_healthy

database:
image: "postgres:16"
ports:
- "5432:5432"
environment:
POSTGRES_USER: ${POSTGRES_USER:-username} # The PostgreSQL user (useful to connect to the database)
POSTGRES_PASSWORD: ${POSTGRES_PASSWORD:-password} # The PostgreSQL password (useful to connect to the database)
POSTGRES_DB: ${POSTGRES_DB:-coder} # The PostgreSQL default database (automatically created at first launch)
volumes:
- coder_data:/var/lib/postgresql/data # Use "docker volume rm coder_coder_data" to reset Coder
healthcheck:
test:
[
"CMD-SHELL",
"pg_isready -U ${POSTGRES_USER:-username} -d ${POSTGRES_DB:-coder}",
]
interval: 5s
timeout: 5s
retries: 5

caddy:
image: caddy:2.6.2
ports:
- "80:80"
- "443:443"
- "443:443/udp"
volumes:
- $PWD/Caddyfile:/etc/caddy/Caddyfile
- caddy_data:/data
- caddy_config:/config

volumes:
coder_data:
caddy_data:
caddy_config:
```

```shell
# Create a project folder
cd $HOME
mkdir coder-with-caddy
cd coder-with-caddy

# Clone coder/coder and copy the Caddy example
git clone https://github.com/coder/coder /tmp/coder
mv /tmp/coder/docs/admin/setup/web-server/caddy $(pwd)
3. Create a `Caddyfile` and add the following:

```caddyfile
{
on_demand_tls {
ask http://example.com
}
}

coder.example.com, *.coder.example.com {
reverse_proxy coder:7080
tls {
on_demand
issuer acme {
email email@example.com
}
}
}
```

1. Modify the [Caddyfile](./Caddyfile) and change the following values:
Here;

- `localhost:3000`: Change to `coder:7080` (Coder container on Docker
network)
- `coder:7080` is the address of the Coder container on the Docker network.
- `coder.example.com` is the domain name you're using for Coder.
- `*.coder.example.com` is the domain name for wildcard apps, commonly used
for [dashboard port forwarding](../admin/networking/port-forwarding.md).
This is optional and can be removed.
- `email@example.com`: Email to request certificates from LetsEncrypt/ZeroSSL
(does not have to be Coder admin email)
- `coder.example.com`: Domain name you're using for Coder.
- `*.coder.example.com`: Domain name for wildcard apps, commonly used for
[dashboard port forwarding](../../../networking/port-forwarding.md). This
is optional and can be removed.

1. Start Coder. Set `CODER_ACCESS_URL` and `CODER_WILDCARD_ACCESS_URL` to the
4. Start Coder. Set `CODER_ACCESS_URL` and `CODER_WILDCARD_ACCESS_URL` to the
domain you're using in your Caddyfile.

```shell
Expand All@@ -46,11 +116,23 @@ certificates, you'll need a domain name that resolves to your Caddy server.

### Standalone

1. If you haven't already, [install Coder](../../../../install/index.md)
1. If you haven't already, [install Coder](../install/index.md)

2. Install [Caddy Server](https://caddyserver.com/docs/install)

3. Copy our sample [Caddyfile](./Caddyfile) and change the following values:
3. Copy our sample `Caddyfile` and change the following values:

```caddyfile
{
on_demand_tls {
ask http://example.com
}
}

coder.example.com, *.coder.example.com {
reverse_proxy coder:7080
}
```

> If you're installed Caddy as a system package, update the default Caddyfile
> with `vim /etc/caddy/Caddyfile`
Expand All@@ -59,14 +141,14 @@ certificates, you'll need a domain name that resolves to your Caddy server.
(does not have to be Coder admin email)
- `coder.example.com`: Domain name you're using for Coder.
- `*.coder.example.com`: Domain name for wildcard apps, commonly used for
[dashboard port forwarding](../../../networking/port-forwarding.md). This
[dashboard port forwarding](../admin/networking/port-forwarding.md). This
is optional and can be removed.
- `localhost:3000`: Address Coder is running on. Modify this if you changed
`CODER_HTTP_ADDRESS` in the Coder configuration.
- _DO NOT CHANGE the `ask http://example.com` line! Doing so will result in
your certs potentially not being generated._

4. [Configure Coder](../../index.md) and change the following values:
4. [Configure Coder](../admin/setup/index.md) and change the following values:

- `CODER_ACCESS_URL`: root domain (e.g. `https://coder.example.com`)
- `CODER_WILDCARD_ACCESS_URL`: wildcard domain (e.g. `*.example.com`).
Expand DownExpand Up@@ -116,7 +198,7 @@ By default, this configuration uses Caddy's
[on-demand TLS](https://caddyserver.com/docs/caddyfile/options#on-demand-tls) to
generate a certificate for each subdomain (e.g. `app1.coder.example.com`,
`app2.coder.example.com`). When users visit new subdomains, such as accessing
[ports on a workspace](../../../networking/port-forwarding.md), the request will
[ports on a workspace](../admin/networking/port-forwarding.md), the request will
take an additional 5-30 seconds since a new certificate is being generated.

For production deployments, we recommend configuring Caddy to generate a
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,7 @@
## Requirements

1. Start a Coder deployment and be sure to set the following
[configuration values](../../index.md):
[configuration values](../admin/setup/index.md):

```env
CODER_HTTP_ADDRESS=127.0.0.1:3000
Expand Down
Loading
[8]ページ先頭
©2009-2025 Movatter.jp