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

docs: use about as home page (#2382)

Browse Source 
* docs: use About as home page

* docs: format install.md
This commit is contained in:
Ammar Bandukwala
2022-06-15 14:03:13 -05:00
committed by GitHub
parent 961f5110ca
commit 2e625c1d9b
4 changed files with 135 additions and 169 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/install.md
+39 -40
View File
@@ -49,7 +49,6 @@ sudo service coder restart
Or run a **temporary deployment** with dev mode (all data is in-memory and destroyed on exit):
```sh
coder server --dev
```
@@ -61,65 +60,65 @@ Coder](https://github.com/coder/coder/releases) installed.
1. Clone the `coder` repository:
```console
git clone git@github.com:coder/coder.git
```
```console
git clone git@github.com:coder/coder.git
```
1. Navigate into the `coder` folder. Coder requires a non-`localhost` access URL
for non-Docker-based examples; if you have a public IP or a domain/reverse
proxy, you can provide this value before running `docker-compose up` to
start the service:
for non-Docker-based examples; if you have a public IP or a domain/reverse
proxy, you can provide this value before running `docker-compose up` to
start the service:
```console
cd coder
CODER_ACCESS_URL=https://coder.mydomain.com
docker-compose up
```
```console
cd coder
CODER_ACCESS_URL=https://coder.mydomain.com
docker-compose up
```
Otherwise, you can start the service:
Otherwise, you can start the service:
```console
cd coder
docker-compose up
```
```console
cd coder
docker-compose up
```
Alternatively, if you would like to start a **temporary deployment**:
Alternatively, if you would like to start a **temporary deployment**:
```console
docker run --rm -it \
-e CODER_DEV_MODE=true \
-v /var/run/docker.sock:/var/run/docker.sock \
ghcr.io/coder/coder:v0.5.10
```
```console
docker run --rm -it \
-e CODER_DEV_MODE=true \
-v /var/run/docker.sock:/var/run/docker.sock \
ghcr.io/coder/coder:v0.5.10
```
1. Follow the on-screen instructions to create your first template and workspace
## Manual
## Manual
We publish self-contained .zip and .tar.gz archives in [GitHub releases](https://github.com/coder/coder/releases). The archives bundle `coder` binary.
We publish self-contained .zip and .tar.gz archives in [GitHub releases](https://github.com/coder/coder/releases). The archives bundle `coder` binary.
1. Download the [release archive](https://github.com/coder/coder/releases) 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`
```sh
# ex. MacOS and Linux
mv coder /usr/local/bin
```
```sh
# ex. MacOS and Linux
mv coder /usr/local/bin
```
> Windows users: see [this guide](https://answers.microsoft.com/en-us/windows/forum/all/adding-path-variable/97300613-20cb-4d85-8d0e-cc9d3549ba23) for adding folders to `PATH`.
> Windows users: see [this guide](https://answers.microsoft.com/en-us/windows/forum/all/adding-path-variable/97300613-20cb-4d85-8d0e-cc9d3549ba23) for adding folders to `PATH`.
1. Start a Coder server
To run a **temporary deployment**, start with dev mode (all data is in-memory and destroyed on exit):
To run a **temporary deployment**, start with dev mode (all data is in-memory and destroyed on exit):
```bash
coder server --dev
```
```bash
coder server --dev
```
To run a **production deployment** with PostgreSQL:
To run a **production deployment** with PostgreSQL:
```bash
CODER_PG_CONNECTION_URL="postgres://<username>@<host>/<database>?password=<password>" \
coder server
```
```bash
CODER_PG_CONNECTION_URL="postgres://<username>@<host>/<database>?password=<password>" \
coder server
```