feat: Add tunnel by default (#4399)

* feat: Add tunnel by default

If an access URL is not specified, we will always tunnel.

This is from community-member feedback who exclaimed that
it's confusing having the default for `coder server` display
a warning message, and I agree.

There is very little (maybe none) in running `coder server`
without tunnel and without an access URL, so this seems like
overall a much better UX.

* Update install.sh

Co-authored-by: Ben Potter <ben@coder.com>

* Update docs/install/packages.md

Co-authored-by: Ben Potter <ben@coder.com>

* Fix reset pass test

* Fix e2e test

Co-authored-by: Ben Potter <ben@coder.com>
This commit is contained in:
Kyle Carberry
2022-10-07 08:05:56 -05:00
committed by GitHub
co-authored by Ben Potter
parent 3049a56355
commit 3cc77d96eb
22 changed files with 60 additions and 88 deletions
+1 -1
View File
@@ -15,7 +15,7 @@ Coder publishes self-contained .zip and .tar.gz archives in [GitHub releases](ht
```sh
# Automatically sets up an external access URL on *.try.coder.app
coder server --tunnel
coder server
# Requires a PostgreSQL instance and external access URL
coder server --postgres-url <url> --access-url <url>
+2 -5
View File
@@ -4,7 +4,7 @@ You can install and run Coder using the official Docker images published on [Git
Docker is required. See the [official installation documentation](https://docs.docker.com/install/).
## Run Coder with built-in database and tunnel (quick)
## Run Coder with the built-in database (quick)
For proof-of-concept deployments, you can run a complete Coder instance with
the following command:
@@ -14,7 +14,6 @@ export CODER_DATA=$HOME/.config/coderv2-docker
export DOCKER_GROUP=$(getent group docker | cut -d: -f3)
mkdir -p $CODER_DATA
docker run --rm -it \
-e CODER_TUNNEL=true \
-v $CODER_DATA:/home/coder/.config \
-v /var/run/docker.sock:/var/run/docker.sock \
--group-add $DOCKER_GROUP \
@@ -68,7 +67,7 @@ an PostgreSQL container and volume.
```sh
cd coder
CODER_TUNNEL=true docker-compose up
docker-compose up
```
For production deployments, we recommend setting an [access URL](../admin/configure.md#access-url):
@@ -79,8 +78,6 @@ an PostgreSQL container and volume.
CODER_ACCESS_URL=https://coder.example.com docker-compose up
```
> Without `CODER_ACCESS_URL` or `CODER_TUNNEL` set, Coder will bind to `localhost:7080`. This will only work for Docker-based templates.
4. Visit the web ui via the configured url. You can add `/login` to the base url to create the first user via the ui.
5. Follow the on-screen instructions log in and create your first template and workspace
+1 -1
View File
@@ -7,7 +7,7 @@
1. Run Coder as a system service.
```sh
# Set up an access URL or enable CODER_TUNNEL
# Optional) Set up an access URL
sudo vim /etc/coder.d/coder.env
# To systemd to start Coder now and on reboot