docs: Change console to shell and remove unused elements (#5960)

This commit is contained in:
Bruno Quaresma
2023-02-01 15:27:11 -03:00
committed by GitHub
parent e6f5623627
commit 61dcf643e8
32 changed files with 129 additions and 131 deletions

View File

@ -52,7 +52,7 @@ You will also need the IP address of the server. Click on the server in the `Ins
Now that weve gathered all the information you will need to SSH into your EC2 instance, on a terminal on your local system, navigate to the `.pem` file downloaded when you created the EC2 instance. Run the following command:
```console
```shell
chmod 400 [mykey].pem
```
@ -60,7 +60,7 @@ This adds the required permissions for SSH-ing into an EC2 instance.
Run the following command in terminal, where `mykey` is the security key file, `username` is the username found above for the relevant EC2 operating system image, and the `ip-address` is the IPv4 address for the server:
```console
```shell
ssh -i [mykey].pem username@ip-address
```
@ -72,7 +72,7 @@ For this instance, we will run Coder as a system service, however you can run Co
In the EC2 instance, run the following command to install Coder
```console
```shell
curl -fsSL https://coder.com/install.sh | sh
```
@ -80,13 +80,13 @@ curl -fsSL https://coder.com/install.sh | sh
Run the following command to start Coder as a system level service:
```console
```shell
sudo systemctl enable --now coder
```
The following command will get you information about the Coder launch service
```console
```shell
journalctl -u coder.service -b
```
@ -98,7 +98,7 @@ In this instance, Coder can be accessed at the url `https://fccad1b6c901511b30cf
Copy the URL and run the following command to create the first user, either on your local machine or in the AWS EC2 instance terminal.
```console
```shell
coder login <url***.try.coder.app>
```
@ -122,20 +122,20 @@ Coder runs as a system service under a system user `coder`. The `coder` user wil
Run the following command to create a folder for the AWS credentials to live in:
```console
```shell
sudo mkdir /home/coder/.aws
```
Run the following commands to copy the AWS credentials and give the `coder` user access to them:
```console
```shell
sudo cp ~/.aws/credentials /home/coder/.aws/credentials
sudo chown coder:coder /home/coder/.aws/credentials
```
Navigate to the `./aws-linux` folder where you created your template and run the following command to put the template on your Coder instance.
```console
```shell
coder templates create
```

View File

@ -43,7 +43,7 @@ For this instance, we will run Coder as a system service, however you can run Co
In the Azure VM instance, run the following command to install Coder
```console
```shell
curl -fsSL <https://coder.com/install.sh> | sh
```
@ -51,13 +51,13 @@ curl -fsSL <https://coder.com/install.sh> | sh
Run the following command to start Coder as a system level service:
```console
```shell
sudo systemctl enable --now coder
```
The following command will get you information about the Coder launch service
```console
```shell
journalctl -u coder.service -b
```
@ -65,7 +65,7 @@ This will return a series of logs related to running Coder as a system service.
Copy the URL and run the following command to create the first user, either on your local machine or in the instance terminal.
```console
```shell
coder login <url***.try.coder.app>
```
@ -89,14 +89,14 @@ Coder is running as a system service, which creates the system user `coder` for
Run the following commands to copy the Azure credentials and give the `coder` user access to them:
```console
```shell
sudo cp -r ~/.azure /home/coder/.azure
sudo chown -R coder:coder /home/coder/.azure/
```
Navigate to the `./azure-linux` folder where you created your template and run the following command to put the template on your Coder instance.
```console
```shell
coder templates create
```

View File

@ -15,7 +15,7 @@ Coder with Docker has the following advantages:
1. Run Coder with Docker.
```console
```shell
export CODER_DATA=$HOME/.config/coderv2-docker
export DOCKER_GROUP=$(getent group docker | cut -d: -f3)
mkdir -p $CODER_DATA
@ -30,7 +30,7 @@ Coder with Docker has the following advantages:
1. In new terminal, [install Coder](../install/) in order to connect to your deployment through the CLI.
```console
```shell
curl -L https://coder.com/install.sh | sh
```
@ -39,7 +39,7 @@ Coder with Docker has the following advantages:
1. Pull the "Docker" example template using the interactive `coder templates init`:
```console
```shell
coder templates init
cd docker
```

View File

@ -36,7 +36,7 @@ This will give you a terminal into the VM that we will use to install Coder.
In the terminal, run the following command
```console
```shell
curl -fsSL https://coder.com/install.sh | sh
```
@ -46,7 +46,7 @@ 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:
```console
```shell
sudo vim /etc/coder.d/coder.env
```
@ -54,13 +54,13 @@ sudo vim /etc/coder.d/coder.env
Exit vim and run the following command to start Coder as a system service:
```console
```shell
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.
```console
```shell
journalctl -u coder.service -b
```
@ -70,7 +70,7 @@ In this instance, Coder can be accessed at the URL `https://fcca2f3bfc9d2e3bf1b9
Copy the URL and run the following command to create the workspace admin:
```console
```shell
coder login <url***.try.coder.app>
```
@ -86,7 +86,7 @@ Select the `Develop in Linux on Google Cloud`, then `cd ./gcp-linux`.
Run the following command:
```console
```shell
coder templates create
```