Launch Command

sidekick launch

This command will launch a new application on you VPS. Sidekick will do most of the work for you. You can make your application reachable via your own domain or use a sslip.io domain out of the box to test things out.

Input

When running this command you will be prompted to enter the following:

• Url friendly name of your app - if you opt to use sslip.io domain for testing this would be your subdomain
• HTTP exposed port for your app to get requests - Sidekick will scan your docker file to try to extract this number and default to it.
• Domain at which you want this application to be reachable - If you choose your own domain make sure to point the domain to your VPS IP address; otherwise we default to sslip.io domain so you can play around.
• If you have any env file with secrets in it. Sidekick will attempt to find .env file in the root of your folder. Sidekick will use sops to encrypt your env file and inject the values securely at run time.

Should take around 2 more mins to be able to visit your application live on the web if all goes well.

Gotchas

• Make sure you can build and run the Dockerfile successfully before running this command.
• Sidekick will look for a file called Dockerfile in your project folder.
• Sidekick will save the docker image in a file and use scp to move that to your VPS then load it up. Make sure your VPS has enough space.
• During encryption Sidekick will use the public key stored in the global config during the setup stage.

What does Sidekick do when I run this?

• Build your docker image locally for linux
• Move the docker image to your VPS directly
• Encrypt your env file, if available and push it to your VPS
• Use sops to decrypt your env file and start and env with the values injected
• Spin up your docker image using docker compose and route traffic to it using Traefik on the specified port

Changelog

NA