You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/install/offline.md
+33-2Lines changed: 33 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -1,8 +1,22 @@
1
1
# Offline Deployments
2
2
3
-
Coder can run in offline / air-gapped environments.
3
+
All Coder features are supported in offline / behind firewalls / in air-gapped environments. However, some changes to your configuration are necessary.
4
4
5
-
## Building & push a custom Coder image
5
+
> This is a general comparison. Keep reading for a full tutorial running Coder offline with Kubernetes or Docker.
| Terraform binary | By default, Coder downloads Terraform binary from [releases.hashicorp.com](https://releases.hashicorp.com)| Terraform binary must be included in `PATH` for the VM or container image. [Supported versions](https://github.com/coder/coder/blob/main/provisioner/terraform/install.go#L23-L24)|
10
+
| Terraform registry | Coder templates will attempt to download providers from [registry.terraform.io](https://registry.terraform.io) or [custom source addresses](https://developer.hashicorp.com/terraform/language/providers/requirements#source-addresses) specified in each template |[Custom source addresses](https://developer.hashicorp.com/terraform/language/providers/requirements#source-addresses) can be specified in each Coder template, or a custom registry/mirror can be used. More details below |
11
+
| STUN | By default, Coder uses Google's public STUN server for direct workspace connections | STUN can be safely [disabled](../cli/coder_server#--derp-server-stun-addresses), users can still connect via [relayed connections](../networking.md#-geo-distribution). Alternatively, you can set a [custom DERP server](../cli/coder_server#--derp-server-stun-addresses)|
12
+
| DERP | By default, Coder's built-in DERP relay can be used, or [Tailscale's public relays](../networking.md#relayed-connections). | By default, Coder's built-in DERP relay can be used, or [custom relays](../networking.md#custom-relays). |
13
+
| PostgreSQL | If no [PostgreSQL connection URL](../cli/coder_server#--postgres-url) is specified, Coder will download Postgres from [repo1.maven.org](https://repo1.maven.org)| An external database is required, you must specify a [PostgreSQL connection URL](../cli/coder_server#--postgres-url)|
14
+
| Telemetry | Telemetry is on by default, and [can be disabled](../cli/coder_server#--telemetry)| Telemetry [can be disabled](../cli/coder_server#--telemetry)|
15
+
| Update check | By default, Coder checks for updates from [GitHub releases](https:/github.com/coder/coder/releases)| Update checks [can be disabled](../cli/coder_server#--update-check)|
16
+
17
+
## Offline container images
18
+
19
+
The following instructions walk you through how to build a custom Coder server image for Docker or Kubernetes
6
20
7
21
First, build and push a container image extending our official image with the following:
Copy file name to clipboardExpand all lines: docs/networking.md
+8-6Lines changed: 8 additions & 6 deletions
Original file line number
Diff line number
Diff line change
@@ -50,22 +50,24 @@ Direct connections are a straight line between the user and workspace, so there
50
50
is no special geo-distribution configuration. To speed up direct connections,
51
51
move the user and workspace closer together.
52
52
53
+
If a direct connection is not available (e.g. client or server is behind NAT), Coder
54
+
will use a relayed connection. By default, [Coder uses Google's public STUN server](./cli/coder_server#--derp-server-stun-addresses), but
55
+
this can be disabled or changed for [offline deployments](./install/offline.md).
56
+
53
57
### Relayed connections
54
58
55
-
Tailscale has graciously allowed us to use
56
-
[their global DERP relays](https://tailscale.com/kb/1118/custom-derp-servers/#what-are-derp-servers).
59
+
By default, your Coder server also runs a built-in DERP relay which can be used for both public and [offline deployments](./install/offline.md).
57
60
58
-
You can launch `coder server` with Tailscale's DERPs like so:
61
+
However, Tailscale has graciously allowed us to use
62
+
[their global DERP relays](https://tailscale.com/kb/1118/custom-derp-servers/#what-are-derp-servers). You can launch `coder server` with Tailscale's DERPs like so:
59
63
60
64
```bash
61
65
$ coder server --derp-config-url https://controlplane.tailscale.com/derpmap/default
62
66
```
63
67
64
68
#### Custom Relays
65
69
66
-
If you run Coder in air-gap mode or want lower latency than what Tailscale offers,
If you want lower latency than what Tailscale offers or want additional DERP relays for offline deployments, you may run custom DERP servers. Refer to [Tailscale's documentation](https://tailscale.com/kb/1118/custom-derp-servers/#why-run-your-own-derp-server)
69
71
to learn how to set them up.
70
72
71
73
After you have custom DERP servers, you can launch Coder with them like so:
0 commit comments