README
¶
dployr
Ship apps, not infrastructure.
Your server is ready the moment you sign up. Deploy from the CLI, GitHub Actions, or the dashboard. No SSH. No config files. On Pro, connect your own server.
What's in this repo
dployr is the CLI. It talks to Base, the hosted control plane.
dployrd is the daemon that runs on your server. It opens an outbound WebSocket to Base and executes deploy instructions on arrival. Your server never accepts inbound connections.
On Hobby and Indie plans, dployr provisions and manages the server. On Pro, you run dployrd on your own Linux server.
Install
curl -sSL https://raw.githubusercontent.com/dployr-io/dployr/master/install.sh | bash
Connect your own server (Pro)
curl -sSL https://raw.githubusercontent.com/dployr-io/dployr/master/install.sh \
| bash -s -- --token "<bootstrap-token>"
Get the bootstrap token from the Instances page in the dashboard: dployr.io/docs/byos
Deploy
dployr deploy --name my-api --runtime nodejs --port 3000
Common commands
dployr logs my-api --tail 100
dployr env set my-api KEY=value
dployr env list my-api
dployr domain add my-api yourdomain.com
dployr instances
dployr services
Full reference: dployr.io/docs/cli
Runtimes
Node.js, Python, Go, PHP, Ruby, .NET, Java, Static, Docker
Build
Requires Go 1.24+.
make build
Contributing
License
Apache 2.0
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
dployr
command
|
|
|
dployrd
command
|
|
|
internal
|
|
|
auth
Package auth implements token validation and auth middleware integration.
|
Package auth implements token validation and auth middleware integration. |
|
db
Package db offers utilities for managing the application's SQLite database, including initialization, schema migration, and embedded migration handling.
|
Package db offers utilities for managing the application's SQLite database, including initialization, schema migration, and embedded migration handling. |
|
logs
Package logs provides concrete implementations for log streaming functionality.
|
Package logs provides concrete implementations for log streaming functionality. |
|
proxy
Package proxy provides types and handlers for managing reverse proxy applications.
|
Package proxy provides types and handlers for managing reverse proxy applications. |
|
scripts
Package scripts embeds and exposes shell scripts required by the daemon for deployment, system management, and runtime integration.
|
Package scripts embeds and exposes shell scripts required by the daemon for deployment, system management, and runtime integration. |
|
service
Package service coordinates service management, lifecycle operations, and integration with other components of the daemon, such as deployment and proxy.
|
Package service coordinates service management, lifecycle operations, and integration with other components of the daemon, such as deployment and proxy. |
|
storage
Package storage implements block-device mounting for attached DO volumes.
|
Package storage implements block-device mounting for attached DO volumes. |
|
store
Package store provides concrete persistence implementations backing the persistence interfaces defined in pkg/store (currently SQLite).
|
Package store provides concrete persistence implementations backing the persistence interfaces defined in pkg/store (currently SQLite). |
|
stream
Package stream provides types and handlers for streaming application logs to clients.
|
Package stream provides types and handlers for streaming application logs to clients. |
|
system
Package system implements the daemon's system service: sync, install/upgrade, registration, and health.
|
Package system implements the daemon's system service: sync, install/upgrade, registration, and health. |
|
terminal
Package terminal provides WebSocket-based interactive terminal sessions.
|
Package terminal provides WebSocket-based interactive terminal sessions. |
|
version_resolver
Package version_resolver maps a runtime name and user-supplied version string to a Docker image reference.
|
Package version_resolver maps a runtime name and user-supplied version string to a Docker image reference. |
|
web
Package web provides the HTTP server and multiplexer for the daemon's web API.
|
Package web provides the HTTP server and multiplexer for the daemon's web API. |
|
worker
Package worker implements the daemon's background deployment worker, job queue, and concurrency management.
|
Package worker implements the daemon's background deployment worker, job queue, and concurrency management. |
|
pkg
|
|
|
auth
Package auth implements authentication primitives and middleware for the daemon's HTTP API.
|
Package auth implements authentication primitives and middleware for the daemon's HTTP API. |
|
core/deploy
Package deploy defines core deployment types, handlers, and orchestration interfaces used by the daemon for managing application deployments.
|
Package deploy defines core deployment types, handlers, and orchestration interfaces used by the daemon for managing application deployments. |
|
core/logs
Package logs provides types and interfaces for streaming application logs to clients.
|
Package logs provides types and interfaces for streaming application logs to clients. |
|
core/proxy
Package proxy provides types and handlers for managing reverse proxy applications.
|
Package proxy provides types and handlers for managing reverse proxy applications. |
|
core/service
Package service models services and provides HTTP handlers for service operations used by the daemon.
|
Package service models services and provides HTTP handlers for service operations used by the daemon. |
|
core/storage
Package storage handles block-device mounting tasks dispatched by base.
|
Package storage handles block-device mounting tasks dispatched by base. |
|
core/system
Package system defines the public contract for daemon-level operations in dployr.
|
Package system defines the public contract for daemon-level operations in dployr. |
|
core/terminal
Package terminal provides WebSocket-based interactive terminal sessions.
|
Package terminal provides WebSocket-based interactive terminal sessions. |
|
core/worker
Package worker defines the daemon's background deployment worker, job queue, and concurrency management.
|
Package worker defines the daemon's background deployment worker, job queue, and concurrency management. |
|
shared
Package shared provides configuration, logging, error helpers, and constants used across dployrd.
|
Package shared provides configuration, logging, error helpers, and constants used across dployrd. |
|
tasks
Package tasks models remotely-triggered actions and their results for dployr's distributed task system.
|
Package tasks models remotely-triggered actions and their results for dployr's distributed task system. |
|
version
Package version exposes build-time version metadata (version, commit, build date, Go runtime) for dployr binaries.
|
Package version exposes build-time version metadata (version, commit, build date, Go runtime) for dployr binaries. |
Click to show internal directories.
Click to hide internal directories.