Skip to main content

Getting started

edox-ops manages documentation projects on a VPS: metadata in /etc/edox-ops/projects.json, published trees under /var/www/docs/<slug>/, and nginx vhosts generated as edox-ops-<slug>.

Typical lifecycle​

  1. Prepare the host: edox-ops bootstrap --yes
  2. Verify readiness: edox-ops doctor
  3. Register a project: edox-ops project add …
  4. Create served directories: edox-ops project init <slug>
  5. Publish content: edox-ops project deploy <slug>
  6. Enable the site: edox-ops project enable <slug>
  7. Validate: edox-ops project validate <slug>

Example​

edox-ops bootstrap --yes
edox-ops doctor
edox-ops project add my-docs --domain docs.example.com
edox-ops project init my-docs
edox-ops project deploy my-docs --source /path/to/static/site
edox-ops project enable my-docs
edox-ops project validate my-docs

Deploy reads from a directory on the host (or CI artifact path) and rsyncs into the project root_path. Pre-deploy backups are stored under /var/www/docs/.edox-ops-backups/<slug>/.

Next steps​