1.5 KiB
1.5 KiB
Deployment Guide for Mycelium Society Docs
This guide provides a deployment for serving the Mycelium Society documentation at docs.mycelium.tf
.
We build the docs website with hero docusaurus then we serve directly from files.
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 serving:
# 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 {
root * /root/hero/www/info/mycelium_society
encode gzip
try_files {path} {path}/ /index.html
file_server
}
Step 2: Reload Caddy
zinit restart caddy
Building and Publishing Docs
Users can build and publish the docs using:
hero docusaurus -path ~/code/git.ourworld.tf/tfgrid/docs_tfgrid4/ebooks/mycelium_society -d
This builds the Docusaurus site and deploys it to /root/hero/www/info/mycelium_society
.
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 directly from static files at
/root/hero/www/info/mycelium_society
. - Build and deploy using the hero command above.