-
Notifications
You must be signed in to change notification settings - Fork 45
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.
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
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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`. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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: | ||
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.