Repository navigation
Kitsu
Kitsu (CGWire's review tool) is the record of every decision: one production per show, an episode per stream, a sequence per topic segment, a shot per clip and per Short. Clippa creates and fills all of it (Review); you provide a running Kitsu, a bot account for Clippa and a login per reviewer.
Kitsu is a Docker compose stack (Kitsu, the Zou API, Postgres, Redis, Meilisearch), the
mathbou/docker-cgwire one, pinned in
deploy/kitsu. Two scripts, the same stack:
-
On this machine (Docker Desktop or Docker Engine, no ssh):
bash deploy/kitsu/local.shputs the stack's files in~/kitsu(KITSU_DIR) and starts it on port 8090 (PORTindeploy/kitsu/env.local);KITSU_SUDO=sudoif your user can't talk to Docker. -
On a NAS or another host over ssh:
bash deploy/kitsu/deploy.sh, withKITSU_SSH_HOST(defaultnas),KITSU_DIRandKITSU_SUDO.
The first run writes deploy/kitsu/env.local with random secrets (gitignored; keep it, it is
the only copy of the database password). Rerunning either script updates the stack and runs
Zou's database upgrade; the data lives in named Docker volumes and survives.
Open http://<host>:8090. Sign in as the stack's default admin (admin@example.com /
mysecretpassword, from the docker-cgwire README), change that password straight away (your
avatar → Profile) or make your own admin account and remove the default one.
Clippa signs in as a bot. In Kitsu: Settings (the cog) → People → Bots → New bot, named
clippa, role Admin (it creates productions, task types and statuses); copy the token it
shows. Save it as the KITSU_TOKEN environment variable ([review] token_env) on every
machine that publishes or syncs; clippa setup asks for the address and the token and
checks them. In clipper.toml:
[review]
host = "http://<host>:8090/api" # the API URL, with /apiclippa doctor (online) signs in and reports the bot's name. The first clippa review publish creates the "Clipping" project template and the show's production (named after
[meta] show_name, or [review] project) with the task types, statuses and columns Clippa
uses; later publishes keep them up to date.
Each reviewer is a Kitsu person (People → New person) with their own login, added to the show's production (the production's Team). A Manager can set statuses and edit the columns; an Artist can comment. What they see and do is on Reviewing.
Statuses: approved (or done) approves, retake with a comment asks for a change (the
item is re-cut or re-covered and comes back), rejected drops it; anything else stays
pending. Columns on a segment (sequence) or clip (shot): YouTube title, YouTube description,
Hashtags, Tags and Playlist (what clippa upload sends), Hook, Category, Score and Found by
(how the clip was chosen; on a segment, Score is its segment score,
shown only), Layout (a Short's crop), Other voices (seconds of voices that aren't
the show's own), Tightened (the pauses cut out of a Short, Pipeline),
Publish at (your pin), Hold, Scheduled (the slot Clippa gave it) and
Thumbnail text (the cover's words; a sync re-renders the cover). Clippa fills a column when it
is empty or still shows what Clippa wrote last, never over an edit of yours, and clippa review sync reads them back.
Home · Getting started · clippa doctor · These pages are built from docs/wiki/ in the repo, so edits made here are overwritten: how to edit them
Run it
- Overview
- Getting started
- Roles and services
- Configuration
- Pipeline
- Review
- Reviewing
- War room
- Clippa messenger
- Scheduling and uploads
- Costs
- Checkup
- Audit
- Backups
Install
- Install
- Install checklist
- Kitsu
- Discord app
- YouTube sign-in
- Windows
- macOS
- Transcribe on Modal
- NAS recorder
- NAS hub
- Claude on the NAS
- Phone access
- Model providers
- Adding a show
- YouTube channel
Features
- Pre-shows
- Fetching VODs
- Speakers
- Faces
- Covers
- Cast library
- B-roll
- Clip art
- Weekly issue
- X posts
- TikTok
- News watcher
- Character pieces
- Documentaries
Research
Working on Clippa