Skip to main content

Introduction

edox-ops is a production-oriented Python CLI for preparing and operating Ubuntu 24.04 LTS, Debian 12+, or Debian derivatives such as Raspberry Pi OS on VPS or edge hosts that serve documentation with nginx, rsync deploys, and optional GitLab Runner registration. The CLI detects the distribution from /etc/os-release and tailors apt actions accordingly.

This site is the public product documentation layer. It covers how to install, configure, and run edox-ops on your infrastructure.

What you will find here​

  • Getting started — concepts and first commands
  • Installation — install from PyPI, development checkout, host prerequisites
  • Architecture — how CLI modules map to on-host layout
  • Operations — projects, deploy, TLS, and hardening

API reference​

Python module and class documentation is maintained separately with Sphinx and published under API reference. Start there when you need details on edox_ops modules, not when you need operator guides.

Contributing​

Start with Contributing — how to join the GitLab project, set up Python and pre-commit, and use Cursor AI (recommended) for low-friction changes.

Contributor guides​

Commit message rules, GitLab CI, SSH setup, and package release are published under Contributor guides in this documentation site.