https://github.com/dployr-io/dployr-base
Your app, your server, your rules!
https://github.com/dployr-io/dployr-base
deployment self-hosted server-setup
Last synced: 29 days ago
JSON representation
Your app, your server, your rules!
- Host: GitHub
- URL: https://github.com/dployr-io/dployr-base
- Owner: dployr-io
- License: apache-2.0
- Created: 2025-10-08T14:57:14.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2026-01-06T15:30:20.000Z (about 1 month ago)
- Last Synced: 2026-01-08T18:46:46.336Z (about 1 month ago)
- Topics: deployment, self-hosted, server-setup
- Language: TypeScript
- Homepage: http://api-docs.dployr.io/
- Size: 561 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Dployr Base
This is the control plane for [dployr](https://github.com/dployr-io/dployr).
Self-host your control plane for restricted networks or custom requirements.
---
## Quick start (self‑hosting)
### Option 1: Docker (simple, recommended)
```bash
# Download example compose file
curl -fsSL https://raw.githubusercontent.com/dployr-io/dployr-base/main/docker-compose.example.yml -o docker-compose.yml
# Edit a few values (domains, OAuth keys, etc.)
nano docker-compose.yml
# Start
docker compose up -d
```
Base will be available on `http://localhost:7878` by default.
See [DOCKER.md](./DOCKER.md) for more examples.
### Option 2: Shell installer (no Docker)
```bash
# Basic install
curl -fsSL https://raw.githubusercontent.com/dployr-io/dployr-base/refs/heads/main/install.sh \
| sudo bash -s --
# Example with Upstash Redis
curl -fsSL https://raw.githubusercontent.com/dployr-io/dployr-base/refs/heads/main/install.sh \
| sudo bash -s -- \
--kv-type upstash \
--kv-rest-url "https://your-db.upstash.io" \
--kv-rest-token "your-token"
# Or from a config file (remote script)
curl -fsSL https://raw.githubusercontent.com/dployr-io/dployr-base/refs/heads/main/install.sh \
| sudo bash -s -- --config /path/to/config.toml
# Start the service
sudo systemctl start dployr-base
```
---
## Config basics
Self‑hosted setups share the same `config.toml` layout:
```toml
[database]
url = "postgresql://user:password@localhost:5432/dployr"
[kv]
type = "redis"
url = "redis://localhost:6379"
[storage]
type = "filesystem"
path = "/var/lib/dployr-base/storage"
```
See `config.example.toml` for all fields.
---
## Development
```bash
npm run dev
```
---
## Links
- Self‑hosting guide: https://docs.dployr.io/installation/self-hosting
License: Apache 2.0