From b6f7cbe008ee60e19732975244245524b8fd22b0 Mon Sep 17 00:00:00 2001 From: Katie Horne Date: Thu, 16 Jun 2022 15:18:30 -0500 Subject: [PATCH 1/2] chore: add link from install.md to Docker example README --- docs/install.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/docs/install.md b/docs/install.md index 292f3a83d0fa0..4393d86ba2400 100644 --- a/docs/install.md +++ b/docs/install.md @@ -46,13 +46,16 @@ journalctl -u coder.service -b Before proceeding, please ensure that you have both Docker and the [latest version of Coder](https://github.com/coder/coder/releases) installed. +> See our [Docker example](../examples/templates/docker/README.md) for +> additional information. + 1. Clone the `coder` repository: ```console git clone git@github.com:coder/coder.git ``` -1. Navigate into the `coder` folder. Coder requires a non-`localhost` access URL +2. Navigate into the `coder` folder. Coder requires a non-`localhost` access URL for non-Docker-based examples; if you have a public IP or a domain/reverse proxy, you can provide this value before running `docker-compose up` to start the service: @@ -79,7 +82,7 @@ Coder](https://github.com/coder/coder/releases) installed. ghcr.io/coder/coder:v0.5.10 ``` -1. Follow the on-screen instructions to create your first template and workspace +3. Follow the on-screen instructions to create your first template and workspace ## Manual From 402b3d46869878ab770c7913a02ccc2702dbaa0e Mon Sep 17 00:00:00 2001 From: Katie Horne Date: Thu, 16 Jun 2022 15:27:46 -0500 Subject: [PATCH 2/2] fix link Co-authored-by: Ben Potter --- docs/install.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/install.md b/docs/install.md index 4393d86ba2400..8d404401e20ba 100644 --- a/docs/install.md +++ b/docs/install.md @@ -46,8 +46,8 @@ journalctl -u coder.service -b Before proceeding, please ensure that you have both Docker and the [latest version of Coder](https://github.com/coder/coder/releases) installed. -> See our [Docker example](../examples/templates/docker/README.md) for -> additional information. +> See our [docker-compose](../docker-compose.yaml) file +> for additional information. 1. Clone the `coder` repository: