Skip to content

docs: simplify docker installation docs #12187

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 5 commits into from
Feb 16, 2024
Merged

docs: simplify docker installation docs #12187

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
b8cce1e
docs: simplify docker installation docs
matifali Feb 16, 2024
c547f65
`make fmt`
matifali Feb 16, 2024
984af2c
typos
matifali Feb 16, 2024
041928c
fix tabs
matifali Feb 16, 2024
1eeb5eb
refactor
matifali Feb 16, 2024
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
refactor
  • Loading branch information
@matifali
matifali committed Feb 16, 2024
commit 1eeb5eb0fa89b0dc0e7d19165716a1884d196a39
22 changes: 13 additions & 9 deletions docs/install/docker.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,9 +45,6 @@ docker run --rm -it \
ghcr.io/coder/coder:latest
```

Coder configuration is defined via environment variables. Learn more about
Coder's [configuration options](../admin/configure.md).

## docker compose

Coder's publishes a
Expand Down Expand Up @@ -75,14 +72,21 @@ which includes an PostgreSQL container and volume.
6. Follow the on-screen instructions log in and create your first template and
workspace

> **Note:** In order to use cloud-based templates (e.g. Kubernetes, AWS), you
> must have an external URL that users and workspaces will use to connect to
> Coder. For proof-of-concept deployments, you can use
> [Coder's tunnel](../admin/configure.md#tunnel): For production deployments,
> we recommend setting an [access URL](../admin/configure.md#access-url):

</div>

Coder configuration is defined via environment variables. Learn more about
Coder's [configuration options](../admin/configure.md).

> **Note:** In order to use cloud-based templates (e.g. Kubernetes, AWS), you
> must have an external URL that users and workspaces will use to connect to
> Coder.
>
> > For proof-of-concept deployments, you can use
> > [Coder's tunnel](../admin/configure.md#tunnel).
> >
> > For production deployments, we recommend setting an
> > [access URL](../admin/configure.md#access-url)

> **Note:** Coder runs as a non-root user, we use `--group-add` to ensure Coder
> has permissions to manage Docker via `docker.sock`. If the host systems
> `/var/run/docker.sock` is not group writeable or does not belong to the
Expand Down