Docs
Introduction
Get Started

Get Started

You can get started with Sidekick quickly as follows:

Installation

Using brew: (recommended) 

brew install sidekick
ℹ️
NOTE: Sidekick uses brew later on to handle installing sops and age on your local. So brew is a soft requirement at this point. Sidekick will throw an error if brew is not found. You can install brew from here.
I hate brew or I can’t install it

No problems. Sidekick currently has two dependencies and if you have them installed you don’t have to worry about brew. Make sure your machine has sops and age installed and added to path

Using binary directly

You can always download the latest binary from github releases page

Usage

Sidekick helps you along all the steps of deployment on your VPS. From basic setup to zero downtime deploys, we got you! ✊

First you need a VPS with Ubuntu LTS. I recommend DigitalOcean. Hetzner also gets very good reviews. You can host your own silicon too. As long as you have a public IP address you can use Sidekick.

Just make sure the following is true:

  • VPS running Ubuntu - LTS recommended
  • SSH Key available on your machine to login to VPS.

That’s it!

VPS Setup

You can simply run:

sidekick init

This command does a lot of things for you. Learn more init command

Launch a new application

Make sure you have a Dockerfile in your application folder that you can build and run succeffully. Navigate to your application folder and run:

sidekick launch

This command will prepare a docker image of your application and deploy it to your VPS. Learn more launch command

🎊 That’s it! Your app is live!

Your app is live and you can visit it with a sslip.io domain or any other domain you have specified during the setup.

This was the quick start guide. Make sure to go through the different commands to understand how they work. Remember, No Magic

What Is SidekickInit Command