mirror of
https://github.com/coder/coder.git
synced 2025-07-12 00:14:10 +00:00
chore(docs): update docs for correct use of shell and console and enforce linewidth (#9245)
This commit is contained in:
Muhammad Atif Ali
committed by
GitHub
GitHub
parent
ed2b1236c0
commit
d37f6d80f7
@ -20,7 +20,7 @@ This will:
|
||||
|
||||
- Start an Ubuntu 22.04 VM
|
||||
- Install Docker and Terraform from the official repos
|
||||
- Install Coder using the [installation script](https://coder.com/docs/coder-oss/latest/install#installsh)
|
||||
- Install Coder using the [installation script](../../docs/install/install.sh.md)
|
||||
- Generates an initial user account `admin@coder.com` with a randomly generated password (stored in the VM under `/home/${USER}.linux/.config/coderv2/password`)
|
||||
- Initializes a [sample Docker template](https://github.com/coder/coder/tree/main/examples/templates/docker) for creating workspaces
|
||||
|
||||
|
||||
@ -2,22 +2,35 @@
|
||||
|
||||
This is a list of templates and actions created by the community.
|
||||
|
||||
See [Getting Started](./README.md#getting-started) for how to use these templates.
|
||||
See [Getting Started](./README.md#getting-started) for how to use these
|
||||
templates.
|
||||
|
||||
> If you have created a template, see one that's missing or one that's no longer
|
||||
> maintained, please submit a pull request to improve this list. Thank you!
|
||||
|
||||
## Templates
|
||||
|
||||
- [ntimo/coder-hetzner-cloud-template](https://github.com/ntimo/coder-hetzner-cloud-template) - Setup a Hetzner Cloud instance as dev environment with or without vscode.
|
||||
- [matifali/coder-templates](https://github.com/matifali/coder-templates) - Deeplearning with Jupyter Notebook/Lab and Matlab in browser.
|
||||
- [m.lan/coder-templates](https://gitlab.com/m.lan/coder-templates) - Kubernetes template with DinD.
|
||||
- [jsjoeio/coder-templates](https://github.com/jsjoeio/coder-templates) - Docker templates that prompt for dotfiles and base Docker image.
|
||||
- [sharkymark/v2-templates](https://github.com/sharkymark/v2-templates) - Kubernetes, Docker, AWS, Google Cloud, Azure templates, videos, emoji links, and API examples.
|
||||
- [bpmct/coder-templates](https://github.com/bpmct/coder-templates) - Kubernetes, OpenStack, podman, Docker, VM, AWS, Google Cloud, Azure templates.
|
||||
- [kozmiknano/vscode-server-template](https://github.com/KozmikNano/vscode-server-template) - Run the full VS Code server within docker! (Built-in settings sync and Microsoft Marketplace enabled)
|
||||
- [atnomoverflow/coder-template](https://github.com/atnomoverflow/coder-template) - Kubernetes template that install VS code server Rstudio jupyter and also set ssh access to gitlab (Works also on self managed gitlab).
|
||||
- [ntimo/coder-hetzner-cloud-template](https://github.com/ntimo/coder-hetzner-cloud-template) -
|
||||
Setup a Hetzner Cloud instance as dev environment with or without vscode.
|
||||
- [matifali/coder-templates](https://github.com/matifali/coder-templates) -
|
||||
Deeplearning with Jupyter Notebook/Lab and Matlab in browser.
|
||||
- [m.lan/coder-templates](https://gitlab.com/m.lan/coder-templates) - Kubernetes
|
||||
template with DinD.
|
||||
- [jsjoeio/coder-templates](https://github.com/jsjoeio/coder-templates) - Docker
|
||||
templates that prompt for dotfiles and base Docker image.
|
||||
- [sharkymark/v2-templates](https://github.com/sharkymark/v2-templates) -
|
||||
Kubernetes, Docker, AWS, Google Cloud, Azure templates, videos, emoji links,
|
||||
and API examples.
|
||||
- [bpmct/coder-templates](https://github.com/bpmct/coder-templates) -
|
||||
Kubernetes, OpenStack, podman, Docker, VM, AWS, Google Cloud, Azure templates.
|
||||
- [kozmiknano/vscode-server-template](https://github.com/KozmikNano/vscode-server-template) -
|
||||
Run the full VS Code server within docker! (Built-in settings sync and
|
||||
Microsoft Marketplace enabled)
|
||||
- [atnomoverflow/coder-template](https://github.com/atnomoverflow/coder-template) -
|
||||
Kubernetes template that install VS code server Rstudio jupyter and also set
|
||||
ssh access to gitlab (Works also on self managed gitlab).
|
||||
|
||||
## Automation
|
||||
|
||||
- [Update Coder Template](https://github.com/marketplace/actions/update-coder-template) - A GitHub action to automate coder template changes.
|
||||
- [Update Coder Template](https://github.com/marketplace/actions/update-coder-template) -
|
||||
A GitHub action to automate coder template changes.
|
||||
|
||||
@ -4,7 +4,7 @@
|
||||
|
||||
1. Start a Coder deployment and be sure to set the following [configuration values](https://coder.com/docs/v2/latest/admin/configure):
|
||||
|
||||
```console
|
||||
```env
|
||||
CODER_HTTP_ADDRESS=127.0.0.1:3000
|
||||
CODER_ACCESS_URL=https://coder.example.com
|
||||
CODER_WILDCARD_ACCESS_URL=*coder.example.com
|
||||
@ -18,13 +18,13 @@
|
||||
|
||||
3. Install Apache (assuming you're on Debian/Ubuntu):
|
||||
|
||||
```console
|
||||
```shell
|
||||
sudo apt install apache2
|
||||
```
|
||||
|
||||
4. Enable the following Apache modules:
|
||||
|
||||
```console
|
||||
```shell
|
||||
sudo a2enmod proxy
|
||||
sudo a2enmod proxy_http
|
||||
sudo a2enmod ssl
|
||||
@ -33,7 +33,7 @@
|
||||
|
||||
5. Stop Apache service and disable default site:
|
||||
|
||||
```console
|
||||
```shell
|
||||
sudo a2dissite 000-default.conf
|
||||
sudo systemctl stop apache2
|
||||
```
|
||||
@ -56,7 +56,7 @@
|
||||
dns_cloudflare_api_token = YOUR_API_TOKEN
|
||||
```
|
||||
|
||||
```console
|
||||
```shell
|
||||
mkdir -p ~/.secrets/certbot
|
||||
touch ~/.secrets/certbot/cloudflare.ini
|
||||
nano ~/.secrets/certbot/cloudflare.ini
|
||||
@ -64,7 +64,7 @@
|
||||
|
||||
3. Set the correct permissions:
|
||||
|
||||
```console
|
||||
```shell
|
||||
sudo chmod 600 ~/.secrets/certbot/cloudflare.ini
|
||||
```
|
||||
|
||||
@ -72,7 +72,7 @@
|
||||
|
||||
1. Create the wildcard certificate:
|
||||
|
||||
```console
|
||||
```shell
|
||||
sudo certbot certonly --dns-cloudflare --dns-cloudflare-credentials ~/.secrets/certbot/cloudflare.ini -d coder.example.com -d *.coder.example.com
|
||||
```
|
||||
|
||||
@ -82,7 +82,7 @@
|
||||
|
||||
1. Create Apache configuration for Coder:
|
||||
|
||||
```console
|
||||
```shell
|
||||
sudo nano /etc/apache2/sites-available/coder.conf
|
||||
```
|
||||
|
||||
@ -122,13 +122,13 @@
|
||||
|
||||
3. Enable the site:
|
||||
|
||||
```console
|
||||
```shell
|
||||
sudo a2ensite coder.conf
|
||||
```
|
||||
|
||||
4. Restart Apache:
|
||||
|
||||
```console
|
||||
```shell
|
||||
sudo systemctl restart apache2
|
||||
```
|
||||
|
||||
@ -136,19 +136,19 @@
|
||||
|
||||
1. Create a new file in `/etc/cron.weekly`:
|
||||
|
||||
```console
|
||||
```shell
|
||||
sudo touch /etc/cron.weekly/certbot
|
||||
```
|
||||
|
||||
2. Make it executable:
|
||||
|
||||
```console
|
||||
```shell
|
||||
sudo chmod +x /etc/cron.weekly/certbot
|
||||
```
|
||||
|
||||
3. And add this code:
|
||||
|
||||
```sh
|
||||
```shell
|
||||
#!/bin/sh
|
||||
sudo certbot renew -q
|
||||
```
|
||||
|
||||
@ -10,7 +10,7 @@ This is an example configuration of how to use Coder with [caddy](https://caddys
|
||||
|
||||
1. Start with our example configuration
|
||||
|
||||
```console
|
||||
```shell
|
||||
# Create a project folder
|
||||
cd $HOME
|
||||
mkdir coder-with-caddy
|
||||
@ -30,7 +30,7 @@ This is an example configuration of how to use Coder with [caddy](https://caddys
|
||||
|
||||
1. Start Coder. Set `CODER_ACCESS_URL` and `CODER_WILDCARD_ACCESS_URL` to the domain you're using in your Caddyfile.
|
||||
|
||||
```console
|
||||
```shell
|
||||
export CODER_ACCESS_URL=https://coder.example.com
|
||||
export CODER_WILDCARD_ACCESS_URL=*.coder.example.com
|
||||
docker compose up -d # Run on startup
|
||||
@ -60,19 +60,19 @@ This is an example configuration of how to use Coder with [caddy](https://caddys
|
||||
|
||||
If you're [keeping Caddy running](https://caddyserver.com/docs/running) via a system service:
|
||||
|
||||
```console
|
||||
```shell
|
||||
sudo systemctl restart caddy
|
||||
```
|
||||
|
||||
Or run a standalone server:
|
||||
|
||||
```console
|
||||
```shell
|
||||
caddy run
|
||||
```
|
||||
|
||||
6. Optionally, use [ufw](https://wiki.ubuntu.com/UncomplicatedFirewall) or another firewall to disable external traffic outside of Caddy.
|
||||
|
||||
```console
|
||||
```shell
|
||||
# Check status of UncomplicatedFirewall
|
||||
sudo ufw status
|
||||
|
||||
|
||||
@ -4,7 +4,7 @@
|
||||
|
||||
1. Start a Coder deployment and be sure to set the following [configuration values](https://coder.com/docs/v2/latest/admin/configure):
|
||||
|
||||
```console
|
||||
```env
|
||||
CODER_HTTP_ADDRESS=127.0.0.1:3000
|
||||
CODER_ACCESS_URL=https://coder.example.com
|
||||
CODER_WILDCARD_ACCESS_URL=*coder.example.com
|
||||
@ -18,13 +18,13 @@
|
||||
|
||||
3. Install NGINX (assuming you're on Debian/Ubuntu):
|
||||
|
||||
```console
|
||||
```shell
|
||||
sudo apt install nginx
|
||||
```
|
||||
|
||||
4. Stop NGINX service:
|
||||
|
||||
```console
|
||||
```shell
|
||||
sudo systemctl stop nginx
|
||||
```
|
||||
|
||||
@ -34,13 +34,13 @@
|
||||
|
||||
1. Create NGINX configuration for this app:
|
||||
|
||||
```console
|
||||
```shell
|
||||
sudo touch /etc/nginx/sites-available/coder.example.com
|
||||
```
|
||||
|
||||
2. Activate this file:
|
||||
|
||||
```console
|
||||
```shell
|
||||
sudo ln -s /etc/nginx/sites-available/coder.example.com /etc/nginx/sites-enabled/coder.example.com
|
||||
```
|
||||
|
||||
@ -62,7 +62,7 @@
|
||||
dns_cloudflare_api_token = YOUR_API_TOKEN
|
||||
```
|
||||
|
||||
```console
|
||||
```shell
|
||||
mkdir -p ~/.secrets/certbot
|
||||
touch ~/.secrets/certbot/cloudflare.ini
|
||||
nano ~/.secrets/certbot/cloudflare.ini
|
||||
@ -70,7 +70,7 @@
|
||||
|
||||
3. Set the correct permissions:
|
||||
|
||||
```console
|
||||
```shell
|
||||
sudo chmod 600 ~/.secrets/certbot/cloudflare.ini
|
||||
```
|
||||
|
||||
@ -78,7 +78,7 @@
|
||||
|
||||
1. Create the wildcard certificate:
|
||||
|
||||
```console
|
||||
```shell
|
||||
sudo certbot certonly --dns-cloudflare --dns-cloudflare-credentials ~/.secrets/certbot/cloudflare.ini -d coder.example.com -d *.coder.example.com
|
||||
```
|
||||
|
||||
@ -86,7 +86,7 @@
|
||||
|
||||
1. Edit the file with:
|
||||
|
||||
```console
|
||||
```shell
|
||||
sudo nano /etc/nginx/sites-available/coder.example.com
|
||||
```
|
||||
|
||||
@ -129,7 +129,7 @@
|
||||
|
||||
3. Test the configuration:
|
||||
|
||||
```console
|
||||
```shell
|
||||
sudo nginx -t
|
||||
```
|
||||
|
||||
@ -137,26 +137,26 @@
|
||||
|
||||
1. Create a new file in `/etc/cron.weekly`:
|
||||
|
||||
```console
|
||||
```shell
|
||||
sudo touch /etc/cron.weekly/certbot
|
||||
```
|
||||
|
||||
2. Make it executable:
|
||||
|
||||
```console
|
||||
```shell
|
||||
sudo chmod +x /etc/cron.weekly/certbot
|
||||
```
|
||||
|
||||
3. And add this code:
|
||||
|
||||
```sh
|
||||
```shell
|
||||
#!/bin/sh
|
||||
sudo certbot renew -q
|
||||
```
|
||||
|
||||
## Restart NGINX
|
||||
|
||||
```console
|
||||
```shell
|
||||
sudo systemctl restart nginx
|
||||
```
|
||||
|
||||
|
||||
Reference in New Issue
Block a user