fmt: prettier formatting

coder · bpmct · Feb 15, 2023 · Feb 13, 2023 · Feb 13, 2023 · Feb 13, 2023
commit 7d28e51b71a51407a3a8173c501bbd4817c7c8d8
diff --git a/examples/web-server/nginx/README.md b/examples/web-server/nginx/README.md
@@ -2,37 +2,39 @@
 
 ## Requirements
 
-1. Start a Coder deployment with a wildcard subdomain. See [this guide](https://coder.com/docs/coder/v1.20/setup/installation#step-1-create-a-subdomain) for more information.
-1. You'll need a subdomain and the a wildcard subdomain configured that resolves to server's public ip.
+1. Start a Coder deployment with a wildcard subdomain. See [this guide](https://coder.com/docs/v2/latest/admin/configure#wildcard-access-url) for more information.
-1. Start a Coder deployment with a wildcard subdomain. See [this guide](https://coder.com/docs/v2/latest/admin/configure#wildcard-access-url) for more information.
+1. Start a Coder deployment and be sure to set the following [configuration values](https://coder.com/docs/v2/latest/admin/configure):
+
+    ```console
+    CODER_HTTP_ADDRESS=127.0.0.1:3000
+    CODER_ACCESS_URL=https://coder.example.com
+    CODER_WILDCARD_ACCESS_URL=*coder.example.com
+    ```
+
+    Throughout the guide, be sure to replace `coder.example.com` with the domain you intend to use with Coder.
-1. Start a Coder deployment with a wildcard subdomain. See [this guide](https://coder.com/docs/v2/latest/admin/configure#wildcard-access-url) for more information.
+1. Start a Coder deployment and be sure to set the following [configuration values](https://coder.com/docs/v2/latest/admin/configure):
+
+    ```console
+    CODER_HTTP_ADDRESS=127.0.0.1:3000
+    CODER_ACCESS_URL=https://coder.example.com
+    CODER_WILDCARD_ACCESS_URL=*coder.example.com
+    ```
+
+    Throughout the guide, be sure to replace `coder.example.com` with the domain you intend to use with Coder.
+
+2. You'll need a subdomain and the a wildcard subdomain configured that resolves to server's public ip.
+
    > For example, to use `coder.example.com` as your subdomain, configure `coder.example.com` and `*.coder.example.com` to point to your server's public ip. This can be done by adding A records in your DNS provider's dashboard.
 
-2. Install NGINX (assuming you're on Debian/Ubuntu):
+3. Install NGINX (assuming you're on Debian/Ubuntu):
 
-    ```console
-    sudo apt install nginx
-    ```
+   ```console
+   sudo apt install nginx
+   ```
 
-3. Stop NGINX service:
+4. Stop NGINX service:
 
-    ```console
-    sudo systemctl stop nginx
-    ```
+   ```console
+   sudo systemctl stop nginx
+   ```
 
 ## Adding Coder deployment subdomain
 
 > This example assumes Coder is running locally on `127.0.0.1:3000` for the subdomain `YOUR_SUBDOMAIN` e.g. `coder.example.com`.
 
 1. Create NGINX configuration for this app:
 
-    ```console
-    sudo touch /etc/nginx/sites-available/YOUR_SUBDOMAIN
-    ```
+   ```console
+   sudo touch /etc/nginx/sites-available/YOUR_SUBDOMAIN
+   ```
 
 2. Activate this file:
 
-    ```console
-    sudo ln -s /etc/nginx/sites-available/YOUR_SUBDOMAIN /etc/nginx/sites-enabled/YOUR_SUBDOMAIN
-    ```
+   ```console
+   sudo ln -s /etc/nginx/sites-available/YOUR_SUBDOMAIN /etc/nginx/sites-enabled/YOUR_SUBDOMAIN
+   ```
 
 ## Install and configure LetsEncrypt Certbot
 
@@ -41,69 +43,70 @@
 ## Create DNS provider credentials
 
 1. Create an API token for the DNS provider you're using: e.g [CloudFlare](https://dash.cloudflare.com/profile/api-tokens) with the following permissions:
-      - Zone - DNS - Edit
+
+   - Zone - DNS - Edit
 
 2. Create a file in `.secrets/certbot/cloudflare.ini` with the following content:
 
-    ```ini
-    dns_cloudflare_api_token = YOUR_API_TOKEN
-    ```
+   ```ini
+   dns_cloudflare_api_token = YOUR_API_TOKEN
+   ```
 
 3. Set the correct permissions:
 
-    ```console
-    sudo chmod 600 ~/.secrets/certbot/cloudflare.ini
-    ```
+   ```console
+   sudo chmod 600 ~/.secrets/certbot/cloudflare.ini
+   ```
 
 ## Create the certificate
 
 1. Create the wildcard certificate:
 
-    ```console
-    sudo certbot certonly --dns-cloudflare --dns-cloudflare-credentials ~/.secrets/certbot/cloudflare.ini -d coder.example.com -d *.coder.example.com
-    ```
+   ```console
+   sudo certbot certonly --dns-cloudflare --dns-cloudflare-credentials ~/.secrets/certbot/cloudflare.ini -d coder.example.com -d *.coder.example.com
+   ```
 
 ## Configure nginx
-## Configure nginx
+## Configure NGINX
-## Configure nginx
+## Configure NGINX
 
 1. Edit the file with:
 
-    ```console
-    sudo nano /etc/nginx/sites-available/YOUR_SUBDOMAIN
-    ```
+   ```console
+   sudo nano /etc/nginx/sites-available/YOUR_SUBDOMAIN
+   ```
 
 2. Add the following content:
 
-    ```nginx
-    server {
-        server_name YOUR_SUBDOMAIN *.YOUR_SUBDOMAIN;
-
-        # HTTP configuration
-        listen 80;
-        listen [::]:80;
-
-        # HTTP to HTTPS
-        if ($scheme != "https") {
-            return 301 https://$host$request_uri;
-        }
-
-        # HTTPS configuration
-        listen [::]:443 ssl ipv6only=on;
-        listen 443 ssl;
-        ssl_certificate /etc/letsencrypt/live/YOUR_SUBDOMAIN/fullchain.pem;
-        ssl_certificate_key /etc/letsencrypt/live/YOUR_SUBDOMAIN/privkey.pem;
-
-        location / {
-            proxy_pass  http://127.0.0.1:3000; # Change this to your coder deployment port default is 3000
-            proxy_http_version 1.1;
-            proxy_set_header Upgrade $http_upgrade;
-            proxy_set_header Host $host;
-            proxy_set_header X-Real-IP $remote_addr;
-            proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
-            proxy_set_header X-Forwarded-Proto $http_x_forwarded_proto;
-            add_header Strict-Transport-Security "max-age=15552000; includeSubDomains" always;
-        }
-    }
-    ```
+   ```nginx
+   server {
+       server_name YOUR_SUBDOMAIN *.YOUR_SUBDOMAIN;
+
+       # HTTP configuration
+       listen 80;
+       listen [::]:80;
+
+       # HTTP to HTTPS
+       if ($scheme != "https") {
+           return 301 https://$host$request_uri;
+       }
+
+       # HTTPS configuration
+       listen [::]:443 ssl ipv6only=on;
+       listen 443 ssl;
+       ssl_certificate /etc/letsencrypt/live/YOUR_SUBDOMAIN/fullchain.pem;
+       ssl_certificate_key /etc/letsencrypt/live/YOUR_SUBDOMAIN/privkey.pem;
+
+       location / {
+           proxy_pass  http://127.0.0.1:3000; # Change this to your coder deployment port default is 3000
+           proxy_http_version 1.1;
+           proxy_set_header Upgrade $http_upgrade;
+           proxy_set_header Host $host;
+           proxy_set_header X-Real-IP $remote_addr;
+           proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+           proxy_set_header X-Forwarded-Proto $http_x_forwarded_proto;
+           add_header Strict-Transport-Security "max-age=15552000; includeSubDomains" always;
+       }
+   }
+   ```
 
 > Don't forget to change:
 >
@@ -113,22 +116,22 @@
 
 1. Create a new file in `/etc/cron.weekly`:
 
-    ```console
-    sudo touch /etc/cron.weekly/certbot
-    ```
+   ```console
+   sudo touch /etc/cron.weekly/certbot
+   ```
 
 2. Make it executable:
 
-    ```console
-    sudo chmod +x /etc/cron.weekly/certbot
-    ```
+   ```console
+   sudo chmod +x /etc/cron.weekly/certbot
+   ```
 
 3. And add this code:
 
-    ```sh
-    #!/bin/sh
-    sudo certbot renew -q
-    ```
+   ```sh
+   #!/bin/sh
+   sudo certbot renew -q
+   ```
 
 ## Restart NGINX