# Skald

Skald is a hard fork of Galene into an audio-only hall conferencing
server.  The current development repository is
<https://git.stormux.org/storm/skald>.

Skald is not protocol-compatible or API-compatible with Galene.  Its public
URLs, administrative API, and protocol terminology use halls and Skald names.
Recordings are written as single mixed Ogg Opus audio files; `ffmpeg` must be
installed on the server for recording to work.

## Quick start

```sh
git clone https://git.stormux.org/storm/skald
cd skald
CGO_ENABLED=0 go build -ldflags='-s -w'
mkdir halls
echo '{"users": {"Username": {"password":"Password", "permissions":"op"}}}' > halls/main.json
./skald &
```

Point your browser at <https://localhost:8443/hall/main/>, ignore the
unknown certificate warning, and log in with username *Username* and
password *Password*.  The browser client enables the microphone by default
and does not provide camera or screen-sharing controls.

For full installation instructions, please see the file [skald-install.md][1]
in this directory.

## Documentation

  * [skald-install.md][1]: full installation instructions
  * [skald.md][2]: usage and administration;
  * [skald-client.md][3]: writing clients;
  * [skald-protocol.md][4]: the client protocol;
  * [skald-api.md][5]: Skald's administrative API.

## Contributing

Skald is currently being developed at
<https://git.stormux.org/storm/skald>.

## Further information

Skald is derived from Galene by Juliusz Chroboczek.  Galene's web page is at
<https://galene.org>.

[1]: <skald-install.md>
[2]: <skald.md>
[3]: <skald-client.md>
[4]: <skald-protocol.md>
[5]: <skald-api.md>