mirror of
https://github.com/coder/coder.git
synced 2026-09-24 15:04:27 +08:00
fix: prettier misses docs directory (#5285)
* chore: keep admin/prometheus.md if make target fails * Address PR comments * Formatted * fix: prettier misses docs * make fmt * More md files
This commit is contained in:
Marcin Tojek
+35
-36
@@ -15,58 +15,57 @@ Coder with Docker has the following advantages:
|
||||
|
||||
1. Run Coder with Docker.
|
||||
|
||||
```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.
|
||||
```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.
|
||||
|
||||
1. In new terminal, [install Coder](../install/) in order to connect to your deployment through the CLI.
|
||||
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
|
||||
```
|
||||
```shell
|
||||
curl -L https://coder.com/install.sh | sh
|
||||
```
|
||||
|
||||
1. Run `coder login <access url>` and follow the
|
||||
interactive instructions to create your user.
|
||||
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`:
|
||||
1. Pull the "Docker" example template using the interactive `coder templates init`:
|
||||
|
||||
```shell
|
||||
coder templates init
|
||||
cd docker
|
||||
```
|
||||
```shell
|
||||
coder templates init
|
||||
cd docker
|
||||
```
|
||||
|
||||
1. Push up the template with `coder templates create`
|
||||
1. Push up the template with `coder templates create`
|
||||
|
||||
1. Open the dashboard in your browser to create your
|
||||
first workspace:
|
||||
1. Open the dashboard in your browser to create your
|
||||
first workspace:
|
||||
|
||||
<img src="../images/quickstart/docker/login.png">
|
||||
<img src="../images/quickstart/docker/login.png">
|
||||
|
||||
Then navigate to `Templates > docker > Create workspace`
|
||||
Then navigate to `Templates > docker > Create workspace`
|
||||
|
||||
<img src="../images/quickstart/docker/create-workspace.png">
|
||||
<img src="../images/quickstart/docker/create-workspace.png">
|
||||
|
||||
Now wait a few moments for the workspace to build... After the first build,
|
||||
the image is cached and subsequent builds will take a few seconds.
|
||||
Now wait a few moments for the workspace to build... After the first build,
|
||||
the image is cached and subsequent builds will take a few seconds.
|
||||
|
||||
1. Your workspace is ready to go!
|
||||
1. Your workspace is ready to go!
|
||||
|
||||
<img src="../images/quickstart/docker/ides.png">
|
||||
<img src="../images/quickstart/docker/ides.png">
|
||||
|
||||
Open up a web application or [SSH in](../ides.md#ssh-configuration).
|
||||
Open up a web application or [SSH in](../ides.md#ssh-configuration).
|
||||
|
||||
1. If you want to modify the Docker image or template, edit the files in the
|
||||
previously created `./docker` directory, then run `coder templates push`.
|
||||
1. If you want to modify the Docker image or template, edit the files in the
|
||||
previously created `./docker` directory, then run `coder templates push`.
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
|
||||
@@ -1,12 +1,12 @@
|
||||
# Google Cloud Platform
|
||||
|
||||
In this quickstart, you will learn how to deploy the Coder control plane instance and your first template.
|
||||
In this quickstart, you will learn how to deploy the Coder control plane instance and your first template.
|
||||
|
||||
## Requirements
|
||||
|
||||
This quickstart assumes you have `roles/compute.instanceAdmin.v1` access to your Google Cloud Platform project.
|
||||
This quickstart assumes you have `roles/compute.instanceAdmin.v1` access to your Google Cloud Platform project.
|
||||
|
||||
## Setting Up your VM
|
||||
## Setting Up your VM
|
||||
|
||||
If this is the first time you’re creating a VM on this project, you will need to enable the `Compute Engine API`. On the Compute Engine API page, click `enable` and wait for the service to finish connecting.
|
||||
|
||||
@@ -34,10 +34,10 @@ This will give you a terminal into the VM that we will use to install Coder.
|
||||
|
||||
## Install Coder
|
||||
|
||||
In the terminal, run the following command
|
||||
In the terminal, run the following command
|
||||
|
||||
```sh
|
||||
curl -fsSL https://coder.com/install.sh | sh
|
||||
curl -fsSL https://coder.com/install.sh | sh
|
||||
```
|
||||
|
||||
## Run Coder
|
||||
@@ -46,9 +46,9 @@ For this tutorial, we will run Coder as a `systemd` service. You can run Coder i
|
||||
|
||||
First, edit the `coder.env` file to enable `CODER_TUNNEL` by setting the value to true with the following command:
|
||||
|
||||
``` sh
|
||||
```sh
|
||||
sudo vim /etc/coder.d/coder.env
|
||||
```
|
||||
```
|
||||
|
||||
<img src="../images/quickstart/google-cloud-platform/gcp4.png">
|
||||
|
||||
@@ -56,17 +56,17 @@ Exit vim and run the following command to start Coder as a system service:
|
||||
|
||||
```sh
|
||||
sudo systemctl enable --now coder
|
||||
```
|
||||
```
|
||||
|
||||
The following command shows the Coder service's logs, including the Access URL. The Access URL will be used to access the Coder control plane.
|
||||
The following command shows the Coder service's logs, including the Access URL. The Access URL will be used to access the Coder control plane.
|
||||
|
||||
```sh
|
||||
journalctl -u coder.service -b
|
||||
```
|
||||
journalctl -u coder.service -b
|
||||
```
|
||||
|
||||
<img src="../images/quickstart/google-cloud-platform/gcp5.png">
|
||||
|
||||
In this instance, Coder can be accessed at the URL `https://fcca2f3bfc9d2e3bf1b9feb50e723448.pit-1.try.coder.app`.
|
||||
In this instance, Coder can be accessed at the URL `https://fcca2f3bfc9d2e3bf1b9feb50e723448.pit-1.try.coder.app`.
|
||||
|
||||
Copy the URL and run the following command to create the workspace admin:
|
||||
|
||||
@@ -74,37 +74,37 @@ Copy the URL and run the following command to create the workspace admin:
|
||||
coder login <url***.try.coder.app>
|
||||
```
|
||||
|
||||
Fill out the prompts and be sure to save use email and password. This is your admin login. Now, you can now access Coder from your local machine by navigating to the `***.try.coder.app` URL and logging in with that same username and password.
|
||||
Fill out the prompts and be sure to save use email and password. This is your admin login. Now, you can now access Coder from your local machine by navigating to the `***.try.coder.app` URL and logging in with that same username and password.
|
||||
|
||||
## Creating and Uploading your First Template
|
||||
|
||||
First, run `coder template init` to create your first template. You’ll be given a list of prefabricated templates. This tutorial shows you how to create a Linux based template on GCP.
|
||||
First, run `coder template init` to create your first template. You’ll be given a list of prefabricated templates. This tutorial shows you how to create a Linux based template on GCP.
|
||||
|
||||
<img src="../images/quickstart/google-cloud-platform/gcp6.png">
|
||||
|
||||
Select the `Develop in Linux on Google Cloud`, then `cd ./gcp-linux`.
|
||||
Select the `Develop in Linux on Google Cloud`, then `cd ./gcp-linux`.
|
||||
|
||||
Run the following command:
|
||||
Run the following command:
|
||||
|
||||
```sh
|
||||
coder templates create
|
||||
```
|
||||
|
||||
It will ask for your `project-id`, which you can find on the home page of your GCP Dashboard.
|
||||
It will ask for your `project-id`, which you can find on the home page of your GCP Dashboard.
|
||||
|
||||
Given it’s your first time setting up Coder, it may give an error that will look like the following:
|
||||
|
||||
<img src="../images/quickstart/google-cloud-platform/gcp7.png">
|
||||
|
||||
In the error message will be a link. In this case, the URL is `https://console.developes.google.com/apis/api/iam.googles.com/overview:?project=1073148106645`. Copy the respective URL from your error message, and visit it via your browser. It may ask you to enable `Identity and Access Management (IAM) API`.
|
||||
In the error message will be a link. In this case, the URL is `https://console.developes.google.com/apis/api/iam.googles.com/overview:?project=1073148106645`. Copy the respective URL from your error message, and visit it via your browser. It may ask you to enable `Identity and Access Management (IAM) API`.
|
||||
|
||||
Click `enable` and wait as the API initializes for your account.
|
||||
Click `enable` and wait as the API initializes for your account.
|
||||
|
||||
Once initialized, click create credentials in the upper right-hand corner. Select the `Compute Engine API` from the dropdown, and select `Application Data` under `What data will you be accessing?`. In addition, select `Yes, I’m using one or more` under `Are you planning on using this API with Compute Engine, Kubernetes Engine, App Engine, or Cloud Functions?`.
|
||||
|
||||
<img src="../images/quickstart/google-cloud-platform/gcp8.png">
|
||||
|
||||
Back in your GCP terminal, run the `coder templates create` one more time.
|
||||
Back in your GCP terminal, run the `coder templates create` one more time.
|
||||
|
||||
Congrats! You can now create new Linux-based workspaces that use Google Cloud Platform. Go onto your Coder dashboard, build your workspace, and get started coding!
|
||||
|
||||
|
||||
Reference in New Issue
Block a user