@@ -20,52 +20,69 @@ Provision remote development environments with Terraform.
20
20
21
21
## Installing Coder
22
22
23
- Install [ the latest release] ( https://github.com/coder/coder/releases ) on a system with
24
- at least 1 CPU core and 2 GB RAM.
23
+ We recommend installing [ the latest
24
+ release] ( https://github.com/coder/coder/releases ) on a system with at least 1
25
+ CPU core and 2 GB RAM:
25
26
26
- To test, start with dev mode (all data is in-memory and is destroyed on exit):
27
+ 1 . Download the release appropriate for your operating system
28
+ 1 . Unzip the folder you just downloaded, and move the ` coder ` executable to a
29
+ location that's on your ` PATH `
27
30
28
- ``` bash
29
- coder server --dev
30
- ```
31
+ > Make sure you have the appropriate credentials for your cloud provider (e.g.,
32
+ > access key ID and secret access key for AWS).
31
33
32
- To run a production deployment with PostgreSQL :
34
+ You can set up a temporary deployment, a production deployment, or a system service :
33
35
34
- ``` bash
35
- CODER_PG_CONNECTION_URL=" postgres://<username>@<host>/<database>?password=<password>" \
36
- coder server
37
- ```
36
+ - To set up a ** temporary deployment** , start with dev mode (all data is in-memory and is
37
+ destroyed on exit):
38
+
39
+ ``` bash
40
+ coder server --dev
41
+ ```
42
+
43
+ - To run a ** production deployment** with PostgreSQL:
44
+
45
+ ``` bash
46
+ CODER_PG_CONNECTION_URL=" postgres://<username>@<host>/<database>?password=<password>" \
47
+ coder server
48
+ ```
38
49
39
- To run as a system service, install with ` .deb ` (Debian, Ubuntu) or ` .rpm `
50
+ - To run as a ** system service** , install with ` .deb ` (Debian, Ubuntu) or ` .rpm `
40
51
(Fedora, CentOS, RHEL, SUSE):
41
52
42
- ``` bash
43
- # Edit the configuration!
44
- sudo vim /etc/coder.d/coder.env
45
- sudo service coder restart
46
- ```
53
+ ``` bash
54
+ # Edit the configuration!
55
+ sudo vim /etc/coder.d/coder.env
56
+ sudo service coder restart
57
+ ```
47
58
48
- Use ` coder start --help ` to get a complete list of flags and environment
59
+ > Use ` coder --help ` to get a complete list of flags and environment
49
60
variables.
50
61
51
- ### Your first workspace
62
+ ## Creating your first template and workspace
52
63
53
- In a new terminal, create a template (e.g., a template to ** Develop in Linux on
54
- Google Cloud** ):
64
+ In a new terminal window, run the following to copy a sample template:
55
65
56
66
``` bash
57
67
coder templates init
58
- coder templates create
59
68
```
60
69
61
- Create a workspace and connect to it via SSH:
70
+ Follow the CLI instructions to modify and create the template specific for your
71
+ usage (e.g., a template to ** Develop in Linux on Google Cloud** ).
72
+
73
+ Create a workspace using your template:
74
+
75
+ ``` bash
76
+ coder create --template=" yourTemplate" < workspaceName>
77
+ ```
78
+
79
+ Connect to your workspace via SSH:
62
80
63
81
``` bash
64
- coder create my-first-workspace
65
- coder ssh my-first-workspace
82
+ coder ssh < workspaceName>
66
83
```
67
84
68
- ### Modifying templates
85
+ ## Modifying templates
69
86
70
87
You can edit the Terraform template using a sample template:
71
88
0 commit comments