Canine.sh
  • Canine Documentation
  • Getting Started
    • Quickstart
      • (Optional) Install Canine locally
      • Set up a Kubernetes cluster
      • Connect a Github project
      • Create your first service
      • Deploy a Redis database
      • Preview the app with a private connection
      • Configure DNS & LetsEncrypt SSL certificate
  • Basics
    • Clusters
    • Projects
      • Services
        • Web Services
        • Background Workers
        • Cron Jobs
      • Processes & one off pods
      • Volumes
    • Add Ons
    • Integrations
  • Technical Details
    • Canine Architecture
    • Kubernetes Crash Course
      • Introduction
      • Containers & Pods
      • Deployments
      • Namespaces
      • Services
      • Ingress
  • Canine
  • Our Manifesto
Powered by GitBook
On this page
  1. Getting Started
  2. Quickstart

(Optional) Install Canine locally

PreviousQuickstartNextSet up a Kubernetes cluster

Last updated 23 days ago

If you're using the cloud version of Canine, you can skip this.

Make sure you have docker compose installed on your local machine before continuing. Make sure you can run docker compose successfully before continuing.

Canine can be installed locally by running

curl -sSL https://raw.githubusercontent.com/czhu12/canine/refs/heads/main/install/install.sh | bash

Navigate to http://localhost:3456 and you should see a welcome page, and a prompt to add your Github token.

Go to your Github profile's tokens page, and click Generate new token (classic). Give your token a name and make sure to select the permissions repo, write:packages, and delete:packages

Copy the token into your local Canine instance, and you're good to go!