selfhosted
/
coder
mirror of https://github.com/coder/coder.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

docs: make template git auth example in sync with git auth setup example (#7784)

This commit is contained in:
sharkymark 2023-06-01 14:34:52 -05:00 committed by GitHub
parent 4acf36b84a
commit 49ae49095c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 52 additions and 50 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

102
docs/templates/open-in-coder.md vendored
View File

@ -15,68 +15,70 @@ To support any infrastructure and software stack, Coder provides a generic appro
1. Modify your template to auto-clone repos:
- If you want the template to clone a specific git repo
> The id in the template's `coder_git_auth` data source must match the `CODER_GITAUTH_0_ID` in the Coder deployment configuration.
```hcl
# Require git authentication to use this template
data "coder_git_auth" "github" {
id = "github"
}
- If you want the template to clone a specific git repo
resource "coder_agent" "dev" {
# ...
dir = "~/coder"
startup_script =<<EOF
```hcl
# Require git authentication to use this template
data "coder_git_auth" "github" {
id = "primary-github"
}
# Clone repo from GitHub
if [ ! -d "coder" ]
then
git clone https://github.com/coder/coder
fi
resource "coder_agent" "dev" {
# ...
dir = "~/coder"
startup_script =<<EOF
EOF
}
```
# Clone repo from GitHub
if [ ! -d "coder" ]
then
git clone https://github.com/coder/coder
fi
> Note: The `dir` attribute can be set in multiple ways, for example:
>
> - `~/coder`
> - `/home/coder/coder`
> - `coder` (relative to the home directory)
EOF
}
```
- If you want the template to support any repository via [parameters](./parameters.md)
> Note: The `dir` attribute can be set in multiple ways, for example:
>
> - `~/coder`
> - `/home/coder/coder`
> - `coder` (relative to the home directory)
```hcl
# Require git authentication to use this template
data "coder_git_auth" "github" {
id = "github"
}
- If you want the template to support any repository via [parameters](./parameters.md)
# Prompt the user for the git repo URL
data "coder_parameter" "git_repo" {
name = "git_repo"
display_name = "Git repository"
default = "https://github.com/coder/coder"
}
```hcl
# Require git authentication to use this template
data "coder_git_auth" "github" {
id = "primary-github"
}
locals {
folder_name = try(element(split("/", data.coder_parameter.git_repo.value), length(split("/", data.coder_parameter.git_repo.value)) - 1), "")
}
# Prompt the user for the git repo URL
data "coder_parameter" "git_repo" {
name = "git_repo"
display_name = "Git repository"
default = "https://github.com/coder/coder"
}
resource "coder_agent" "dev" {
# ...
dir = "~/${local.folder_name}"
startup_script =<<EOF
locals {
folder_name = try(element(split("/", data.coder_parameter.git_repo.value), length(split("/", data.coder_parameter.git_repo.value)) - 1), "")
}
# Clone repo from GitHub
if [ ! -d "${local.folder_name}" ]
then
git clone ${data.coder_parameter.git_repo.value}
fi
resource "coder_agent" "dev" {
# ...
dir = "~/${local.folder_name}"
startup_script =<<EOF
EOF
}
```
# Clone repo from GitHub
if [ ! -d "${local.folder_name}" ]
then
git clone ${data.coder_parameter.git_repo.value}
fi
EOF
}
```
1. Embed the "Open in Coder" button with Markdown