docs: make it clear the CLI must be downloaded to use templates (#5373)

This commit is contained in:
sharkymark
2022-12-13 19:31:09 +00:00
committed by GitHub
parent 4fc4c01cea
commit 8df02f42c0
24 changed files with 198 additions and 146 deletions
+1 -1
View File
@@ -8,7 +8,7 @@ List template examples in our CLI with `coder templates init`.
Clone this repository to create a project from any example listed here:
```sh
```console
git clone https://github.com/coder/coder
cd examples/templates/aws-macos
coder templates create
@@ -20,7 +20,7 @@ on-screen instructions to proceed.
Create a Dockerfile (e.g `images/golang.Dockerfile`):
```sh
```console
vim images/golang.Dockerfile
```
@@ -48,7 +48,7 @@ USER coder
Edit the Terraform template (`main.tf`):
```sh
```console
vim main.tf
```
@@ -88,7 +88,7 @@ resource "docker_image" "coder_image" {
Update the template:
```sh
```console
coder template push docker-image-builds
```
@@ -99,7 +99,7 @@ the removed image until you update the workspace to the latest version.
Edit the Dockerfile (or related assets):
```sh
```console
vim images/node.Dockerfile
```
@@ -113,7 +113,7 @@ RUN DEBIAN_FRONTEND="noninteractive" apt-get update -y && \
1. Edit the Terraform template (`main.tf`)
```sh
```console
vim main.tf
```
@@ -136,13 +136,13 @@ resource "docker_image" "coder_image" {
Update the template:
```sh
```console
coder template push docker-image-builds
```
Optional: Update workspaces to the latest template version
```sh
```console
coder ls
coder update [workspace name]
```
+5 -5
View File
@@ -10,7 +10,7 @@ This is an example configuration of how to use Coder with [caddy](https://caddys
1. Start with our example configuration
```sh
```console
# Create a project folder
cd $HOME
mkdir coder-with-caddy
@@ -30,7 +30,7 @@ This is an example configuration of how to use Coder with [caddy](https://caddys
1. Start Coder. Set `CODER_ACCESS_URL` and `CODER_WILDCARD_ACCESS_URL` to the domain you're using in your Caddyfile.
```sh
```console
export CODER_ACCESS_URL=https://coder.example.com
export CODER_WILDCARD_ACCESS_URL=*.coder.example.com
docker compose up -d # Run on startup
@@ -60,19 +60,19 @@ This is an example configuration of how to use Coder with [caddy](https://caddys
If you're [keeping Caddy running](https://caddyserver.com/docs/running) via a system service:
```sh
```console
sudo systemctl restart caddy
```
Or run a standalone server:
```sh
```console
caddy run
```
1. Optionally, use [ufw](https://wiki.ubuntu.com/UncomplicatedFirewall) or another firewall to disable external traffic outside of Caddy.
```sh
```console
# Check status of UncomplicatedFirewall
sudo ufw status