/chief

Chief is an open-source solution to self-hosting your apps.

Primary LanguageTypeScriptApache License 2.0Apache-2.0

Chief

The open source deployment platform for your apps and services.
Website · Discord

GitHub Release Date

Chief is a deployment platform that allows you to deploy your apps and services to any cloud provider.

Installation

To get started, you'll need a clean VPS with atleast 4GB of RAM, around 30-50GB of disk space (depending on how many projects you'll host on it), 2 vCPUs, a public IP address, and a domain name pointing at your VPS such as hosting.example.com.

You need to SSH into your VPS as root, and run the following command:

curl -fsSL https://install.chiefdeploy.com | sudo bash

This will install Docker, Docker Compose, and the Chief CLI which will initialize Chief on your VPS. We recommend you enable automatic updates during the installation process.

Usage

Once Chief is installed, you'll be instructed to go to a URL (this will be your choosen domain for the Chief instance) and setup your instance.

After you've setup your instance, you should create a new source in the Sources tab on the dashboard, this will let Chief pull your GitHub repositories and build your projects.

Once you've created a source, you can create a new project by clicking the "New Project" button on the dashboard, this will let you create a new project from your GitHub repository.

Updating Chief

If the Chief CLI is already installed, you can update it by running the following command:

chief update

This will update Chief to the latest stable version.

Features

  • GitHub App Creation
  • Automatic Deployments
  • Nixpacks Support
  • Redis (Valkey) & Postgres Support
  • Deployment Notifications (Discord, Slack, Webhook's)
  • Remote Instances
  • Multi-region Deployments (instance groups)
  • Multi-factor authentication
  • Improved Log Viewer
  • Docker Log Reporting
  • Docker Terminal Access
  • Instance Metrics (Clickhouse ?)
  • Pausing Deployments
  • Improved Environment Variable Editor
  • Organization Management Features

If you'd like to work on any of these you can open up a pull request. If you need any further help feel free to contact me on our community Discord.

Community

If you have any questions or suggestions feel free to reach out on the community Discord: chiefdeploy.com/discord