kennethreitz
43fe443574
- README + CLAUDE.md: server access, API usage, conventions - docs/server.md: specs and core stack (Dokploy v0.29.7, Traefik, Swarm) - docs/inventory.md: deployed apps, starting with httpbin - scripts/api.sh: Dokploy API wrapper Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
47 lines
1.5 KiB
Markdown
47 lines
1.5 KiB
Markdown
# mercury
|
|
|
|
Documentation and management repo for the **Dokploy** instance running at:
|
|
|
|
> https://mercury.kennethreitz.org/dashboard/home
|
|
|
|
## What is this?
|
|
|
|
[Dokploy](https://dokploy.com) is a self-hosted PaaS (Heroku/Vercel-style) running on
|
|
this server. This repo is the source of truth for:
|
|
|
|
- **Inventory** — what projects, applications, databases, and Docker Compose stacks
|
|
are deployed on the instance
|
|
- **Configuration** — domains, environment variable layouts (not secrets), volumes,
|
|
backups, and deployment settings
|
|
- **Runbooks** — how to deploy, roll back, restore backups, and recover the instance
|
|
- **Automation** — scripts that talk to the Dokploy API for routine management
|
|
|
|
## Server
|
|
|
|
| | |
|
|
|---|---|
|
|
| IP | `5.161.122.181` (Hetzner) |
|
|
| SSH | `ssh root@mercury.kennethreitz.org` (key auth) |
|
|
| Dokploy UI | https://mercury.kennethreitz.org |
|
|
| Dokploy API | https://mercury.kennethreitz.org/api (requires `x-api-key` header) |
|
|
| Direct (fallback) | http://5.161.122.181:3000 |
|
|
|
|
Full specs and stack details: [docs/server.md](docs/server.md)
|
|
|
|
## Layout
|
|
|
|
```
|
|
docs/ # documentation about the setup (inventory, runbooks)
|
|
scripts/ # management scripts using the Dokploy API
|
|
```
|
|
|
|
## API access
|
|
|
|
The Dokploy API is authenticated with an API key generated in the dashboard under
|
|
**Settings → API/CLI**. Scripts in this repo expect it in the `DOKPLOY_API_KEY`
|
|
environment variable (or a local untracked `.env` file). **Never commit the key.**
|
|
|
|
```sh
|
|
curl -H "x-api-key: $DOKPLOY_API_KEY" https://mercury.kennethreitz.org/api/project.all
|
|
```
|