synced/coder
1
0
Fork 0
mirror of https://github.com/coder/coder.git synced 2025-07-08 11:39:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

chore: update quickstart (docs) (#2381)

Browse Source
This commit is contained in:
Katie Horne
2022-06-15 14:52:48 -05:00
committed by GitHub
parent 0f44048fcc
commit bb4ecd72c5
3 changed files with 29 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

BIN
docs/images/code-server.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 169 KiB

9
docs/install.md
View File

@ -4,7 +4,7 @@ This article walks you through the various ways of installing and deploying Code
## install.sh ## install.sh
The easiest way to install Coder is to use our [install script](https://github.com/coder/coder/main/install.sh) for Linux and macOS. The install script The easiest way to install Coder is to use our [install script](https://github.com/coder/coder/blob/main/install.sh) for Linux and macOS. The install script
attempts to use the system package manager detection-reference if possible. attempts to use the system package manager detection-reference if possible.
You can preview what occurs during the install process: You can preview what occurs during the install process:
@ -120,5 +120,10 @@ We publish self-contained .zip and .tar.gz archives in [GitHub releases](https:/
```bash ```bash
CODER_PG_CONNECTION_URL="postgres://<username>@<host>/<database>?password=<password>" \ CODER_PG_CONNECTION_URL="postgres://<username>@<host>/<database>?password=<password>" \
coder server coder server
``` ```
## Next steps
Once you've installed and started Coder, see the [quickstart](./quickstart.md)
for instructions on creating your first template and workspace.

28
docs/quickstart.md
View File

@ -1,6 +1,10 @@
# Quickstart # Quickstart
This guide will walk you through creating your first template and workspace. If you haven't already installed `coder`, do that first [here](./install.md). This guide will walk you through creating your first template and workspace.
## Prerequisites
Please [install Coder](./install.md) before proceeding with the steps outlined in this article.
## Creating your first template and workspace ## Creating your first template and workspace
@ -10,8 +14,13 @@ In a new terminal window, run the following to copy a sample template:
coder templates init coder templates init
``` ```
Follow the CLI instructions to modify and create the template specific for your Follow the CLI instructions to select an example that you can modify for your
usage (e.g., a template to **Develop in Linux on Google Cloud**). specific usage (e.g., a template to **Develop code-server in Docker**):
1. Navigate into your new templates folder and create your first template using
the provided command (e.g., `cd ./docker-code-server && coder templates create`)
1. Answer the CLI prompts; when done, confirm that you want to create your template.
Create a workspace using your template: Create a workspace using your template:
@ -25,13 +34,20 @@ Connect to your workspace via SSH:
coder ssh <workspaceName> coder ssh <workspaceName>
``` ```
You can also access your workspace using the **access URL** you provided when
deploying Coder (if you're using a temporary deployment and you opted to use
Coder's tunnel, use the access URL you were provided). Log in with the admin
credentials provided to you by Coder.
![Coder Web UI with code-server](images/code-server.png)
## Modifying templates ## Modifying templates
If needed, you can edit the Terraform template using a sample template: You can edit the Terraform template as follows:
```sh ```sh
coder templates init coder templates init
cd gcp-linux/ cd gcp-linux # modify this line as needed to access the template
vim main.tf vim main.tf
coder templates update gcp-linux coder templates update gcp-linux # updates the template
``` ```