This guide is for the people who install and run Depotex: platform and infrastructure engineers, Depotex super admins and organization admins, and security teams. People who publish and download packages need the user guide instead. Pages both need, such as spaces, API tokens, SBOMs and the changelog, are in both guides.
1. From nothing to production
- Plan — Choose single server or cluster, size PostgreSQL, Redis and storage, and open the network paths. Plan an installation
- Install — On Kubernetes with the Helm chart, or from the container images or the server program (Install Depotex). Behind a reverse proxy, route /api/ws to the server.
- License — Read the installation ID and request a license from Vectored (Get a license).
- Set up — In the setup wizard, or without the UI from a YAML file.
- Configure — The Depotex address, email, directories and single sign-on, storage, rate limits (Settings reference).
- Secure — Work through the production checklist, and subscribe to security advisories.
- Operate — Backups and test restores, the system check, monitoring, alerts and upgrades.
2. Who administers what
| Role | Can | Typical person |
|---|---|---|
| Super admin | Everything: installation settings, license, storage, backups, every space and repository, plugins | Platform team |
| Organization admin | People, groups, roles and policies of their organization; organization-level settings | Team or department lead |
| Space Owner / Maintainer | A space's repositories, members, upload rules, cleanup and tags | Team that owns the packages |
| Operator (no Depotex role) | The servers, PostgreSQL, Redis, storage, the reverse proxy and the environment | Infrastructure / SRE |
What each role may do comes from its permissions; Users & Directories lists them, and each feature's page names the permission it needs. How access fits together shows how directories, system roles, groups, space roles and repository roles combine, with a worked example.
3. In this guide
| Section | Pages |
|---|---|
| Install | Plan an installation · Install Depotex · Install with Helm · Docker & Kubernetes · Single Node & Cluster · Environment variables |
| Set up | Setup wizard · Set up without the UI · Licensing · Recovery Mode |
| Configure | Settings reference · How access fits together · Users & Directories · Single Sign-On · OAuth Applications · API Tokens · Rate Limits · Storage · Email · Branding |
| Repositories | Spaces · Repositories · Upstreams · Repository settings |
| Security | Production checklist · Quarantine · Block list · Integrity · SBOMs · Vibe artifacts · Policies · Logging & Audit · Security advisories |
| Operate | System Check · Alert Tuning · Monitoring · Backups · Upgrades · Scheduled Jobs · Managing Alerts · Events · Automation · Plugins |
| Help | Known issues · FAQ · Support · Changelog |
4. Getting help
Licenses, renewals and questions: vectored.dev/#contact or support@vectored.dev. For a problem with a running installation, see Support for what to send so it can be answered the first time.