Documentation

WeaveSignal is open-source software for a self-hosted internet radio station with the live studio built in: a room for presenters, guests and screened callers, the desk that mixes them, playout between shows, streams for listeners, a chat, show cards and podcast feeds, in one installation on your own server. The website says what it is in a page; these pages say how it works.

The pages are of four kinds (ADR-0072): a tutorial teaches by doing, a how-to guide gets one job done, reference describes what is there, and explanation says why. Studio words are explained in the glossary. What 1.0.0 does and leaves out is What release one does, and what it leaves out.

Start here

• Run a first show: the studio app against the real desk on your own machine, with a room of synthetic people from Kettle FM, the sample station.
• How the parts fit together: the processes, what each does, and why the people talking and the people listening run on two different clocks.

Presenters

• Get ready to present: joining, headphones and the microphone.
• Present from the keyboard: on air, cue, mute and talk.
• Take a caller to air: accept, decline or drop a caller the screener sends.
• Start on the count-in: the count-in, and taking turns with remote guests.
• When the lamp says PLAYOUT DOWN: what it means, and what to do.
• Echo and headphones: why presenters and guests wear headphones.

Screeners and station staff

• Screen callers: talk to callers off air and send them to the desk.
• Moderate the chat: reports, held messages and statements of reasons.
• Schedule the week: shows, automation blocks and corrections.
• Set the show clock and the rundown: the show, what is coming up, who was banned before.
• Add staff and sign in: accounts, roles and sign-in codes.
• Set retention: the jurisdiction presets, holds and the sweeper.
• Who hears whom: every route through the desk, by role.

Self-hosting

• Install a station with weavesignal.sh: the Compose bundle in one command.
• Publish a station from the Compose bundle: a reverse proxy with a certificate, TURN over TLS, and the ports to open.
• Install on Cloudron: the 1.0.0 package from its published image.
• Run a station as Podman Quadlets: systemd units generated from the bundle.
• Install the studio app on Linux and on Windows.
• Check a station’s ports: every port is a setting; find the free ones.
• Memory and CPU: what a station uses, and why live audio needs a server that is not overloaded.
• Run edges and Put Bunny in front of the station: for a big night.

Reference and explanation

• Glossary: the studio words.
• The desk’s panels by name, the keymap and the state vocabulary.
• Playout, the chat, the public pages and settings.
• Control plane routes and the API reference, generated from the code.
• Packages and install files and licences.
• What the lamp means: ON AIR, OPEN, AUTO and PLAYOUT DOWN.