Skip to content

Commit 7fe1900

Browse files
johnstcnmafredri
andauthored
chore(README.md): add notes regarding Coder integration (#341)
Co-authored-by: Mathias Fredriksson <[email protected]>
1 parent b7781d8 commit 7fe1900

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

README.md

+21
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,27 @@ Exit the container, and re-run the `docker run` command... after the build compl
5353
> If you need to bypass this behavior for any reason, you can bypass this safety check by setting
5454
> `ENVBUILDER_FORCE_SAFE=true`.
5555
56+
## Usage with Coder
57+
58+
Coder provides sample
59+
[Docker](https://github.com/coder/coder/tree/main/examples/templates/devcontainer-docker)
60+
and
61+
[Kubernetes](https://github.com/coder/coder/tree/main/examples/templates/devcontainer-kubernetes)
62+
templates for use with Envbuilder. You can import these templates and modify them to fit
63+
your specific requirements.
64+
65+
Below are some specific points to be aware of when using Envbuilder with a Coder
66+
deployment:
67+
68+
- The `ENVBUILDER_INIT_SCRIPT` should execute `coder_agent.main.init_script` in
69+
order for you to be able to connect to your workspace.
70+
- In order for the Agent init script to be able to fetch the agent binary from
71+
your Coder deployment, the resulting Devcontainer must contain a download tool
72+
such as `curl`, `wget`, or `busybox`.
73+
- `CODER_AGENT_TOKEN` should be included in the environment variables for the
74+
Envbuilder container. You can also set `CODER_AGENT_URL` if required.
75+
76+
5677
### Git Branch Selection
5778

5879
Choose a branch using `ENVBUILDER_GIT_URL` with a _ref/heads_ reference. For instance:

0 commit comments

Comments
 (0)