diff --git a/docs/images/code-server.png b/docs/images/code-server.png new file mode 100644 index 0000000000000..1190258e0d89f Binary files /dev/null and b/docs/images/code-server.png differ diff --git a/docs/install.md b/docs/install.md index e57a3fac6ca3b..4f5c2d83b7c40 100644 --- a/docs/install.md +++ b/docs/install.md @@ -4,7 +4,7 @@ This article walks you through the various ways of installing and deploying Code ## 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. 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 CODER_PG_CONNECTION_URL="postgres://@/?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. diff --git a/docs/quickstart.md b/docs/quickstart.md index 0b069f4319a4f..06b3f0141e259 100644 --- a/docs/quickstart.md +++ b/docs/quickstart.md @@ -1,6 +1,10 @@ # 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 @@ -10,8 +14,13 @@ In a new terminal window, run the following to copy a sample template: coder templates init ``` -Follow the CLI instructions to modify and create the template specific for your -usage (e.g., a template to **Develop in Linux on Google Cloud**). +Follow the CLI instructions to select an example that you can modify for your +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: @@ -25,13 +34,20 @@ Connect to your workspace via SSH: coder ssh ``` +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 -If needed, you can edit the Terraform template using a sample template: +You can edit the Terraform template as follows: ```sh coder templates init -cd gcp-linux/ +cd gcp-linux # modify this line as needed to access the template vim main.tf -coder templates update gcp-linux +coder templates update gcp-linux # updates the template ``` pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.

Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy