Repository navigation
Install checklist
A by-hand pass over a new install, for what the sandbox runs can't reach. Those run the bootstrap in clean Windows Sandbox and Ubuntu machines from an answers file, offline and with no keys. This pass covers the prompts, real keys, the online checks, the real folders and some real work. Note whatever trips you up: that's what the pass is for.
There are two kinds of install, and some checks differ:
- Join the hub: another machine for the running install (the Mac as a control station, a second worker). It shares the NAS config, streams and schedule.
-
New install: a stack of its own with its own config, streams, schedule, YouTube channel
and Discord bot, such as the desktop as the second channel (#46). Never point one at the live
share's
clipper.toml, streams or schedule: its uploads and review cards would mix with Lolcow Cinema's.
The walkthrough explains each step. This page is the list to tick.
- Join: the NAS share is mounted (
\\<nas>\docker\clipperon Windows, under/Volumeson a Mac). - New: a streams folder of its own, on a disk with room (~20-30 GB per stream).
- Keys at hand: Anthropic, the Kitsu bot token, the Modal token id and secret (a worker on Modal), the Discord bot token (bot role only; a new install needs its own Discord bot app, since two bots can't share one token).
- The code is in a short folder:
C:\clipperor~/clipper.
Run it with no answers file, so every question is asked. On a machine that's already set up,
setup skips the steps it has done: pass --step <name> to the bootstrap (or
clippa setup --step <name>) to go through one again (mode, roles, machine, keys,
check).
- Each question makes sense, and its default is the answer you'd give.
- Join: give the share's
clipper.tomlby typing its path, or drag the file in. Setup offers to use it in place (the default on a share). - New: setup writes a starter
clipper.tomlin the checkout. - Roles: pick what this machine will really run. If setup stops to install packages, the bootstrap carries on by itself.
- Streams folder: the share's streams folder (join) or this install's own (new). Setup checks it's writable.
- Encoder: the GPU's own (NVENC on an NVIDIA machine, VideoToolbox on a Mac), not libx264.
- Keys: type one wrong on purpose; it's refused with a reason. The right ones are accepted. Press Enter at the Kitsu token on a worker: it asks again, not skips.
- Linux only: accept Microsoft's font license when it asks.
- It ends with "Ready" and what to run next.
- In a new terminal,
clippa --helpworks from any folder. -
clippa doctor --role <role>with no--offlineshows 0 failures. The online checks reach Kitsu, Modal (a worker on Modal), and for a control station the hub over ssh and the war room. -
clippa setup --checkshows every step done. - Join: no
clipper.tomlin the checkout, andclipper.local.tomlholds only this machine's values. - New:
[paths]streams, schedule and youtube_token in itsclipper.tomlpoint at this install's own files, not the share. - Mac worker: doctor's ffmpeg
subtitles(libass) check passes. Homebrew's plainffmpeglacks it: follow doctor'sffmpeg-fullhint.
Join: don't start clippa worker, clippa serve or clippa bot unattended here. The
hub's containers already run them, and their single-instance locks don't see
another machine. Try things by hand instead. A new install runs its own serve, bot and worker,
once the steps below and the ones in the next section are done.
- Worker: re-render one Short on the test stream:
clippa shorts kick-131151926 --items v01 --force. A new install needs a copy of that stream folder in its own streams folder first. That one command exercises the encoder, the caption font and libass, and it reuses the saved layout, so no model call is expected. Watch the result. - Worker on Modal: if doctor says the Modal app isn't deployed, run
clippa transcribe --deploy(several minutes, once per Modal account). - Control:
clippa services statuslists serve, the bot, the worker and the recorder. - The war room opens in a browser.
Join: these already live in the shared config, so there's nothing to redo.
New: each needs doing by hand:
- Kitsu and Clippa's account on it (Kitsu).
- The Discord bot app and its ids (Discord app).
- The YouTube sign-in to the new channel,
clippa upload --sign-in(YouTube sign-in). - The shows, each with its own Kitsu production (Adding a show).
Each confusing question, wrong default or error without a fix goes into an issue (or the HANDOFF), so the next install doesn't hit it.
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