Skip to content

chore(README.md): add notes regarding Coder integration #341

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 2 commits into from
Sep 10, 2024
Merged

chore(README.md): add notes regarding Coder integration #341

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ff8b637
chore(README.md): add notes regarding Coder integration
johnstcn Sep 10, 2024
1713fc1
Apply suggestions from code review
johnstcn Sep 10, 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
21 changes: 21 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,27 @@ Exit the container, and re-run the `docker run` command... after the build compl
> If you need to bypass this behavior for any reason, you can bypass this safety check by setting
> `ENVBUILDER_FORCE_SAFE=true`.

## Usage with Coder

Coder provides sample
[Docker](https://github.com/coder/coder/tree/main/examples/templates/devcontainer-docker)
and
[Kubernetes](https://github.com/coder/coder/tree/main/examples/templates/devcontainer-kubernetes)
for use with Envbuilder. You can import these template and modify them to fit
your specific requirements.

Below are some specific points to be aware of when using Envbuilder with a Coder
deployment:

- The `ENVBUILDER_INIT_SCRIPT` should execute `coder_agent.main.init_script` in
order for you to be able to connect to your workspace.
- In order for the Agent init script to be able to fetch the agent binary from
your Coder deployment, the resulting Devcontainer must contain a download tool
such as `curl`, `wget`, or `busybox`.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Side-note: We should allow envbuilder to be this tool 💡

- `CODER_AGENT_TOKEN` should be included in the environment variables for the
Envbuilder container. You can also set `CODER_AGENT_URL` if required.


### Git Branch Selection

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