opensource/coder
3
0
Fork 0
mirror of https://github.com/coder/coder.git synced 2026-09-24 15:04:27 +08:00
Code Issues Packages Projects Releases Wiki Activity

feat: initial docs pages (#1107)

Browse Source 
* docs structure and edits to getting started

* draft for about page

* skeleton for concepts page

* attempt at explaining templates

* left-align tables

* add best practices and variables

* update structrure

* update structure

* templates are shared

* workspaces docs

* remove coming soon

* fix typos

* docs structure and edits to getting started

* draft for about page

* skeleton for concepts page

* attempt at explaining templates

* left-align tables

* add best practices and variables

* update structrure

* update structure

* templates are shared

* workspaces docs

* remove coming soon

* fix typos

* fix typos

* Update docs/about.md

Co-authored-by: Joe Previte <jjprevite@gmail.com>

* remove line breaks between bullets

* rename variables to parameters

* reduce limits

* chore: edit text

* revert some changes, fix footnotes

Co-authored-by: Katie Horne <katie@coder.com>
Co-authored-by: Joe Previte <jjprevite@gmail.com>
This commit is contained in:
Ben Potter
2022-04-26 12:10:50 -05:00
committed by GitHub
co-authored by Joe Previte Katie Horne
parent 603b7da413
commit 22668c388c
6 changed files with 302 additions and 55 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/README.md
+56 -27
View File
@@ -1,68 +1,97 @@
# Coder
[!["GitHub Discussions"](https://img.shields.io/badge/%20GitHub-%20Discussions-gray.svg?longCache=true&logo=github&colorB=purple)](https://github.com/coder/coder/discussions) [!["Join us on Slack"](https://img.shields.io/badge/join-us%20on%20slack-gray.svg?longCache=true&logo=slack&colorB=brightgreen)](https://coder.com/community) [![Twitter Follow](https://img.shields.io/twitter/follow/CoderHQ?label=%40CoderHQ&style=social)](https://twitter.com/coderhq) [![codecov](https://codecov.io/gh/coder/coder/branch/main/graph/badge.svg?token=TNLW3OAP6G)](https://codecov.io/gh/coder/coder)
[!["GitHub
Discussions"](https://img.shields.io/badge/%20GitHub-%20Discussions-gray.svg?longCache=true&logo=github&colorB=purple)](https://github.com/coder/coder/discussions)
[!["Join us on
Slack"](https://img.shields.io/badge/join-us%20on%20slack-gray.svg?longCache=true&logo=slack&colorB=brightgreen)](https://coder.com/community)
[![Twitter
Follow](https://img.shields.io/twitter/follow/CoderHQ?label=%40CoderHQ&style=social)](https://twitter.com/coderhq)
[![codecov](https://codecov.io/gh/coder/coder/branch/main/graph/badge.svg?token=TNLW3OAP6G)](https://codecov.io/gh/coder/coder)
Provision remote development environments with Terraform.
## Highlights
- Automate development environments for Linux, Windows, and MacOS in your cloud
- Automate development environments for Linux, Windows, and macOS
- Start writing code with a single command
- Use one of many [examples](./examples) to get started
- Get started quickly using one of the [examples](./examples) provided
## Getting Started
## Installing Coder
Install [the latest release](https://github.com/coder/coder/releases).
Install [the latest release](https://github.com/coder/coder/releases) on a system with
at least 1 CPU core and 2 GB RAM.
To tinker, start with dev-mode (all data is in-memory, and is destroyed on exit):
To test, start with dev mode (all data is in-memory and is destroyed on exit):
```bash
$ coder server --dev
coder server --dev
```
To run a production deployment with PostgreSQL:
```bash
$ CODER_PG_CONNECTION_URL="postgres://<username>@<host>/<database>?password=<password>" \
CODER_PG_CONNECTION_URL="postgres://<username>@<host>/<database>?password=<password>" \
coder server
```
To run as a system service, install with `.deb` 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
sudo vim /etc/coder.d/coder.env
sudo service coder restart
```
### Your First Workspace
Use `coder start --help` to get a complete list of flags and environment
variables.
In a new terminal, create a new project (eg. Develop in Linux on Google Cloud):
### Your first workspace
```
$ coder templates init
$ coder templates create
In a new terminal, create a template (e.g., a template to **Develop in Linux on
Google Cloud**):
```bash
coder templates init
coder templates create
```
Create a new workspace and SSH in:
Create a workspace and connect to it via SSH:
```
$ coder workspaces create my-first-workspace
$ coder ssh my-first-workspace
```bash
coder workspaces create my-first-workspace
coder ssh my-first-workspace
```
### Working with Projects
### Modifying templates
You can edit the Terraform from a sample project:
You can edit the Terraform template using a sample template:
```sh
$ coder templates init
$ cd gcp-linux/
$ vim main.tf
$ coder templates update gcp-linux
coder templates init
cd gcp-linux/
vim main.tf
coder templates update gcp-linux
```
## Documentation
- [About Coder](./about.md#about-coder)
- [Why remote development](about.md#why-remote-development)
- [Why Coder](about.md#why-coder)
- [What Coder is not](about.md#what-coder-is-not)
- [Templates](./templates.md)
- [Manage templates](./templates.md#manage-templates)
- [Persistent and ephemeral
resources](./templates.md#persistent-and-ephemeral-resources)
- [Variables](./templates.md#variables)
- [Workspaces](./workspaces.md)
- [Create workspaces](./workspaces.md#create-workspaces)
- [Connect with SSH](./workspaces.md#connect-with-ssh)
- [Editors and IDEs](./workspaces.md#editors-and-ides)
- [Workspace lifecycle](./workspaces.md#workspace-lifecycle)
- [Updating workspaces](./workspaces.md#updating-workspaces)
## Contributing
Read the [contributing docs](./CONTRIBUTING.md).