Serve the documentation

The compose file builds this documentation into its own container, consent-docs. It listens on port 8081. Give it its own hostname, such as docs.example.in.

Publish it#

Add its address to .env, next to your other public addresses.
.envConfig
```
DOCS_SITE_URL=https://docs.example.in
```

Point the hostname at your proxy, end TLS there and send it to port 8081.

docs.example.in.confnginx

server {
  listen 443 ssl;
  server_name docs.example.in;

  ssl_certificate     /etc/ssl/docs.example.in/fullchain.pem;
  ssl_certificate_key /etc/ssl/docs.example.in/privkey.pem;

  location / {
    proxy_pass http://127.0.0.1:8081;
    proxy_set_header Host $host;
  }
}

Build the console and the documentation again, and start them.
Shell
```
docker compose up -d --build consent-web consent-docs
```

The build runs the documentation's own checks first. If one fails, the image is not built and the running site stays as it was.

What the address changes#

The console shows a Documentation link on the Install page and beside dashboard measures.
Every page gets a canonical link, and the site gets sitemap.xml and robots.txt.
Examples show your PUBLIC_API_URL, and Open console leads to your UI_URL.

To publish on another port, set DOCS_HOST_PORT.

Publish it#

What the address changes#

Related#