Thanks to visit codestin.com
Credit goes to github.com

Skip to content

chore: validate docs #1485

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
May 19, 2022
Merged

chore: validate docs #1485

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
68579b6
chore: update README usage instructions
May 16, 2022
5a63e83
chore: fix typos
May 16, 2022
ebf20c1
chore: fix a typo in command
May 16, 2022
b01344f
apply changes based on review
May 17, 2022
d351ecb
chore: edit text
May 17, 2022
4f42d1c
chore: update verbiage
May 18, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
69 changes: 43 additions & 26 deletions docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,52 +20,69 @@ Provision remote development environments with Terraform.

## Installing Coder

Install [the latest release](https://github.com/coder/coder/releases) on a system with
at least 1 CPU core and 2 GB RAM.
We recommend installing [the latest
release](https://github.com/coder/coder/releases) on a system with at least 1
CPU core and 2 GB RAM:

To test, start with dev mode (all data is in-memory and is destroyed on exit):
1. Download the release appropriate for your operating system
1. Unzip the folder you just downloaded, and move the `coder` executable to a
location that's on your `PATH`

```bash
coder server --dev
```
> Make sure you have the appropriate credentials for your cloud provider (e.g.,
> access key ID and secret access key for AWS).

To run a production deployment with PostgreSQL:
You can set up a temporary deployment, a production deployment, or a system service:

```bash
CODER_PG_CONNECTION_URL="postgres://<username>@<host>/<database>?password=<password>" \
coder server
```
- To set up a **temporary deployment**, start with dev mode (all data is in-memory and is
destroyed on exit):

```bash
coder server --dev
```

- To run a **production deployment** with PostgreSQL:

```bash
CODER_PG_CONNECTION_URL="postgres://<username>@<host>/<database>?password=<password>" \
coder server
```

To run as a system service, install with `.deb` (Debian, Ubuntu) or `.rpm`
- To run as a **system service**, install with `.deb` (Debian, Ubuntu) or `.rpm`
(Fedora, CentOS, RHEL, SUSE):

```bash
# Edit the configuration!
sudo vim /etc/coder.d/coder.env
sudo service coder restart
```
```bash
# Edit the configuration!
sudo vim /etc/coder.d/coder.env
sudo service coder restart
```

Use `coder start --help` to get a complete list of flags and environment
> Use `coder --help` to get a complete list of flags and environment
variables.

### Your first workspace
## Creating your first template and workspace

In a new terminal, create a template (e.g., a template to **Develop in Linux on
Google Cloud**):
In a new terminal window, run the following to copy a sample template:

```bash
coder templates init
coder templates create
```

Create a workspace and connect to it via SSH:
Follow the CLI instructions to modify and create the template specific for your
usage (e.g., a template to **Develop in Linux on Google Cloud**).

Create a workspace using your template:

```bash
coder create --template="yourTemplate" <workspaceName>
```

Connect to your workspace via SSH:

```bash
coder create my-first-workspace
coder ssh my-first-workspace
coder ssh <workspaceName>
```

### Modifying templates
## Modifying templates

You can edit the Terraform template using a sample template:

Expand Down
2 changes: 1 addition & 1 deletion docs/templates.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ to everybody. Users can also manually update their workspaces.

## Manage templates

Coder provides production-ready [sample template](../examples/), but you can
Coder provides production-ready [sample templates](../examples/), but you can
modify the templates with Terraform.

```sh
Expand Down
7 changes: 3 additions & 4 deletions docs/workspaces.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ templates](./templates.md):
# create a workspace from the template; specify any variables
coder create <workspace-name>

# show the resources behind the workspace, and how to connect
# show the resources behind the workspace and how to connect
coder show <workspace-name>
```

Expand All @@ -23,8 +23,7 @@ IDE with remote development support:

```sh
coder config-ssh

ssh coder.<workspace-name>
coder ssh <workspaceName>
```

## Editors and IDEs
Expand Down Expand Up @@ -61,7 +60,7 @@ resources](./templates.md#persistent-and-ephemeral-resources).
> where to store files, install software, etc., so that they persist. Default
> templates are documented in [../examples](../examples/).
>
> You can use `coder workspace show <workspace-name>` to see which resources are
> You can use `coder show <workspace-name>` to see which resources are
> persistent and which are ephemeral.

When a workspace is deleted, all of the workspace's resources are deleted.
Expand Down