move around some stuff

coder · bpmct · Sep 8, 2022 · Sep 1, 2022 · Sep 2, 2022 · Sep 2, 2022
commit 5de57568f2003d752fe666b89b6e058e0b2f874f
diff --git a/coder.env b/coder.env
@@ -1,4 +1,6 @@
-# Run "coder server --help" for flag information.
+# Coder must be reachable from an external URL for users and workspaces to connect.
+# Enable CODER_TUNNEL (easy) or set CODER_ACCESS_URL
+
 CODER_ACCESS_URL=
 CODER_ADDRESS=
 CODER_PG_CONNECTION_URL=
@@ -7,3 +9,5 @@ CODER_TLS_ENABLE=
 CODER_TLS_KEY_FILE=
 # Generate a unique *.try.coder.app access URL
 CODER_TUNNEL=false
+
+# Run "coder server --help" for flag information.
diff --git a/docs/install/auth.md → docs/admin/auth.md b/docs/install/auth.md → docs/admin/auth.md
diff --git a/docs/install/configure.md → docs/admin/configure.md b/docs/install/configure.md → docs/admin/configure.md
diff --git a/docs/admin/index.md b/docs/admin/index.md
diff --git a/docs/install/upgrade.md → docs/admin/upgrade.md b/docs/install/upgrade.md → docs/admin/upgrade.md
diff --git a/docs/install/docker.md b/docs/install/docker.md
@@ -0,0 +1,77 @@
+Coder publishes containerized images
+
+## Standalone container
+
+Requirements:
+
+- Docker
+-
+
+   sudo rm -r ~/coder-stuff2/
+   mkdir ~/coder-stuff2/
+   docker run --rm -it \
+    -e CODER_TUNNEL=true \
+    -e CODER_CONFIG_DIR=/opt/coder-data \
+   -v /var/run/docker.sock:/var/run/docker.sock \
+    -v $HOME/coder-stuff2/:/opt/coder-data/ \
+   ghcr.io/coder/coder:latest
+
+1. Clone the `coder` repository:
+
+   ```console
+   git clone https://github.com/coder/coder.git
+   ```
+
+2. Navigate into the `coder` folder and run `docker-compose up`:
+
+   ```console
+   cd coder
+   # Coder will bind to localhost:7080.
+   # You may use localhost:7080 as your access URL
+   # when using Docker workspaces exclusively.
+   #  CODER_ACCESS_URL=http://localhost:7080
+   # Otherwise, an internet accessible access URL
+   # is required.
+   CODER_ACCESS_URL=https://coder.mydomain.com
+   docker-compose up
+   ```
+
+   Otherwise, you can start the service:
+
+   ```console
+   cd coder
+   docker-compose up
+   ```
+
+   docker run --rm -it \
+    -e CODER_TUNNEL=true \
+    -v /var/run/docker.sock:/var/run/docker.sock \
+    -v ~/idk:/home/coder \
+   ghcr.io/coder/coder:latest
+
+   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
+   ```
+
+3. Follow the on-screen instructions to create your first template and workspace
+
+If the user is not in the Docker group, you will see the following error:
+
+```sh
+Error: Error pinging Docker server: Got permission denied while trying to connect to the Docker daemon socket
+```
+
+The default docker socket only permits connections from `root` or members of the `docker`
+group. Remedy like this:
+
+```sh
+# replace "coder" with user running coderd
+sudo usermod -aG docker coder
+grep /etc/group -e "docker"
+sudo systemctl restart coder.service
+```
diff --git a/docs/install/index.md b/docs/install/index.md
@@ -0,0 +1,3 @@
+There are a number of different ways to install Coder
+
+<children></children>
diff --git a/docs/install/install.sh.md b/docs/install/install.sh.md
@@ -0,0 +1,27 @@
+The easiest way to install Coder is to use our [install script](https://github.com/coder/coder/blob/main/install.sh) for Linux and macOS.
+
+To install, run:
+
+```bash
+curl -fsSL https://coder.com/install.sh | sh
+```
+
+You can preview what occurs during the install process:
+
+```bash
+curl -fsSL https://coder.com/install.sh | sh -s -- --dry-run
+```
+
+You can modify the installation process by including flags. Run the help command for reference:
+
+```bash
+curl -fsSL https://coder.com/install.sh | sh -s -- --help
+```
+
+After installing, use the instructions in your terminal to start the Coder server and create your first account.
+
+## Next steps
+
+- [Quickstart](../quickstart.md)
+- [Configuring Coder](../admin/configure.md)
+- [Templates](../templates.md)
diff --git a/docs/install/manual.md b/docs/install/manual.md
diff --git a/docs/install/packages.md b/docs/install/packages.md
@@ -0,0 +1,30 @@
+Coder publishes the following system packages [in GitHub releases](https://github.com/coder/coder/releases):
+
+- .deb (Debian, Ubuntu)
+- .rpm (Fedora, CentOS, RHEL, SUSE)
+- .apk (Alpine)
+
+Once installed, you can run Coder as a system service.
+
+```sh
+# Set up an access URL or enable CODER_TUNNEL
+sudo vim /etc/coder.d/coder.env
+
+# To systemd to start Coder now and on reboot
+sudo systemctl enable --now coder
+
+# View the logs to see Coder's URL and ensure a successful start
+journalctl -u coder.service -b
+```
+
+Visit the Coder URL in the logs to set up your first account, or use the CLI:
+
+```sh
+coder login <access-url>
+```
+
+## Next steps
+
+- [Quickstart](../quickstart.md)
+- [Configuring Coder](../admin/configure.md)
+- [Templates](../templates.md)
diff --git a/docs/manifest.json b/docs/manifest.json
@@ -23,22 +23,27 @@
       "title": "Installation",
       "description": "How to install and deploy Coder",
       "icon_path": "./images/icons/wrench.svg",
-      "path": "./install.md",
+      "path": "./install/index.md",
       "children": [
         {
-          "title": "Authentication",
-          "description": "Learn how to set up authentication using GitHub or OpenID Connect.",
-          "path": "./install/auth.md"
+          "title": "Install script",
+          "description": "One-line install script for macOS and Linux.",
+          "path": "./install/install.sh.md"
         },
         {
-          "title": "Configuration",
-          "description": "Learn how to configure Coder",
-          "path": "./install/configure.md"
+          "title": "Docker",
+          "description": "Install Coder with Docker / docker-compose",
+          "path": "./install/docker.md"
         },
         {
-          "title": "Upgrading",
-          "description": "Learn how to upgrade Coder.",
-          "path": "./install/upgrade.md"
+          "title": "System packages",
+          "description": "System packages for Debian, Ubuntu, Fedora, CentOS, RHEL, SUSE, and Alpine.",
+          "path": "./install/packages.md"
+        },
+        {
+          "title": "Standalone binaries",
+          "description": "Download the binary for Mac, Windows, or Linux.",
+          "path": "./install/manual.md"
         }
       ]
     },
@@ -128,6 +133,29 @@
       "icon_path": "./images/icons/secrets.svg",
       "path": "./secrets.md"
     },
+    {
+      "title": "Administration",
+      "description": "How to install and deploy Coder",
+      "icon_path": "./images/icons/wrench.svg",
+      "path": "./admin/index.md",
+      "children": [
+        {
+          "title": "Authentication",
+          "description": "Learn how to set up authentication using GitHub or OpenID Connect.",
+          "path": "./admin/auth.md"
+        },
+        {
+          "title": "Configuration",
+          "description": "Learn how to configure Coder",
+          "path": "./admin/configure.md"
+        },
+        {
+          "title": "Upgrading",
+          "description": "Learn how to upgrade Coder.",
+          "path": "./admin/upgrade.md"
+        }
+      ]
+    },
     {
       "title": "Users",
       "description": "Learn about user roles available in Coder and how to create and manage users",
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		There are a number of different ways to install Coder

		<children></children>