mirror of https://github.com/coder/coder.git
docs: consolidate docker quickstarts (#4882)
This commit is contained in:
Ben Potter
GitHub
parent
04ae4c036b
commit
75da08740c
|
|
@ -76,19 +76,19 @@
|
|||
},
|
||||
{
|
||||
"title": "Google Cloud Platform",
|
||||
"description": "Setup Coder with Google Cloud Platform",
|
||||
"description": "Setup Coder on a GCP Compute Engine VM",
|
||||
"icon_path": "./images/google-cloud.svg",
|
||||
"path": "./quickstart/google-cloud-platform.md"
|
||||
},
|
||||
{
|
||||
"title": "AWS",
|
||||
"description": "Setup Coder with AWS",
|
||||
"description": "Setup Coder on an AWS EC2 VM",
|
||||
"icon_path": "./images/aws.svg",
|
||||
"path": "./quickstart/aws.md"
|
||||
},
|
||||
{
|
||||
"title": "Azure",
|
||||
"description": "Setup Coder with Azure",
|
||||
"description": "Setup Coder on an Azure VM",
|
||||
"icon_path": "./images/azure.svg",
|
||||
"path": "./quickstart/azure.md"
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,68 +1,9 @@
|
|||
# Quickstart
|
||||
|
||||
See our [Docker quickstart](./quickstart/docker.md) for the easiest
|
||||
possible way to use Coder.
|
||||
Quickstarts are the fastest way to try Coder. We'll walk you through installation and adding your first template and workspace.
|
||||
|
||||
## Generic Quickstart
|
||||
First, pick a platform:
|
||||
|
||||
Please [install Coder](./install/index.md) before proceeding with the steps below.
|
||||
|
||||
## First time owner user setup
|
||||
|
||||
1. Run `coder login <your Access URL>` in a new terminal and follow the
|
||||
interactive instructions to create your owner user and password.
|
||||
|
||||
## 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](./admin/configure.md#access-url),
|
||||
and log in with the owner 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 push gcp-linux # updates the template
|
||||
```
|
||||
|
||||
## Up Next
|
||||
|
||||
Learn about [templates](./templates.md).
|
||||
<children>
|
||||
This page is rendered on https://coder.com/docs/coder-oss/latest/quickstart. Refer to the other documents in the `install/` directory for per-platform instructions.
|
||||
</children>
|
||||
|
|
|
|||
|
|
@ -13,34 +13,41 @@ Coder with Docker has the following advantages:
|
|||
|
||||
## Instructions
|
||||
|
||||
1. [Install and launch Coder](../install)
|
||||
1. Run Coder with Docker.
|
||||
|
||||
The Coder server binds to port 3000 by default. Use `--address :<port>` to customize it!
|
||||
```shell
|
||||
export CODER_DATA=$HOME/.config/coderv2-docker
|
||||
export DOCKER_GROUP=$(getent group docker | cut -d: -f3)
|
||||
mkdir -p $CODER_DATA
|
||||
docker run --rm -it \
|
||||
-v $CODER_DATA:/home/coder/.config \
|
||||
-v /var/run/docker.sock:/var/run/docker.sock \
|
||||
--group-add $DOCKER_GROUP \
|
||||
ghcr.io/coder/coder:latest
|
||||
```
|
||||
|
||||
> This will use Coder's tunnel and built-in database. See our [Docker documentation](../install/docker.md) for other configuration options such as running on localhost, using docker-compose, and external PostgreSQL.
|
||||
|
||||
Use the [Coder tunnel](../admin/configure.md#tunnel) for a public URL:
|
||||
|
||||
```bash
|
||||
coder server
|
||||
1. In new terminal, [install Coder](../install/) in order to connect to your deployment through the CLI.
|
||||
|
||||
```shell
|
||||
curl -L https://coder.com/install.sh | sh
|
||||
```
|
||||
|
||||
Or set an [access URL](../admin/configure.md#access-url) to run entirely locally:
|
||||
|
||||
```bash
|
||||
coder server --access-url=http://localhost:3000 --address=:3000
|
||||
```
|
||||
|
||||
1. Run `coder login <access url>` in a new terminal and follow the
|
||||
1. Run `coder login <access url>` and follow the
|
||||
interactive instructions to create your user.
|
||||
|
||||
1. Pull the "Docker" example template using the interactive `coder templates init`:
|
||||
|
||||
```bash
|
||||
```shell
|
||||
coder templates init
|
||||
cd docker
|
||||
```
|
||||
|
||||
1. Push up the template with `coder templates create`
|
||||
1. Open the dashboard in your browser (http://localhost:3000) to create your
|
||||
|
||||
1. Open the dashboard in your browser to create your
|
||||
first workspace:
|
||||
|
||||
<img src="../images/quickstart/docker/login.png">
|
||||
|
|
|
|||
Loading…
Reference in New Issue