The WeaveSignal contributors
fd4d654e81
/features/ lists 41 features in eight groups, each with what it does for a station and its documentation page, with the demo's clips beside them, and a separate Coming next section for what is not in 1.0.0 (the DJ overlap handover, WHIP, the presenter kit, a telephone line, macOS).
61 lines
5 KiB
Text
61 lines
5 KiB
Text
# WeaveSignal
|
|
|
|
> WeaveSignal is open-source (AGPL-3.0-only) software for a self-hosted internet radio or video station with the live studio built in: a LiveKit room for presenters, guests and screened callers; a desk (Rust, gstreamer-rs) that mixes the programme and a mix-minus for each person; playout through one fixed Liquidsoap 2.5 script; listener streams (Ogg Opus, an optional MP3 stream, HLS with video) from Liquidsoap's icecast.server; a live chat; show cards and podcast feeds; one installation on your own server. Release 1.0.0 was published on 2026-11-04. The website is at / and the documentation under /docs/. Documentation text is CC BY-SA 4.0; code samples are AGPL-3.0-only.
|
|
|
|
## The website
|
|
|
|
- [Home](/): what it is, the demo station, the status of 1.0.0, the eight strongest features, who uses what, the two latencies, a short comparison, how to run it, eight questions
|
|
- [Features](/features/): what 1.0.0 does for a station, in eight groups with the page that explains each, and what is planned and not in 1.0.0
|
|
- [Compare](/compare/): WeaveSignal against the stack of tools a station combines today, by job, with sources and the date read
|
|
- [Questions](/faq/): cost, hardware, players and relays, macOS, packaging, chat, AzuraCast, readiness, telephones, hosting, help, versioning
|
|
- [Run your own station](/run/): the one-line script, Cloudron and Quadlets, and the studio app's downloads
|
|
|
|
## Status
|
|
|
|
- [What release one does, and what it leaves out](/docs/reference/release-one-status/): 1.0.0, what is in it, what is not, the known limits, what was measured
|
|
|
|
## Documentation
|
|
|
|
- [Overview](/docs/): the pages by reader
|
|
- [Glossary](/docs/reference/glossary/): the studio words in plain language
|
|
- [Run a first show](/docs/tutorials/first-show/): the studio app against the real desk on one machine, with synthetic people
|
|
- [How the parts fit together](/docs/explanation/architecture/): the processes, and why two latencies
|
|
|
|
## How-to guides: presenters
|
|
|
|
- [Get ready to present](/docs/how-to/get-ready/): joining, headphones, the microphone's browser settings
|
|
- [Present from the keyboard](/docs/how-to/present-from-the-keyboard/): on air, cue, mute, held talk
|
|
- [Take a caller to air](/docs/how-to/take-a-caller/): accept with Cue, decline with Esc, drop with Ctrl+D twice
|
|
- [Start on the count-in, and take turns](/docs/how-to/count-in/): talkback from the producer or screener; the delay with remote guests
|
|
- [When the lamp says PLAYOUT DOWN](/docs/how-to/playout-down/): the room is alive, listeners hear nothing; restart playout
|
|
|
|
## How-to guides: screeners and station staff
|
|
|
|
- [Screen callers](/docs/how-to/screen-callers/): hold T to talk, P to send, the chat modes
|
|
- [Moderate the chat](/docs/how-to/moderate-the-chat/): reports, held messages, statements of reasons
|
|
- [Schedule the week](/docs/how-to/schedule-the-week/): shows, automation blocks, corrections
|
|
- [Add staff and sign in](/docs/how-to/add-staff/): accounts, roles, sign-in codes
|
|
- [Set retention](/docs/how-to/set-retention/): jurisdiction presets, holds
|
|
- [Give someone a room token](/docs/how-to/issue-room-tokens/): short-lived tokens with a role
|
|
- [Set the show, the rundown and the banned list](/docs/how-to/set-the-show/)
|
|
|
|
## How-to guides: self-hosting
|
|
|
|
- [Install a station with weavesignal.sh](/docs/how-to/install-with-weavesignal-sh/): the Compose bundle in one command; secrets made locally, free ports, uninstall keeps the data
|
|
- [Publish a station from the Compose bundle](/docs/how-to/publish-with-compose/): a reverse proxy with a certificate, TURN over TLS, the ports to open
|
|
- [Install on Cloudron](/docs/how-to/install-on-cloudron/): the 1.0.0 package from its published image; TURN over TLS on 15349; 1.5 GiB
|
|
- [Run a station as Podman Quadlets](/docs/how-to/run-with-quadlets/): units generated from the Compose bundle, secrets as Podman secrets
|
|
- [Run the loopback stack with Compose](/docs/how-to/run-with-compose/): every listener on loopback, for development
|
|
- [Install the studio app on Linux](/docs/how-to/install-studio-linux/): AppImage, .deb or .rpm; checksums; the Wayland setting
|
|
- [Install the studio app on Windows](/docs/how-to/install-studio-windows/): the unsigned installer, its checksum, SmartScreen
|
|
- [Check a station's ports](/docs/how-to/check-ports/): the free-port check and what to change
|
|
- [Memory and CPU](/docs/reference/resources/): measured on a workstation, a dedicated server and a shared one
|
|
|
|
## Reference
|
|
|
|
- [Roles](/docs/reference/roles/): the seven roles and what each can do
|
|
- [Who hears whom](/docs/reference/who-hears-whom/): the desk's routes and gates by role
|
|
- [The state vocabulary](/docs/reference/states/): the fifteen state words
|
|
- [Playout](/docs/reference/playout/), [The chat](/docs/reference/chat/), [The public pages](/docs/reference/public-pages/), [Settings](/docs/reference/settings/), [Ports](/docs/reference/ports/)
|
|
- [Control plane routes](/docs/reference/control-api/) and the [API reference](/docs/reference/api/)
|
|
- [Packages and install files](/docs/reference/packages/), [Licences](/docs/reference/licence/)
|