mirror of
https://github.com/coder/coder.git
synced 2026-09-22 05:05:20 +08:00
docs: outdent generic quickstart (#3467)
This commit is contained in:
Ammar Bandukwala
@@ -7,29 +7,28 @@ Once you've [installed](../install.md) Coder, you can configure the server by se
|
||||
variables in `/etc/coder.d/coder.env`:
|
||||
|
||||
```sh
|
||||
# String. Specifies the external URL (HTTP/S) to access Coder. Consumes $CODER_ACCESS_URL
|
||||
# String. Specifies the external URL (HTTP/S) to access Coder.
|
||||
CODER_ACCESS_URL=https://coder.example.com
|
||||
|
||||
# String. Address to serve the API and dashboard. Consumes $CODER_ADDRESS (default "127.0.0.1:3000")
|
||||
# String. Address to serve the API and dashboard.
|
||||
CODER_ADDRESS=127.0.0.1:3000
|
||||
|
||||
# String. The URL of a PostgreSQL database to connect to. If empty, PostgreSQL binaries
|
||||
# will be downloaded from Maven (https://repo1.maven.org/maven2) and store all
|
||||
# data in the config root. Access the built-in database with "coder server postgres-builtin-url".
|
||||
# Consumes $CODER_PG_CONNECTION_URL.
|
||||
CODER_PG_CONNECTION_URL=""
|
||||
CODER_PG_CONNECTION_URL=
|
||||
|
||||
# Boolean. Specifies if TLS will be enabled. Consumes $CODER_TLS_ENABLE.
|
||||
# Boolean. Specifies if TLS will be enabled.
|
||||
CODER_TLS_ENABLE=
|
||||
|
||||
# Specifies the path to the certificate for TLS. It requires a PEM-encoded file.
|
||||
# String. Specifies the path to the certificate for TLS. It requires a PEM-encoded file.
|
||||
# To configure the listener to use a CA certificate, concatenate the primary
|
||||
# certificate and the CA certificate together. The primary certificate should
|
||||
# appear first in the combined file. Consumes $CODER_TLS_CERT_FILE.
|
||||
# appear first in the combined file.
|
||||
CODER_TLS_CERT_FILE=
|
||||
|
||||
# Specifies the path to the private key for the certificate. It requires a
|
||||
# PEM-encoded file. Consumes $CODER_TLS_KEY_FILE.
|
||||
# String. Specifies the path to the private key for the certificate. It requires a
|
||||
# PEM-encoded file.
|
||||
CODER_TLS_KEY_FILE=
|
||||
```
|
||||
|
||||
@@ -46,5 +45,5 @@ journalctl -u coder.service -b
|
||||
|
||||
## Up Next
|
||||
|
||||
- [Get started using Coder](./quickstart.md).
|
||||
- [Get started using Coder](../quickstart.md).
|
||||
- [Learn how to upgrade Coder](./upgrade.md).
|
||||
|
||||
@@ -2,9 +2,6 @@
|
||||
|
||||
This article walks you through how to upgrade your Coder server.
|
||||
|
||||
To upgrade your Coder server, simply reinstall Coder using your original method
|
||||
of [install](../install.md).
|
||||
|
||||
<blockquote class="danger">
|
||||
<p>
|
||||
Prior to upgrading a production Coder deployment, take a database snapshot since
|
||||
@@ -12,9 +9,12 @@ of [install](../install.md).
|
||||
</p>
|
||||
</blockquote>
|
||||
|
||||
To upgrade your Coder server, simply reinstall Coder using your original method
|
||||
of [install](../install.md).
|
||||
|
||||
## Via install.sh
|
||||
|
||||
If you installed Coder using the `install.sh` script, simply re-run the below
|
||||
If you installed Coder using the `install.sh` script, re-run the below
|
||||
command on the host:
|
||||
|
||||
```console
|
||||
@@ -37,3 +37,7 @@ Coder container:
|
||||
```console
|
||||
docker-compose pull coder && docker-compose up coder -d
|
||||
```
|
||||
|
||||
## Up Next
|
||||
|
||||
- [Learn how to configure Coder](./configure.md).
|
||||
|
||||
+1
-7
@@ -36,7 +36,7 @@
|
||||
"path": "./install/configure.md"
|
||||
},
|
||||
{
|
||||
"title": "Upgrade",
|
||||
"title": "Upgrading",
|
||||
"description": "Learn how to upgrade Coder.",
|
||||
"path": "./install/upgrade.md"
|
||||
}
|
||||
@@ -53,12 +53,6 @@
|
||||
"description": "Setup Coder with Docker",
|
||||
"icon_path": "./images/icons/docker.svg",
|
||||
"path": "./quickstart/docker.md"
|
||||
},
|
||||
{
|
||||
"title": "Generic",
|
||||
"description": "Setup Coder on anything",
|
||||
"icon_path": "./images/icons/generic.svg",
|
||||
"path": "./quickstart/generic.md"
|
||||
}
|
||||
]
|
||||
},
|
||||
|
||||
+65
-1
@@ -3,4 +3,68 @@
|
||||
See our [Docker quickstart](./quickstart/docker.md) for the easiest
|
||||
possible way to use Coder.
|
||||
|
||||
Otherwise, you can check out the [generic quickstart](./quickstart/generic.md).
|
||||
## Generic Quickstart
|
||||
|
||||
Please [install Coder](../install.md) before proceeding with the steps below.
|
||||
|
||||
## First time admin user setup
|
||||
|
||||
1. Run `coder login <your Access URL>` in a new terminal and follow the
|
||||
interactive instructions to create your admin user and password.
|
||||
|
||||
> If using `coder server --tunnel`, the Access URL appears in the terminal logs.
|
||||
|
||||
## Templates
|
||||
|
||||
To get started using templates, run the following command to generate a sample template:
|
||||
|
||||
```bash
|
||||
coder templates init
|
||||
```
|
||||
|
||||
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
|
||||
|
||||
Now, create a workspace using your template:
|
||||
|
||||
```bash
|
||||
coder create --template="yourTemplate" <workspaceName>
|
||||
```
|
||||
|
||||
Connect to your workspace via SSH:
|
||||
|
||||
```bash
|
||||
coder ssh <workspaceName>
|
||||
```
|
||||
|
||||
To access your workspace in the Coder dashboard, navigate to the [configured access URL](../configure.md),
|
||||
and log in with the admin credentials provided to you by Coder.
|
||||
|
||||
|
||||
|
||||
You can also create workspaces using the access URL and the Templates UI.
|
||||
|
||||
|
||||
|
||||
## Modifying templates
|
||||
|
||||
You can edit the Terraform template as follows:
|
||||
|
||||
```sh
|
||||
coder templates init
|
||||
cd gcp-linux # modify this line as needed to access the template
|
||||
vim main.tf
|
||||
coder templates update gcp-linux # updates the template
|
||||
```
|
||||
|
||||
## Up Next
|
||||
|
||||
Learn about [templates](../templates.md).
|
||||
|
||||
@@ -1,70 +0,0 @@
|
||||
# Getting Started
|
||||
|
||||
This article will walk you through how to set up your first Coder user, and begin
|
||||
using the templates to create and access your development workspaces.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
Please [install Coder](../install.md) before proceeding with the steps below.
|
||||
|
||||
## First time admin user setup
|
||||
|
||||
1. Run `coder login <your Access URL>` in a new terminal and follow the
|
||||
interactive instructions to create your admin user and password.
|
||||
|
||||
> If using `coder server --tunnel`, the Access URL appears in the terminal logs.
|
||||
|
||||
## Templates
|
||||
|
||||
To get started using templates, run the following command to generate a sample template:
|
||||
|
||||
```bash
|
||||
coder templates init
|
||||
```
|
||||
|
||||
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
|
||||
|
||||
Now, create a workspace using your template:
|
||||
|
||||
```bash
|
||||
coder create --template="yourTemplate" <workspaceName>
|
||||
```
|
||||
|
||||
Connect to your workspace via SSH:
|
||||
|
||||
```bash
|
||||
coder ssh <workspaceName>
|
||||
```
|
||||
|
||||
To access your workspace in the Coder dashboard, navigate to the [configured access URL](../configure.md),
|
||||
and log in with the admin credentials provided to you by Coder.
|
||||
|
||||
|
||||
|
||||
You can also create workspaces using the access URL and the Templates UI.
|
||||
|
||||
|
||||
|
||||
## Modifying templates
|
||||
|
||||
You can edit the Terraform template as follows:
|
||||
|
||||
```sh
|
||||
coder templates init
|
||||
cd gcp-linux # modify this line as needed to access the template
|
||||
vim main.tf
|
||||
coder templates update gcp-linux # updates the template
|
||||
```
|
||||
|
||||
## Up Next
|
||||
|
||||
Learn about [templates](../templates.md).
|
||||
Reference in New Issue
Block a user