57 lines
1.4 KiB
Markdown
57 lines
1.4 KiB
Markdown
# Deployment Guide for Mycelium Society Docs
|
|
|
|
This guide provides a deployment for serving the Mycelium Society documentation at `docs.mycelium.tf` by proxying to the existing content at `https://docs.ourworld.tf/mycelium_society/docs/`.
|
|
|
|
This allows users to access the docs via `docs.mycelium.tf` while the content is hosted elsewhere.
|
|
|
|
## Prerequisites
|
|
|
|
- Linux server with Caddy web server installed
|
|
- zinit service manager installed
|
|
- Root or sudo access
|
|
|
|
## Step 1: Configure Caddy
|
|
|
|
Update your Caddyfile to include the docs proxy:
|
|
|
|
```bash
|
|
# Edit the Caddyfile (adjust path to your Caddyfile location)
|
|
nano /root/code/github/despiegk/env_web/ourworld/ovh1_web_current/caddy/Caddyfile
|
|
```
|
|
|
|
Add or update:
|
|
|
|
```
|
|
import mycelium_docs.caddy
|
|
```
|
|
|
|
Create `mycelium_docs.caddy`:
|
|
|
|
```
|
|
docs.mycelium.tf {
|
|
reverse_proxy https://docs.ourworld.tf/mycelium_society/docs/ {
|
|
header_up Host docs.ourworld.tf
|
|
header_up X-Forwarded-Proto https
|
|
header_up X-Real-IP {remote}
|
|
header_up X-Forwarded-Host {host}
|
|
}
|
|
}
|
|
```
|
|
|
|
## Step 2: Reload Caddy
|
|
|
|
```bash
|
|
zinit restart caddy
|
|
```
|
|
|
|
## Monitoring
|
|
|
|
- Check Caddy status: `zinit list`
|
|
- View logs: `zinit log caddy`
|
|
- Access at `https://docs.mycelium.tf`
|
|
|
|
## Notes
|
|
|
|
- Ensure DNS for `docs.mycelium.tf` points to your server.
|
|
- The content is served from `https://docs.ourworld.tf/mycelium_society/docs/`, but users see `docs.mycelium.tf`.
|
|
- No additional build or cloning required; it's a reverse proxy setup. |