You signed in with another tab or window.Reload to refresh your session.You signed out in another tab or window.Reload to refresh your session.You switched accounts on another tab or window.Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/quickstart/aws.md
+14-10Lines changed: 14 additions & 10 deletions
Original file line number
Diff line number
Diff line change
@@ -1,8 +1,11 @@
1
1
#Amazon Web Services
2
2
3
-
##Requirements
3
+
This quickstart shows you how to set up the Coder server on AWS which will
4
+
provision AWS-hosted, Linux workspaces.
4
5
5
-
This quickstart assumes you are assigned`AdministratorAccess` policy to AWS.
6
+
##Requirements
7
+
8
+
This quickstart assumes you are assigned the`AdministratorAccess` policy on AWS.
6
9
7
10
##Setting Up Security Groups for EC2
8
11
@@ -26,7 +29,7 @@ On the EC2 dashboard, click `Instances`. This will take you to all the EC2 insta
26
29
27
30
<imgsrc="../images/quickstart/aws/aws3.png">
28
31
29
-
For this tutorial, we are going to launch this as the base Ubuntu server.
32
+
For this tutorial, we are going to launch this as the base Ubuntu server.
30
33
31
34
For the`Create key pair`, we are using ED25519 and`.pem` as we will SSH into the instance later in the tutorial.
32
35
<imgsrc="../images/quickstart/aws/aws4.png">
@@ -55,7 +58,7 @@ chmod 400 [mykey].pem
55
58
56
59
This adds the required permissions for SSH-ing into an EC2 instance.
57
60
58
-
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:
61
+
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:
59
62
60
63
```sh
61
64
ssh -i [mykey].pem username@ip-address
@@ -80,6 +83,7 @@ First, edit the `coder.env` file to enable `CODER_TUNNEL` by setting the value t
80
83
```sh
81
84
sudo vim /etc/coder.d/coder.env
82
85
```
86
+
83
87
<imgsrc="../images/quickstart/aws/aws7.png">
84
88
85
89
Exit vim and run the following command to start Coder as a system level service:
@@ -100,23 +104,23 @@ This will return a series of Coder logs, however, embedded in the launch is the
100
104
101
105
In this instance, Coder can be accessed at the url`https://fccad1b6c901511b30cf2cf4fbd0973e.pit-1.try.coder.app`.
102
106
103
-
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.
107
+
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.
104
108
105
109
```sh
106
110
coder login<url***.try.coder.app>
107
111
```
108
112
109
113
Fill out the prompts. Be sure to save use email and password as these are your admin username and password.
110
114
111
-
You can now access Coder on your local machine with the relevant`***.try.coder.app` URL and logging in with the username and password.
115
+
You can now access Coder on your local machine with the relevant`***.try.coder.app` URL and logging in with the username and password.
112
116
113
117
##Creating and Uploading Your First Template
114
118
115
-
Run`coder template init` to create your first template. You’ll be given a list of possible templates. This tutorial will show you how to set up your Coder instance to create Linux based machines on AWS.
119
+
Run`coder template init` to create your first template. You’ll be given a list of possible templates. This tutorial will show you how to set up your Coder instance to create Linux based machines on AWS.
116
120
117
121
<imgsrc="../images/quickstart/aws/aws9.png">
118
122
119
-
Press`enter` to select`Develop in Linux` on AWS template. This will return the following:
123
+
Press`enter` to select`Develop in Linux` on AWS template. This will return the following:
120
124
121
125
<imgsrc="../images/quickstart/aws/aws10.png">
122
126
@@ -133,11 +137,11 @@ sudo mkdir /home/coder/.aws
133
137
Run the following commands to copy the AWS credentials and give the`coder` user access to them:
Copy file name to clipboardExpand all lines: docs/quickstart/azure.md
+15-13Lines changed: 15 additions & 13 deletions
Original file line number
Diff line number
Diff line change
@@ -1,10 +1,11 @@
1
1
#Microsoft Azure
2
2
3
-
This quickstart will show you how to set up the Coder server on Azure and then set up an Azure hosted Linux based workspace, which allows users to create there own instances of these workspaces and use the Coder product.
3
+
This quickstart shows you how to set up the Coder server on Azure which will
4
+
provision Azure-hosted Linux workspaces.
4
5
5
-
##Requirements
6
+
##Requirements
6
7
7
-
This quickstart assumes you haveaccess to admin level access toAzure.
8
+
This quickstart assumes you havefull administrator privileges onAzure.
8
9
9
10
##Create An Azure VM
10
11
@@ -24,11 +25,11 @@ Up next, under `Inbound port rules` modify the Select `inbound ports` to also ta
24
25
25
26
<imgsrc="../images/quickstart/azure/azure4.png">
26
27
27
-
The set up for the image is complete at this stage. Click`Review and Create` - review the information and click`Create`. A popup will appear asking you to download the key pair for the server. Click`Download private key and create resource` and place it into a folder of your choice on your local system.
28
+
The set up for the image is complete at this stage. Click`Review and Create` - review the information and click`Create`. A popup will appear asking you to download the key pair for the server. Click`Download private key and create resource` and place it into a folder of your choice on your local system.
28
29
29
30
<imgsrc="../images/quickstart/azure/azure5.png">
30
31
31
-
Click`Return to create a virtual machine`. Your VM will start up!
32
+
Click`Return to create a virtual machine`. Your VM will start up!
32
33
33
34
<imgsrc="../images/quickstart/azure/azure6.png">
34
35
@@ -53,6 +54,7 @@ First, edit the `coder.env` file to enable `CODER_TUNNEL` by setting the value t
53
54
```sh
54
55
sudo vim /etc/coder.d/coder.env
55
56
```
57
+
56
58
<imgsrc="../images/quickstart/azure/azure7.png">
57
59
58
60
Exit vim and run the following command to start Coder as a system level service:
@@ -69,38 +71,38 @@ The following command will get you information about the Coder launch service
69
71
70
72
This will return a series of logs related to running Coder as a system service. Embedded in the logs is the Coder Access URL.
71
73
72
-
Copy the URL and run the following command to create the first user, either on your local machine or in the instance terminal.
74
+
Copy the URL and run the following command to create the first user, either on your local machine or in the instance terminal.
73
75
74
76
```sh
75
77
coder login<url***.try.coder.app>
76
78
```
77
79
78
80
Fill out the prompts. Be sure to save use email and password as these are your admin username and password.
79
81
80
-
You can now access Coder on your local machine with the relevant`***.try.coder.app` URL and logging in with the username and password.
82
+
You can now access Coder on your local machine with the relevant`***.try.coder.app` URL and logging in with the username and password.
81
83
82
84
##Creating and Uploading Your First Template
83
85
84
-
First, run`coder template init` to create your first template. You’ll be given a list of possible templates to use. This tutorial will show you how to set up your Coder instance to create a Linux based machine on Azure.
86
+
First, run`coder template init` to create your first template. You’ll be given a list of possible templates to use. This tutorial will show you how to set up your Coder instance to create a Linux based machine on Azure.
85
87
86
88
<imgsrc="../images/quickstart/azure/azure9.png">
87
89
88
-
Press`enter` to select`Develop in Linux on Azure` template. This will return the following:
90
+
Press`enter` to select`Develop in Linux on Azure` template. This will return the following:
89
91
90
92
<imgsrc="../images/quickstart/azure/azure10.png">
91
93
92
-
To get started using the Azure template, install the Azure CLI by following the instructions[here](https://learn.microsoft.com/en-us/cli/azure/install-azure-cli-linux?pivots=apt). Run`az login` and follow the instructions to configure the Azure command line.
94
+
To get started using the Azure template, install the Azure CLI by following the instructions[here](https://learn.microsoft.com/en-us/cli/azure/install-azure-cli-linux?pivots=apt). Run`az login` and follow the instructions to configure the Azure command line.
93
95
94
96
Coder is running as a system service, which creates the system user`coder` for handling processes. The Coder user will require access to the Azure credentials to initialize the template.
95
97
96
98
Run the following commands to copy the Azure credentials and give the`coder` user access to them:
97
99
98
100
```sh
99
-
sudo cp -r~/.azure /home/coder/.azure
101
+
sudo cp -r~/.azure /home/coder/.azure
100
102
sudo chown -R coder:coder /home/coder/.azure/
101
103
```
102
104
103
-
Navigate to the`./azure-linux` folder where you created your template and run the following command to put the template on your Coder instance.
105
+
Navigate to the`./azure-linux` folder where you created your template and run the following command to put the template on your Coder instance.
104
106
105
107
```sh
106
108
coder templates create
@@ -110,6 +112,6 @@ Congrats! You can now navigate to your Coder dashboard and use this Linux on Azu