Audio space for Mastodon, Pleroma, and Calckey https://audon.space
 
 
 
 
 
 
Go to file
Namekuji 3138e2a596 fix returning string 2023-03-22 10:45:00 -04:00
.devcontainer change timing to create room 2023-01-26 17:31:53 -05:00
.vscode add gif indicator 2023-01-23 07:10:21 -05:00
audon-fe use png twemoji 2023-02-20 17:39:27 -05:00
config change default activation level 2022-12-24 15:58:11 +09:00
locales change description 2023-01-19 13:57:32 -05:00
public add listener online indicator 2023-01-25 15:58:15 -05:00
.dockerignore add gif indicator 2023-01-23 07:10:21 -05:00
.env.production.sample change timing to create room 2023-01-26 17:31:53 -05:00
.gitignore add static link 2023-01-26 14:39:19 -05:00
.gitmodules add logo and mascot 2023-01-03 12:58:41 +09:00
CREDITS implement #19 2023-01-13 20:20:08 -05:00
Dockerfile use twemoji 2023-02-20 15:08:35 -05:00
LICENSE add license 2022-12-15 15:29:19 -05:00
README.md change description 2023-01-19 13:57:32 -05:00
auth.go fix returning string 2023-03-22 10:45:00 -04:00
avatar.go allow cohosts to close the room 2023-01-28 15:08:15 -05:00
config.go change timing to create room 2023-01-26 17:31:53 -05:00
docker-compose.yaml fix preview avatar issue 2023-01-24 01:03:15 -05:00
error.go fix instant room creation 2022-12-06 01:09:15 -05:00
go.mod add gif indicator 2023-01-23 07:10:21 -05:00
go.sum add gif indicator 2023-01-23 07:10:21 -05:00
locale.go add bot support 2023-01-14 18:02:15 -05:00
room.go increase session cacche ttl 2023-01-29 21:30:10 -05:00
schema.go fix host avatar restore 2023-01-28 23:33:16 -05:00
server.go fix oauth redirect_uri 2023-03-22 10:14:00 -04:00
user.go remove error from url 2023-01-29 23:12:07 -05:00
utils.go add gif indicator 2023-01-23 07:10:21 -05:00
webhooks.go increase session cacche ttl 2023-01-29 21:30:10 -05:00

README.md

Branding Logo

Mascot

Audio + Mastodon = Audon

Audon is a service of realtime audio streaming for Mastodon.

Tech Stack

Deployment

Only Docker-based installation is currently supported. This repository provides pre-configured Dockerfile and docker-compose.yaml.

Note that the LiveKit service runs in the Host-network mode, thus the following ports have to be available in the host machine.

  • 7880/tcp
  • 7881/tcp
  • 50000-60000/udp
  • 5349/tcp
  • 3478/udp

These ports are changeable in config/livekit.yaml. Please refer to the documentation of LiveKit here.

Requirements

  • Docker 20.10+
  • docker-compose 2.12+

Installation Steps

Before getting started, clone this repo in your working directory.

git clone --recursive https://codeberg.org/nmkj/audon.git

Edit Config Files

The followings config files are needed to run Audon.

  • .env.production
  • config/livekit.yaml
  • config/redis.conf

First, create them by copying the sample files.

cp .env.production.sample .env.production && cp config/livekit.sample.yaml config/livekit.yaml && cp config/redis.sample.conf config/redis.conf

Then, create a pair of API key and secret to connect to LiveKit.

docker run --rm -it livekit/generate

You will be asked some questions, but they do not matter. Just enter random domains and keep hitting Return/Enter key.

Then generated API key and secret appear as follows:

API Key: your-key
API Secret: your-secret

Copy and paste these values to .env.production and config/livekit.yaml, for example,

keys:
  your-key:your-secret
# Same as the keys field in livekit.yaml
LIVEKIT_API_KEY=your-key
# Same as the keys field in livekit.yaml
LIVEKIT_API_SECRET=your-secret

Prepare Reverse Proxy

The easiest way is to use Caddy as TLS endpoints. Here is an example Caddyfile:

audon.example.com {
    encode gzip
    reverse_proxy 127.0.0.1:8100
}

livekit.example.com {
    reverse_proxy 127.0.0.1:7880
}

h2://livekit-turn.example.com {
    reverse_proxy 127.0.0.1:5349
}

h3://livekit-turn.example.com {
    reverse_proxy h3://127.0.0.1:3478
}

You may want to use your own TLS certificates with tls directive of Caddyfile.

Build and Start Containers

With your config files ready, run the following command to start containers.

docker compose build && docker compose up -d