chore(docs): update docs for correct use of shell and console and enforce linewidth (#9245)

This commit is contained in:
Muhammad Atif Ali
2023-08-23 12:27:57 +03:00
committed by GitHub
parent ed2b1236c0
commit d37f6d80f7
96 changed files with 2838 additions and 1457 deletions
+13 -13
View File
@@ -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
```