Skip to main content

​
Quickstart

This guide will help you get a working Kitsu instance running quickly using Docker. You’ll be ready to explore the platform in just a few minutes.

​
Prerequisites

Before you begin, ensure you have Docker installed on your system:

​
Installation steps

1

Start the Kitsu Docker container

Run the CGWire Docker image, which includes Kitsu and all its dependencies:
docker run -d --rm -p 80:80 --name cgwire cgwire/cgwire
This command:
  • Runs the container in detached mode (-d)
  • Maps port 80 to your local machine
  • Names the container cgwire for easy reference
  • Automatically removes the container when stopped (--rm)
The container includes both the Kitsu frontend and the Zou API backend, providing a complete production management system.
2

Access Kitsu

After 30 seconds or so for the container to fully start, open your web browser and navigate to:
http://localhost
You should see the Kitsu login page.
If you’re using Docker Machine, replace localhost with your Docker Machine IP address. You can find it by running docker-machine ip.
3

Log in to Kitsu

Use the default administrator credentials to log in:
Change the default password immediately after your first login for security purposes.
4

Create your first production

Once logged in:
  1. Click on the Productions menu in the top navigation
  2. Click the New Production button
  3. Fill in the production details:
    • Name: Your production name
    • Type: Feature Film, TV Show, Short, or other
    • Status: Active or archived
  4. Click Create to set up your production
You can customize your production structure with episodes, sequences, shots, and assets based on your project needs.
5

Explore the interface

Navigate through the main sections:
  • Productions: Manage your projects and switch between them
  • Assets: Track 3D models, textures, rigs, and other production assets
  • Shots: Organize sequences and individual shots
  • Tasks: Assign work to team members and track progress
  • Team: Manage users and permissions
  • Schedule: View production calendar and deadlines

​
Next steps

Now that you have Kitsu running, you can:

Add team members

Invite your team by creating user accounts with appropriate roles and permissions.

Set up your pipeline

Configure task types and workflows that match your studio’s production pipeline.

Import assets

Use the CSV import feature to bulk-import existing assets and shots.

Configure notifications

Set up email notifications and real-time updates to keep your team informed.

​
Managing the container

Here are some useful Docker commands for managing your Kitsu instance: 
docker stop cgwire

​
Need help?

If you encounter any issues:
This quickstart uses Docker for simplicity. For production deployments, consider setting up a proper database, configuring environment variables, and implementing backups. See the Installation guide for production-ready configurations.

Build docs developers (and LLMs) love

Get started for freeTalk to us