chore: add Disclaimer for docker-based templates (#324)
This commit is contained in:
parent
d9b223ac3c
commit
40863c0aa7
@ -8,6 +8,10 @@ tags: [docker, container, dockerfile]
|
|||||||
|
|
||||||
# Remote Development on Docker Containers (Build from Dockerfile)
|
# Remote Development on Docker Containers (Build from Dockerfile)
|
||||||
|
|
||||||
|
> [!NOTE]
|
||||||
|
> This template is designed to be a starting point for testing purposes.
|
||||||
|
> In a production environment, you would want to move away from storing the Dockerfile in-template and move towards using a centralized image registry.
|
||||||
|
|
||||||
Build and provision Docker containers from a Dockerfile as [Coder workspaces](https://coder.com/docs/workspaces) with this example template.
|
Build and provision Docker containers from a Dockerfile as [Coder workspaces](https://coder.com/docs/workspaces) with this example template.
|
||||||
|
|
||||||
This template builds a custom Docker image from the included Dockerfile, allowing you to customize the development environment by modifying the Dockerfile rather than using a pre-built image.
|
This template builds a custom Docker image from the included Dockerfile, allowing you to customize the development environment by modifying the Dockerfile rather than using a pre-built image.
|
||||||
@ -18,7 +22,22 @@ This template builds a custom Docker image from the included Dockerfile, allowin
|
|||||||
|
|
||||||
### Infrastructure
|
### Infrastructure
|
||||||
|
|
||||||
The VM you run Coder on must have a running Docker socket and the `coder` user must be added to the Docker group:
|
#### Running Coder inside Docker
|
||||||
|
|
||||||
|
If you installed Coder as a container within Docker, you will have to do the following things:
|
||||||
|
|
||||||
|
- Make the the Docker socket available to the container
|
||||||
|
- **(recommended) Mount `/var/run/docker.sock` via `--mount`/`volume`**
|
||||||
|
- _(advanced) Restrict the Docker socket via https://github.com/Tecnativa/docker-socket-proxy_
|
||||||
|
- Set `--group-add`/`group_add` to the GID of the Docker group on the **host** machine
|
||||||
|
- You can get the GID by running `getent group docker` on the **host** machine
|
||||||
|
|
||||||
|
If you are using `docker-compose`, here is an example on how to do those things (don't forget to edit `group_add`!):
|
||||||
|
https://github.com/coder/coder/blob/0bfe0d63aec83ae438bdcb77e306effd100dba3d/docker-compose.yaml#L16-L23
|
||||||
|
|
||||||
|
#### Running Coder outside of Docker
|
||||||
|
|
||||||
|
If you installed Coder as a system package, the VM you run Coder on must have a running Docker socket and the `coder` user must be added to the Docker group:
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
# Add coder user to Docker group
|
# Add coder user to Docker group
|
||||||
|
|||||||
@ -14,11 +14,26 @@ Provision Devcontainers as [Coder workspaces](https://coder.com/docs/workspaces)
|
|||||||
|
|
||||||
### Infrastructure
|
### Infrastructure
|
||||||
|
|
||||||
Coder must have access to a running Docker socket, and the `coder` user must be a member of the `docker` group:
|
#### Running Coder inside Docker
|
||||||
|
|
||||||
```shell
|
If you installed Coder as a container within Docker, you will have to do the following things:
|
||||||
|
|
||||||
|
- Make the the Docker socket available to the container
|
||||||
|
- **(recommended) Mount `/var/run/docker.sock` via `--mount`/`volume`**
|
||||||
|
- _(advanced) Restrict the Docker socket via https://github.com/Tecnativa/docker-socket-proxy_
|
||||||
|
- Set `--group-add`/`group_add` to the GID of the Docker group on the **host** machine
|
||||||
|
- You can get the GID by running `getent group docker` on the **host** machine
|
||||||
|
|
||||||
|
If you are using `docker-compose`, here is an example on how to do those things (don't forget to edit `group_add`!):
|
||||||
|
https://github.com/coder/coder/blob/0bfe0d63aec83ae438bdcb77e306effd100dba3d/docker-compose.yaml#L16-L23
|
||||||
|
|
||||||
|
#### Running Coder outside of Docker
|
||||||
|
|
||||||
|
If you installed Coder as a system package, the VM you run Coder on must have a running Docker socket and the `coder` user must be added to the Docker group:
|
||||||
|
|
||||||
|
```sh
|
||||||
# Add coder user to Docker group
|
# Add coder user to Docker group
|
||||||
sudo usermod -aG docker coder
|
sudo adduser coder docker
|
||||||
|
|
||||||
# Restart Coder server
|
# Restart Coder server
|
||||||
sudo systemctl restart coder
|
sudo systemctl restart coder
|
||||||
|
|||||||
@ -16,7 +16,22 @@ Provision Docker containers as [Coder workspaces](https://coder.com/docs/workspa
|
|||||||
|
|
||||||
### Infrastructure
|
### Infrastructure
|
||||||
|
|
||||||
The VM you run Coder on must have a running Docker socket and the `coder` user must be added to the Docker group:
|
#### Running Coder inside Docker
|
||||||
|
|
||||||
|
If you installed Coder as a container within Docker, you will have to do the following things:
|
||||||
|
|
||||||
|
- Make the the Docker socket available to the container
|
||||||
|
- **(recommended) Mount `/var/run/docker.sock` via `--mount`/`volume`**
|
||||||
|
- _(advanced) Restrict the Docker socket via https://github.com/Tecnativa/docker-socket-proxy_
|
||||||
|
- Set `--group-add`/`group_add` to the GID of the Docker group on the **host** machine
|
||||||
|
- You can get the GID by running `getent group docker` on the **host** machine
|
||||||
|
|
||||||
|
If you are using `docker-compose`, here is an example on how to do those things (don't forget to edit `group_add`!):
|
||||||
|
https://github.com/coder/coder/blob/0bfe0d63aec83ae438bdcb77e306effd100dba3d/docker-compose.yaml#L16-L23
|
||||||
|
|
||||||
|
#### Running Coder outside of Docker
|
||||||
|
|
||||||
|
If you installed Coder as a system package, the VM you run Coder on must have a running Docker socket and the `coder` user must be added to the Docker group:
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
# Add coder user to Docker group
|
# Add coder user to Docker group
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user