initial
This commit is contained in:
commit
da1a550139
10 changed files with 2088 additions and 0 deletions
73
compile.sh
Executable file
73
compile.sh
Executable file
|
|
@ -0,0 +1,73 @@
|
||||||
|
#!/bin/bash
|
||||||
|
#set -ex
|
||||||
|
set -uo pipefail
|
||||||
|
|
||||||
|
touch .hash
|
||||||
|
source .hash
|
||||||
|
echo "" > .hash
|
||||||
|
|
||||||
|
FORCE="${1:-false}"
|
||||||
|
|
||||||
|
function clone {
|
||||||
|
DIRECTORY=$(basename "$1" .git)
|
||||||
|
if [ -d "$DIRECTORY" ]; then
|
||||||
|
pushd "$DIRECTORY"
|
||||||
|
git pull
|
||||||
|
else
|
||||||
|
git clone "$1"
|
||||||
|
declare HASH_$DIRECTORY=0
|
||||||
|
pushd "$DIRECTORY"
|
||||||
|
fi
|
||||||
|
REVPARSE=$(git rev-parse HEAD)
|
||||||
|
TAINT=$(git status --porcelain | wc -l)
|
||||||
|
OLD="HASH_$DIRECTORY"
|
||||||
|
if [ "${!OLD:=0}" != "$REVPARSE" ]; then
|
||||||
|
readonly TAINTED_$DIRECTORY="true"
|
||||||
|
elif [ "$TAINT" != "0" ]; then
|
||||||
|
readonly TAINTED_$DIRECTORY="true"
|
||||||
|
else
|
||||||
|
readonly TAINTED_$DIRECTORY="$FORCE"
|
||||||
|
fi
|
||||||
|
popd
|
||||||
|
echo "HASH_$DIRECTORY=$REVPARSE" >> .hash
|
||||||
|
}
|
||||||
|
|
||||||
|
taintop() {
|
||||||
|
TAINTED="TAINTED_$1"
|
||||||
|
echo "tainted: $TAINTED"
|
||||||
|
if [ "${!TAINTED}" = "true" ]; then
|
||||||
|
pushd $1
|
||||||
|
shift 1
|
||||||
|
"$@"
|
||||||
|
popd
|
||||||
|
else
|
||||||
|
echo "Taint not detected in $1, not building"
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
clone https://git.cef.icu/CEF/ergo.git
|
||||||
|
clone https://git.cef.icu/CEF/grumble.git
|
||||||
|
clone https://git.cef.icu/CEF/mediamtx.git
|
||||||
|
clone https://git.cef.icu/CEF/3M.git
|
||||||
|
clone https://git.cef.icu/CEF/CEF.git
|
||||||
|
|
||||||
|
source .env
|
||||||
|
|
||||||
|
taintop ergo docker build -t ergo .
|
||||||
|
taintop grumble docker build -t grumble .
|
||||||
|
taintop mediamtx docker build -t mediamtx .
|
||||||
|
taintop 3M docker build -t 3m .
|
||||||
|
|
||||||
|
|
||||||
|
taintop CEF docker build -t cef --build-arg "VITE_IRC_WEBSOCKET=$VITE_IRC_WEBSOCKET" --build-arg "VITE_3M_ADDRESS=$VITE_3M_ADDRESS" --build-arg "VITE_HOSTING_ADDRESS=$VITE_HOSTING_ADDRESS" --build-arg "VITE_VOICE_ADDRESS=$VITE_VOICE_ADDRESS" .
|
||||||
|
mkdir -p www
|
||||||
|
rm -rf www/*
|
||||||
|
id=$(docker create cef)
|
||||||
|
docker cp $id:/home/bun/app/dist /tmp/
|
||||||
|
sleep 1
|
||||||
|
docker cp $id:/home/bun/app/assets /tmp/
|
||||||
|
docker rm -v $id
|
||||||
|
cp -r /tmp/dist/* www
|
||||||
|
cp -r /tmp/assets/* www/assets
|
||||||
|
rm -rf /tmp/dist
|
||||||
|
|
||||||
24
configs/3m/config.py
Normal file
24
configs/3m/config.py
Normal file
|
|
@ -0,0 +1,24 @@
|
||||||
|
import os
|
||||||
|
SECRETKEY = os.path.join("keys", "3m.pub")
|
||||||
|
|
||||||
|
# CEF-specific port (grumble communicates over it as well)
|
||||||
|
ERGO_ADDR = os.getenv("THREEM_ERGO_ADDR") or "ergo"
|
||||||
|
ERGO_PORT = os.getenv("THREEM_ERGO_PORT") or 22843
|
||||||
|
|
||||||
|
MINIO_INTERNAL_ADDR = os.getenv("THREEM_MINIO_INTERNAL_ADDR") or "minio:9000"
|
||||||
|
MINIO_EXTERNAL_ADDR = os.getenv("THREEM_MINIO_EXTERNAL_ADDR") or "data.example.xyz"
|
||||||
|
MINIO_ACCESS_KEY = os.getenv("THREEM_MINIO_ACCESS_KEY") or "access-key-goes-here"
|
||||||
|
MINIO_SECRET_KEY = os.getenv("THREEM_MINIO_SECRET_KEY") or "secret-key-goes-here"
|
||||||
|
DBURL = os.getenv("THREEM_DBURL") or "dburl-goes-here"
|
||||||
|
REDIS_ADDR = os.getenv("THREEM_REDIS_ADDR") or "redis"
|
||||||
|
MEDIAMTX_API = os.getenv("THREEM_MEDIAMTX_API") or "http://localhost:9997"
|
||||||
|
MEDIAMTX_RTSP = os.getenv("THREEM_MEDIAMTX_RTSP") or "localhost:8554"
|
||||||
|
|
||||||
|
MAX_FILE_SIZE = 1024*1024*20
|
||||||
|
MAX_PFP_SIZE = 1024*1024*1.5
|
||||||
|
# It's a 24x24 image, you can fit that in 32k
|
||||||
|
MAX_ICON_SIZE = 1024*32
|
||||||
|
PRIVILEGED_HOSTS=["mediamtx", "ergo", "3m", "grumble", "caddy"]
|
||||||
|
|
||||||
|
# Need to figure out how to make this cooperate more
|
||||||
|
ALLOWED_DOMAINS = ["*"]
|
||||||
56
configs/caddy/Caddyfile
Normal file
56
configs/caddy/Caddyfile
Normal file
|
|
@ -0,0 +1,56 @@
|
||||||
|
{
|
||||||
|
}
|
||||||
|
|
||||||
|
{$DOMAIN} {
|
||||||
|
root * /srv
|
||||||
|
encode gzip
|
||||||
|
handle {
|
||||||
|
try_files {path} /index.html
|
||||||
|
file_server
|
||||||
|
}
|
||||||
|
header /assets/*.js {
|
||||||
|
Service-Worker-Allowed "/"
|
||||||
|
}
|
||||||
|
handle_path /3m/* {
|
||||||
|
reverse_proxy 3m:8001
|
||||||
|
}
|
||||||
|
handle_path /chat {
|
||||||
|
reverse_proxy ergo:8097
|
||||||
|
}
|
||||||
|
handle_path /voice {
|
||||||
|
reverse_proxy grumble:8443
|
||||||
|
}
|
||||||
|
handle_path /video/* {
|
||||||
|
rewrite /video /
|
||||||
|
reverse_proxy mediamtx:8889
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
{$HOST_DOMAIN} {
|
||||||
|
header Access-Control-Allow-Origin *
|
||||||
|
header Access-Control-Allow-Origin i.cef.icu
|
||||||
|
header Access-Control-Allow-Origin cef.icu
|
||||||
|
@uploads {
|
||||||
|
path_regexp hash ^/uploads/(.*)/.*
|
||||||
|
}
|
||||||
|
|
||||||
|
rewrite @uploads /uploads/{re.hash.1}
|
||||||
|
respond /uploads/ 403
|
||||||
|
respond /pfp/ 403
|
||||||
|
|
||||||
|
handle_path /embed/* {
|
||||||
|
reverse_proxy imagor:8000
|
||||||
|
header -Cache-Control
|
||||||
|
header -Expires
|
||||||
|
header Cache-Control "public, max-age=604800"
|
||||||
|
}
|
||||||
|
|
||||||
|
reverse_proxy minio:9000 {
|
||||||
|
@error status 500 404
|
||||||
|
handle_response @error {
|
||||||
|
root * /srv
|
||||||
|
try_files /assets/blankIcon.png
|
||||||
|
file_server
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
1
configs/ergo/ircd.motd
Normal file
1
configs/ergo/ircd.motd
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
hello your operator should probably set this despite it not being seen
|
||||||
968
configs/ergo/ircd.yaml
Normal file
968
configs/ergo/ircd.yaml
Normal file
|
|
@ -0,0 +1,968 @@
|
||||||
|
# network configuration
|
||||||
|
network:
|
||||||
|
# name of the network
|
||||||
|
name: unconfigured
|
||||||
|
|
||||||
|
# server configuration
|
||||||
|
server:
|
||||||
|
# server name
|
||||||
|
name: unconfigured.ircd
|
||||||
|
|
||||||
|
# addresses to listen on
|
||||||
|
listeners:
|
||||||
|
# The standard plaintext port for IRC is 6667. Allowing plaintext over the
|
||||||
|
# public Internet poses serious security and privacy issues. Accordingly,
|
||||||
|
# we recommend using plaintext only on local (loopback) interfaces:
|
||||||
|
#"127.0.0.1:6667": # (loopback ipv4, localhost-only)
|
||||||
|
#"[::1]:6667": # (loopback ipv6, localhost-only)
|
||||||
|
# If you need to serve plaintext on public interfaces, comment out the above
|
||||||
|
# two lines and uncomment the line below (which listens on all interfaces):
|
||||||
|
# ":6667":
|
||||||
|
# Alternately, if you have a TLS certificate issued by a recognized CA,
|
||||||
|
# you can configure port 6667 as an STS-only listener that only serves
|
||||||
|
# "redirects" to the TLS port, but doesn't allow chat. See the manual
|
||||||
|
# for details.
|
||||||
|
|
||||||
|
# The standard SSL/TLS port for IRC is 6697. This will listen on all interfaces:
|
||||||
|
#":6697":
|
||||||
|
# this is a standard TLS configuration with a single certificate;
|
||||||
|
# see the manual for instructions on how to configure SNI
|
||||||
|
#tls:
|
||||||
|
# cert: fullchain.pem
|
||||||
|
# key: privkey.pem
|
||||||
|
# 'proxy' should typically be false. It's for cloud load balancers that
|
||||||
|
# always send a PROXY protocol header ahead of the connection. See the
|
||||||
|
# manual ("Reverse proxies") for more details.
|
||||||
|
#proxy: false
|
||||||
|
# set the minimum TLS version:
|
||||||
|
#min-tls-version: 1.2
|
||||||
|
|
||||||
|
# Example of a Unix domain socket for proxying:
|
||||||
|
# "/tmp/ergo_sock":
|
||||||
|
|
||||||
|
# Example of a Tor listener: any connection that comes in on this listener will
|
||||||
|
# be considered a Tor connection. It is strongly recommended that this listener
|
||||||
|
# *not* be on a public interface --- it should be on 127.0.0.0/8 or unix domain:
|
||||||
|
# "/hidden_service_sockets/ergo_tor_sock":
|
||||||
|
# tor: true
|
||||||
|
|
||||||
|
":8097":
|
||||||
|
websocket: true
|
||||||
|
# tls:
|
||||||
|
# cert: fullchain.pem
|
||||||
|
# key: privkey.pem
|
||||||
|
|
||||||
|
# sets the permissions for Unix listen sockets. on a typical Linux system,
|
||||||
|
# the default is 0775 or 0755, which prevents other users/groups from connecting
|
||||||
|
# to the socket. With 0777, it behaves like a normal TCP socket
|
||||||
|
# where anyone can connect.
|
||||||
|
unix-bind-mode: 0777
|
||||||
|
|
||||||
|
# configure the behavior of Tor listeners (ignored if you didn't enable any):
|
||||||
|
tor-listeners:
|
||||||
|
# if this is true, connections from Tor must authenticate with SASL
|
||||||
|
require-sasl: false
|
||||||
|
|
||||||
|
# what hostname should be displayed for Tor connections?
|
||||||
|
vhost: "tor-network.onion"
|
||||||
|
|
||||||
|
# allow at most this many connections at once (0 for no limit):
|
||||||
|
max-connections: 64
|
||||||
|
|
||||||
|
# connection throttling (limit how many connection attempts are allowed at once):
|
||||||
|
throttle-duration: 10m
|
||||||
|
# set to 0 to disable throttling:
|
||||||
|
max-connections-per-duration: 64
|
||||||
|
|
||||||
|
# strict transport security, to get clients to automagically use TLS
|
||||||
|
sts:
|
||||||
|
# whether to advertise STS
|
||||||
|
#
|
||||||
|
# to stop advertising STS, leave this enabled and set 'duration' below to "0". this will
|
||||||
|
# advertise to connecting users that the STS policy they have saved is no longer valid
|
||||||
|
enabled: false
|
||||||
|
|
||||||
|
# how long clients should be forced to use TLS for.
|
||||||
|
# setting this to a too-long time will mean bad things if you later remove your TLS.
|
||||||
|
# the default duration below is 1 month, 2 days and 5 minutes.
|
||||||
|
duration: 1mo2d5m
|
||||||
|
|
||||||
|
# tls port - you should be listening on this port above
|
||||||
|
port: 6697
|
||||||
|
|
||||||
|
# should clients include this STS policy when they ship their inbuilt preload lists?
|
||||||
|
preload: false
|
||||||
|
|
||||||
|
websockets:
|
||||||
|
# Restrict the origin of WebSocket connections by matching the "Origin" HTTP
|
||||||
|
# header. This setting causes ergo to reject websocket connections unless
|
||||||
|
# they originate from a page on one of the whitelisted websites in this list.
|
||||||
|
# This prevents malicious websites from making their visitors connect to your
|
||||||
|
# ergo instance without their knowledge. An empty list means there are no
|
||||||
|
# restrictions.
|
||||||
|
allowed-origins:
|
||||||
|
# - "https://ergo.chat"
|
||||||
|
# - "https://*.ergo.chat"
|
||||||
|
|
||||||
|
# casemapping controls what kinds of strings are permitted as identifiers (nicknames,
|
||||||
|
# channel names, account names, etc.), and how they are normalized for case.
|
||||||
|
# the recommended default is 'ascii' (traditional ASCII-only identifiers).
|
||||||
|
# the other options are 'precis', which allows UTF8 identifiers that are "sane"
|
||||||
|
# (according to UFC 8265), with additional mitigations for homoglyph attacks,
|
||||||
|
# and 'permissive', which allows identifiers containing unusual characters like
|
||||||
|
# emoji, at the cost of increased vulnerability to homoglyph attacks and potential
|
||||||
|
# client compatibility problems. we recommend leaving this value at its default;
|
||||||
|
# however, note that changing it once the network is already up and running is
|
||||||
|
# problematic.
|
||||||
|
casemapping: "ascii"
|
||||||
|
|
||||||
|
# enforce-utf8 controls whether the server will preemptively discard non-UTF8
|
||||||
|
# messages (since they cannot be relayed to websocket clients), or will allow
|
||||||
|
# them and relay them to non-websocket clients (as in traditional IRC).
|
||||||
|
enforce-utf8: true
|
||||||
|
|
||||||
|
# whether to look up user hostnames with reverse DNS. there are 3 possibilities:
|
||||||
|
# 1. lookup-hostnames enabled, IP cloaking disabled; users will see each other's hostnames
|
||||||
|
# 2. lookup-hostnames disabled, IP cloaking disabled; users will see each other's numeric IPs
|
||||||
|
# 3. [the default] IP cloaking enabled; users will see cloaked hostnames
|
||||||
|
lookup-hostnames: false
|
||||||
|
# whether to confirm hostname lookups using "forward-confirmed reverse DNS", i.e., for
|
||||||
|
# any hostname returned from reverse DNS, resolve it back to an IP address and reject it
|
||||||
|
# unless it matches the connecting IP
|
||||||
|
forward-confirm-hostnames: true
|
||||||
|
|
||||||
|
# use ident protocol to get usernames
|
||||||
|
check-ident: false
|
||||||
|
|
||||||
|
# ignore the supplied user/ident string from the USER command, always setting user/ident
|
||||||
|
# to the following literal value; this can potentially reduce confusion and simplify bans.
|
||||||
|
# the value must begin with a '~' character. comment out / omit to disable:
|
||||||
|
coerce-ident: '~u'
|
||||||
|
|
||||||
|
# 'password' allows you to require a global, shared password (the IRC `PASS` command)
|
||||||
|
# to connect to the server. for operator passwords, see the `opers` section of the
|
||||||
|
# config. for a more secure way to create a private server, see the `require-sasl`
|
||||||
|
# section. you must hash the password with `ergo genpasswd`, then enter the hash here:
|
||||||
|
#password: "$2a$04$0123456789abcdef0123456789abcdef0123456789abcdef01234"
|
||||||
|
|
||||||
|
# motd filename
|
||||||
|
# if you change the motd, you should move it to ircd.motd
|
||||||
|
motd: ircd.motd
|
||||||
|
|
||||||
|
# motd formatting codes
|
||||||
|
# if this is true, the motd is escaped using formatting codes like $c, $b, and $i
|
||||||
|
motd-formatting: true
|
||||||
|
|
||||||
|
# relaying using the RELAYMSG command
|
||||||
|
relaymsg:
|
||||||
|
# is relaymsg enabled at all?
|
||||||
|
enabled: true
|
||||||
|
|
||||||
|
# which character(s) are reserved for relayed nicks?
|
||||||
|
separators: "/"
|
||||||
|
|
||||||
|
# can channel operators use RELAYMSG in their channels?
|
||||||
|
# our implementation of RELAYMSG makes it safe for chanops to use without the
|
||||||
|
# possibility of real users being silently spoofed
|
||||||
|
available-to-chanops: true
|
||||||
|
|
||||||
|
# IPs/CIDRs the PROXY command can be used from
|
||||||
|
# This should be restricted to localhost (127.0.0.1/8, ::1/128, and unix sockets).
|
||||||
|
# Unless you have a good reason. you should also add these addresses to the
|
||||||
|
# connection limits and throttling exemption lists.
|
||||||
|
proxy-allowed-from:
|
||||||
|
- localhost
|
||||||
|
# - "192.168.1.1"
|
||||||
|
# - "192.168.10.1/24"
|
||||||
|
|
||||||
|
# controls the use of the WEBIRC command (by IRC<->web interfaces, bouncers and similar)
|
||||||
|
webirc:
|
||||||
|
# one webirc block -- should correspond to one set of gateways
|
||||||
|
#-
|
||||||
|
# SHA-256 fingerprint of the TLS certificate the gateway must use to connect
|
||||||
|
# (comment this out to use passwords only)
|
||||||
|
#certfp: "abcdef0123456789abcdef0123456789abcdef0123456789abcdef0123456789"
|
||||||
|
|
||||||
|
# password the gateway uses to connect, made with `ergo genpasswd`
|
||||||
|
#password: "$2a$04$abcdef0123456789abcdef0123456789abcdef0123456789abcde"
|
||||||
|
|
||||||
|
# IPs/CIDRs that can use this webirc command
|
||||||
|
# you should also add these addresses to the connection limits and throttling exemption lists
|
||||||
|
#hosts:
|
||||||
|
#- localhost
|
||||||
|
# - "192.168.1.1"
|
||||||
|
# - "192.168.10.1/24"
|
||||||
|
|
||||||
|
# maximum length of clients' sendQ in bytes
|
||||||
|
# this should be big enough to hold bursts of channel/direct messages
|
||||||
|
max-sendq: 96k
|
||||||
|
|
||||||
|
# compatibility with legacy clients
|
||||||
|
compatibility:
|
||||||
|
# many clients require that the final parameter of certain messages be an
|
||||||
|
# RFC1459 trailing parameter, i.e., prefixed with :, whether or not this is
|
||||||
|
# actually required. this forces Ergo to send those parameters
|
||||||
|
# as trailings. this is recommended unless you're testing clients for conformance;
|
||||||
|
# defaults to true when unset for that reason.
|
||||||
|
force-trailing: true
|
||||||
|
|
||||||
|
# some clients (ZNC 1.6.x and lower, Pidgin 2.12 and lower) do not
|
||||||
|
# respond correctly to SASL messages with the server name as a prefix:
|
||||||
|
# https://github.com/znc/znc/issues/1212
|
||||||
|
# this works around that bug, allowing them to use SASL.
|
||||||
|
send-unprefixed-sasl: false
|
||||||
|
|
||||||
|
# traditionally, IRC servers will truncate and send messages that are
|
||||||
|
# too long to be relayed intact. this behavior can be disabled by setting
|
||||||
|
# allow-truncation to false, in which case Ergo will reject the message
|
||||||
|
# and return an error to the client. (note that this option defaults to true
|
||||||
|
# when unset.)
|
||||||
|
allow-truncation: false
|
||||||
|
|
||||||
|
# IP-based DoS protection
|
||||||
|
ip-limits:
|
||||||
|
# whether to limit the total number of concurrent connections per IP/CIDR
|
||||||
|
count: true
|
||||||
|
# maximum concurrent connections per IP/CIDR
|
||||||
|
max-concurrent-connections: 16
|
||||||
|
|
||||||
|
# whether to restrict the rate of new connections per IP/CIDR
|
||||||
|
throttle: false
|
||||||
|
# how long to keep track of connections for
|
||||||
|
window: 10m
|
||||||
|
# maximum number of new connections per IP/CIDR within the given duration
|
||||||
|
max-connections-per-window: 32
|
||||||
|
|
||||||
|
# how wide the CIDR should be for IPv4 (a /32 is a fully specified IPv4 address)
|
||||||
|
cidr-len-ipv4: 32
|
||||||
|
# how wide the CIDR should be for IPv6 (a /64 is the typical prefix assigned
|
||||||
|
# by an ISP to an individual customer for their LAN)
|
||||||
|
cidr-len-ipv6: 64
|
||||||
|
|
||||||
|
# IPs/networks which are exempted from connection limits
|
||||||
|
exempted:
|
||||||
|
- "localhost"
|
||||||
|
# - "192.168.1.1"
|
||||||
|
# - "2001:0db8::/32"
|
||||||
|
|
||||||
|
# custom connection limits for certain IPs/networks.
|
||||||
|
custom-limits:
|
||||||
|
#"irccloud":
|
||||||
|
# nets:
|
||||||
|
# - "192.184.9.108" # highgate.irccloud.com
|
||||||
|
# - "192.184.9.110" # ealing.irccloud.com
|
||||||
|
# - "192.184.9.112" # charlton.irccloud.com
|
||||||
|
# - "192.184.10.118" # brockwell.irccloud.com
|
||||||
|
# - "192.184.10.9" # tooting.irccloud.com
|
||||||
|
# - "192.184.8.73" # hathersage.irccloud.com
|
||||||
|
# - "192.184.8.103" # stonehaven.irccloud.com
|
||||||
|
# - "5.254.36.57" # tinside.irccloud.com
|
||||||
|
# - "5.254.36.56/29" # additional ipv4 net
|
||||||
|
# - "2001:67c:2f08::/48"
|
||||||
|
# - "2a03:5180:f::/64"
|
||||||
|
# max-concurrent-connections: 2048
|
||||||
|
# max-connections-per-window: 2048
|
||||||
|
|
||||||
|
# pluggable IP ban mechanism, via subprocess invocation
|
||||||
|
# this can be used to check new connections against a DNSBL, for example
|
||||||
|
# see the manual for details on how to write an IP ban checking script
|
||||||
|
ip-check-script:
|
||||||
|
enabled: false
|
||||||
|
command: "/usr/local/bin/check-ip-ban"
|
||||||
|
# constant list of args to pass to the command; the actual query
|
||||||
|
# and result are transmitted over stdin/stdout:
|
||||||
|
args: []
|
||||||
|
# timeout for process execution, after which we send a SIGTERM:
|
||||||
|
timeout: 9s
|
||||||
|
# how long after the SIGTERM before we follow up with a SIGKILL:
|
||||||
|
kill-timeout: 1s
|
||||||
|
# how many scripts are allowed to run at once? 0 for no limit:
|
||||||
|
max-concurrency: 64
|
||||||
|
# if true, only check anonymous connections (not logged into an account)
|
||||||
|
# at the very end of the handshake:
|
||||||
|
exempt-sasl: false
|
||||||
|
|
||||||
|
# IP cloaking hides users' IP addresses from other users and from channel admins
|
||||||
|
# (but not from server admins), while still allowing channel admins to ban
|
||||||
|
# offending IP addresses or networks. In place of hostnames derived from reverse
|
||||||
|
# DNS, users see fake domain names like pwbs2ui4377257x8.irc. These names are
|
||||||
|
# generated deterministically from the underlying IP address, but if the underlying
|
||||||
|
# IP is not already known, it is infeasible to recover it from the cloaked name.
|
||||||
|
# If you disable this, you should probably enable lookup-hostnames in its place.
|
||||||
|
ip-cloaking:
|
||||||
|
# whether to enable IP cloaking
|
||||||
|
enabled: true
|
||||||
|
|
||||||
|
# whether to use these cloak settings (specifically, `netname` and `num-bits`)
|
||||||
|
# to produce unique hostnames for always-on clients. you can enable this even if
|
||||||
|
# you disabled IP cloaking for normal clients above. if this is disabled,
|
||||||
|
# always-on clients will all have an identical hostname (the server name).
|
||||||
|
enabled-for-always-on: true
|
||||||
|
|
||||||
|
# fake TLD at the end of the hostname, e.g., pwbs2ui4377257x8.irc
|
||||||
|
# you may want to use your network name here
|
||||||
|
netname: "cef"
|
||||||
|
|
||||||
|
# the cloaked hostname is derived only from the CIDR (most significant bits
|
||||||
|
# of the IP address), up to a configurable number of bits. this is the
|
||||||
|
# granularity at which bans will take effect for IPv4. Note that changing
|
||||||
|
# this value will invalidate any stored bans.
|
||||||
|
cidr-len-ipv4: 32
|
||||||
|
|
||||||
|
# analogous granularity for IPv6
|
||||||
|
cidr-len-ipv6: 128
|
||||||
|
|
||||||
|
# number of bits of hash output to include in the cloaked hostname.
|
||||||
|
# more bits means less likelihood of distinct IPs colliding,
|
||||||
|
# at the cost of a longer cloaked hostname. if this value is set to 0,
|
||||||
|
# all users will receive simply `netname` as their cloaked hostname.
|
||||||
|
num-bits: 64
|
||||||
|
|
||||||
|
# secure-nets identifies IPs and CIDRs which are secure at layer 3,
|
||||||
|
# for example, because they are on a trusted internal LAN or a VPN.
|
||||||
|
# plaintext connections from these IPs and CIDRs will be considered
|
||||||
|
# secure (clients will receive the +Z mode and be allowed to resume
|
||||||
|
# or reattach to secure connections). note that loopback IPs are always
|
||||||
|
# considered secure:
|
||||||
|
secure-nets:
|
||||||
|
# - "10.0.0.0/8"
|
||||||
|
|
||||||
|
# Ergo will write files to disk under certain circumstances, e.g.,
|
||||||
|
# CPU profiling or data export. by default, these files will be written
|
||||||
|
# to the working directory. set this to customize:
|
||||||
|
#output-path: "/home/ergo/out"
|
||||||
|
|
||||||
|
# the hostname used by "services", e.g., NickServ, defaults to "localhost",
|
||||||
|
# e.g., `NickServ!NickServ@localhost`. uncomment this to override:
|
||||||
|
override-services-hostname: "cef.operative"
|
||||||
|
|
||||||
|
# in a "closed-loop" system where you control the server and all the clients,
|
||||||
|
# you may want to increase the maximum (non-tag) length of an IRC line from
|
||||||
|
# the default value of 512. DO NOT change this on a public server:
|
||||||
|
max-line-len: 2048
|
||||||
|
|
||||||
|
# send all 0's as the LUSERS (user counts) output to non-operators; potentially useful
|
||||||
|
# if you don't want to publicize how popular the server is
|
||||||
|
suppress-lusers: false
|
||||||
|
|
||||||
|
# account options
|
||||||
|
accounts:
|
||||||
|
# is account authentication enabled, i.e., can users log into existing accounts?
|
||||||
|
authentication-enabled: true
|
||||||
|
|
||||||
|
# account registration
|
||||||
|
registration:
|
||||||
|
# can users register new accounts for themselves? if this is false, operators with
|
||||||
|
# the `accreg` capability can still create accounts with `/NICKSERV SAREGISTER`
|
||||||
|
enabled: false
|
||||||
|
|
||||||
|
# can users use the REGISTER command to register before fully connecting?
|
||||||
|
allow-before-connect: true
|
||||||
|
|
||||||
|
# global throttle on new account creation
|
||||||
|
throttling:
|
||||||
|
enabled: true
|
||||||
|
# window
|
||||||
|
duration: 10m
|
||||||
|
# number of attempts allowed within the window
|
||||||
|
max-attempts: 30
|
||||||
|
|
||||||
|
# this is the bcrypt cost we'll use for account passwords
|
||||||
|
# (note that 4 is the lowest value allowed by the bcrypt library)
|
||||||
|
bcrypt-cost: 8
|
||||||
|
|
||||||
|
# length of time a user has to verify their account before it can be re-registered
|
||||||
|
verify-timeout: "32h"
|
||||||
|
|
||||||
|
# options for email verification of account registrations
|
||||||
|
email-verification:
|
||||||
|
enabled: false
|
||||||
|
sender: "admin@my.network"
|
||||||
|
require-tls: true
|
||||||
|
helo-domain: "my.network" # defaults to server name if unset
|
||||||
|
# options to enable DKIM signing of outgoing emails (recommended, but
|
||||||
|
# requires creating a DNS entry for the public key):
|
||||||
|
# dkim:
|
||||||
|
# domain: "my.network"
|
||||||
|
# selector: "20200229"
|
||||||
|
# key-file: "dkim.pem"
|
||||||
|
# to use an MTA/smarthost instead of sending email directly:
|
||||||
|
# mta:
|
||||||
|
# server: localhost
|
||||||
|
# port: 25
|
||||||
|
# username: "admin"
|
||||||
|
# password: "hunter2"
|
||||||
|
# implicit-tls: false # TLS from the first byte, typically on port 465
|
||||||
|
blacklist-regexes:
|
||||||
|
# - ".*@mailinator.com"
|
||||||
|
timeout: 60s
|
||||||
|
# email-based password reset:
|
||||||
|
password-reset:
|
||||||
|
enabled: false
|
||||||
|
# time before we allow resending the email
|
||||||
|
cooldown: 1h
|
||||||
|
# time for which a password reset code is valid
|
||||||
|
timeout: 1d
|
||||||
|
|
||||||
|
# throttle account login attempts (to prevent either password guessing, or DoS
|
||||||
|
# attacks on the server aimed at forcing repeated expensive bcrypt computations)
|
||||||
|
login-throttling:
|
||||||
|
enabled: true
|
||||||
|
|
||||||
|
# window
|
||||||
|
duration: 1m
|
||||||
|
|
||||||
|
# number of attempts allowed within the window
|
||||||
|
max-attempts: 3
|
||||||
|
|
||||||
|
# some clients (notably Pidgin and Hexchat) offer only a single password field,
|
||||||
|
# which makes it impossible to specify a separate server password (for the PASS
|
||||||
|
# command) and SASL password. if this option is set to true, a client that
|
||||||
|
# successfully authenticates with SASL will not be required to send
|
||||||
|
# PASS as well, so it can be configured to authenticate with SASL only.
|
||||||
|
skip-server-password: false
|
||||||
|
|
||||||
|
# enable login to accounts via the PASS command, e.g., PASS account:password
|
||||||
|
# this is useful for compatibility with old clients that don't support SASL
|
||||||
|
login-via-pass-command: true
|
||||||
|
|
||||||
|
# advertise the SCRAM-SHA-256 authentication method. set to false in case of
|
||||||
|
# compatibility issues with certain clients:
|
||||||
|
advertise-scram: true
|
||||||
|
|
||||||
|
# require-sasl controls whether clients are required to have accounts
|
||||||
|
# (and sign into them using SASL) to connect to the server
|
||||||
|
require-sasl:
|
||||||
|
# if this is enabled, all clients must authenticate with SASL while connecting.
|
||||||
|
# WARNING: for a private server, you MUST set accounts.registration.enabled
|
||||||
|
# to false as well, in order to prevent non-administrators from registering
|
||||||
|
# accounts.
|
||||||
|
enabled: true
|
||||||
|
|
||||||
|
# IPs/CIDRs which are exempted from the account requirement
|
||||||
|
exempted:
|
||||||
|
# - "localhost"
|
||||||
|
# - '10.10.0.0/16'
|
||||||
|
|
||||||
|
# nick-reservation controls how, and whether, nicknames are linked to accounts
|
||||||
|
nick-reservation:
|
||||||
|
# is there any enforcement of reserved nicknames?
|
||||||
|
enabled: true
|
||||||
|
|
||||||
|
# how many nicknames, in addition to the account name, can be reserved?
|
||||||
|
# (note that additional nicks are unusable under force-nick-equals-account
|
||||||
|
# or if the client is always-on)
|
||||||
|
additional-nick-limit: 0
|
||||||
|
|
||||||
|
# method describes how nickname reservation is handled
|
||||||
|
# strict: users must already be logged in to their account (via
|
||||||
|
# SASL, PASS account:password, or /NickServ IDENTIFY)
|
||||||
|
# in order to use their reserved nickname(s)
|
||||||
|
# optional: no enforcement by default, but allow users to opt in to
|
||||||
|
# the enforcement level of their choice
|
||||||
|
method: strict
|
||||||
|
|
||||||
|
# allow users to set their own nickname enforcement status, e.g.,
|
||||||
|
# to opt out of strict enforcement
|
||||||
|
allow-custom-enforcement: false
|
||||||
|
|
||||||
|
# format for guest nicknames:
|
||||||
|
# 1. these nicknames cannot be registered or reserved
|
||||||
|
# 2. if a client is automatically renamed by the server,
|
||||||
|
# this is the template that will be used (e.g., Guest-nccj6rgmt97cg)
|
||||||
|
# 3. if enforce-guest-format (see below) is enabled, clients without
|
||||||
|
# a registered account will have this template applied to their
|
||||||
|
# nicknames (e.g., 'katie' will become 'Guest-katie')
|
||||||
|
guest-nickname-format: "Guest-*"
|
||||||
|
|
||||||
|
# when enabled, forces users not logged into an account to use
|
||||||
|
# a nickname matching the guest template. a caveat: this may prevent
|
||||||
|
# users from choosing nicknames in scripts different from the guest
|
||||||
|
# nickname format.
|
||||||
|
force-guest-format: false
|
||||||
|
|
||||||
|
# when enabled, forces users logged into an account to use the
|
||||||
|
# account name as their nickname. when combined with strict nickname
|
||||||
|
# enforcement, this lets users treat nicknames and account names
|
||||||
|
# as equivalent for the purpose of ban/invite/exception lists.
|
||||||
|
force-nick-equals-account: true
|
||||||
|
|
||||||
|
# parallel setting to force-nick-equals-account: if true, this forbids
|
||||||
|
# anonymous users (i.e., users not logged into an account) to change their
|
||||||
|
# nickname after the initial connection is complete
|
||||||
|
forbid-anonymous-nick-changes: false
|
||||||
|
|
||||||
|
# multiclient controls whether Ergo allows multiple connections to
|
||||||
|
# attach to the same client/nickname identity; this is part of the
|
||||||
|
# functionality traditionally provided by a bouncer like ZNC
|
||||||
|
multiclient:
|
||||||
|
# when disabled, each connection must use a separate nickname (as is the
|
||||||
|
# typical behavior of IRC servers). when enabled, a new connection that
|
||||||
|
# has authenticated with SASL can associate itself with an existing
|
||||||
|
# client
|
||||||
|
enabled: true
|
||||||
|
|
||||||
|
# if this is disabled, clients have to opt in to bouncer functionality
|
||||||
|
# using nickserv or the cap system. if it's enabled, they can opt out
|
||||||
|
# via nickserv
|
||||||
|
allowed-by-default: true
|
||||||
|
|
||||||
|
# whether to allow clients that remain on the server even
|
||||||
|
# when they have no active connections. The possible values are:
|
||||||
|
# "disabled", "opt-in", "opt-out", or "mandatory".
|
||||||
|
always-on: "opt-out"
|
||||||
|
|
||||||
|
# whether to mark always-on clients away when they have no active connections:
|
||||||
|
auto-away: "opt-out"
|
||||||
|
|
||||||
|
# QUIT always-on clients from the server if they go this long without connecting
|
||||||
|
# (use 0 or omit for no expiration):
|
||||||
|
always-on-expiration: 90d
|
||||||
|
|
||||||
|
# vhosts controls the assignment of vhosts (strings displayed in place of the user's
|
||||||
|
# hostname/IP) by the HostServ service
|
||||||
|
vhosts:
|
||||||
|
# are vhosts enabled at all?
|
||||||
|
enabled: true
|
||||||
|
|
||||||
|
# maximum length of a vhost
|
||||||
|
max-length: 64
|
||||||
|
|
||||||
|
# regexp for testing the validity of a vhost
|
||||||
|
# (make sure any changes you make here are RFC-compliant)
|
||||||
|
valid-regexp: '^[0-9A-Za-z.\-_/]+$'
|
||||||
|
|
||||||
|
# modes that are set by default when a user connects
|
||||||
|
# if unset, no user modes will be set by default
|
||||||
|
# +i is invisible (a user's channels are hidden from whois replies)
|
||||||
|
# see /QUOTE HELP umodes for more user modes
|
||||||
|
default-user-modes: +i
|
||||||
|
|
||||||
|
# pluggable authentication mechanism, via subprocess invocation
|
||||||
|
# see the manual for details on how to write an authentication plugin script
|
||||||
|
auth-script:
|
||||||
|
enabled: true
|
||||||
|
command: "http://3m:8001/account/verify"
|
||||||
|
# constant list of args to pass to the command; the actual authentication
|
||||||
|
# data is transmitted over stdin/stdout:
|
||||||
|
args: []
|
||||||
|
# should we automatically create users if the plugin returns success?
|
||||||
|
autocreate: true
|
||||||
|
# timeout for process execution, after which we send a SIGTERM:
|
||||||
|
timeout: 9s
|
||||||
|
# how long after the SIGTERM before we follow up with a SIGKILL:
|
||||||
|
kill-timeout: 1s
|
||||||
|
# how many scripts are allowed to run at once? 0 for no limit:
|
||||||
|
max-concurrency: 64
|
||||||
|
|
||||||
|
# channel options
|
||||||
|
channels:
|
||||||
|
# modes that are set when new channels are created
|
||||||
|
# +n is no-external-messages, +t is op-only-topic,
|
||||||
|
# +C is no CTCPs (besides ACTION)
|
||||||
|
# see /QUOTE HELP cmodes for more channel modes
|
||||||
|
default-modes: +ntC
|
||||||
|
|
||||||
|
# how many channels can a client be in at once?
|
||||||
|
max-channels-per-client: 100
|
||||||
|
|
||||||
|
# if this is true, new channels can only be created by operators with the
|
||||||
|
# `chanreg` operator capability
|
||||||
|
operator-only-creation: false
|
||||||
|
|
||||||
|
# channel registration - requires an account
|
||||||
|
registration:
|
||||||
|
# can users register new channels?
|
||||||
|
enabled: true
|
||||||
|
|
||||||
|
# restrict new channel registrations to operators only?
|
||||||
|
# (operators can then transfer channels to regular users using /CS TRANSFER)
|
||||||
|
operator-only: false
|
||||||
|
|
||||||
|
# how many channels can each account register?
|
||||||
|
max-channels-per-account: 15
|
||||||
|
|
||||||
|
# as a crude countermeasure against spambots, anonymous connections younger
|
||||||
|
# than this value will get an empty response to /LIST (a time period of 0 disables)
|
||||||
|
list-delay: 0s
|
||||||
|
|
||||||
|
# INVITE to an invite-only channel expires after this amount of time
|
||||||
|
# (0 or omit for no expiration):
|
||||||
|
invite-expiration: 24h
|
||||||
|
|
||||||
|
# channels that new clients will automatically join. this should be used with
|
||||||
|
# caution, since traditional IRC users will likely view it as an antifeature.
|
||||||
|
# it may be useful in small community networks that have a single "primary" channel:
|
||||||
|
auto-join:
|
||||||
|
- "#chat"
|
||||||
|
- "#announcements"
|
||||||
|
|
||||||
|
# operator classes:
|
||||||
|
# an operator has a single "class" (defining a privilege level), which can include
|
||||||
|
# multiple "capabilities" (defining privileged actions they can take). all
|
||||||
|
# currently available operator capabilities are associated with either the
|
||||||
|
# 'chat-moderator' class (less privileged) or the 'server-admin' class (full
|
||||||
|
# privileges) below: you can mix and match to create new classes.
|
||||||
|
oper-classes:
|
||||||
|
# chat moderator: can ban/unban users from the server, join channels,
|
||||||
|
# fix mode issues and sort out vhosts.
|
||||||
|
"chat-moderator":
|
||||||
|
# title shown in WHOIS
|
||||||
|
title: Chat Moderator
|
||||||
|
|
||||||
|
# capability names
|
||||||
|
capabilities:
|
||||||
|
- "kill" # disconnect user sessions
|
||||||
|
- "ban" # ban IPs, CIDRs, NUH masks, and suspend accounts (UBAN / DLINE / KLINE)
|
||||||
|
- "nofakelag" # exempted from "fakelag" restrictions on rate of message sending
|
||||||
|
- "relaymsg" # use RELAYMSG in any channel (see the `relaymsg` config block)
|
||||||
|
- "vhosts" # add and remove vhosts from users
|
||||||
|
- "sajoin" # join arbitrary channels, including private channels
|
||||||
|
- "samode" # modify arbitrary channel and user modes
|
||||||
|
- "snomasks" # subscribe to arbitrary server notice masks
|
||||||
|
- "roleplay" # use the (deprecated) roleplay commands in any channel
|
||||||
|
|
||||||
|
# server admin: has full control of the ircd, including nickname and
|
||||||
|
# channel registrations
|
||||||
|
"server-admin":
|
||||||
|
# title shown in WHOIS
|
||||||
|
title: Server Admin
|
||||||
|
|
||||||
|
# oper class this extends from
|
||||||
|
extends: "chat-moderator"
|
||||||
|
|
||||||
|
# capability names
|
||||||
|
capabilities:
|
||||||
|
- "rehash" # rehash the server, i.e. reload the config at runtime
|
||||||
|
- "accreg" # modify arbitrary account registrations
|
||||||
|
- "chanreg" # modify arbitrary channel registrations
|
||||||
|
- "history" # modify or delete history messages
|
||||||
|
- "defcon" # use the DEFCON command (restrict server capabilities)
|
||||||
|
- "massmessage" # message all users on the server
|
||||||
|
|
||||||
|
# ircd operators
|
||||||
|
opers:
|
||||||
|
#Failure:
|
||||||
|
# class: "server-admin"
|
||||||
|
# hidden: true
|
||||||
|
# whois-line: is the server administrator
|
||||||
|
# password: ""
|
||||||
|
|
||||||
|
# logging, takes inspiration from Insp
|
||||||
|
logging:
|
||||||
|
-
|
||||||
|
# how to log these messages
|
||||||
|
#
|
||||||
|
# file log to a file
|
||||||
|
# stdout log to stdout
|
||||||
|
# stderr log to stderr
|
||||||
|
# (you can specify multiple methods, e.g., to log to both stderr and a file)
|
||||||
|
method: stderr
|
||||||
|
|
||||||
|
# filename to log to, if file method is selected
|
||||||
|
# filename: ircd.log
|
||||||
|
|
||||||
|
# type(s) of logs to keep here. you can use - to exclude those types
|
||||||
|
#
|
||||||
|
# exclusions take precedent over inclusions, so if you exclude a type it will NEVER
|
||||||
|
# be logged, even if you explicitly include it
|
||||||
|
#
|
||||||
|
# useful types include:
|
||||||
|
# * everything (usually used with exclusing some types below)
|
||||||
|
# server server startup, rehash, and shutdown events
|
||||||
|
# accounts account registration and authentication
|
||||||
|
# channels channel creation and operations
|
||||||
|
# opers oper actions, authentication, etc
|
||||||
|
# services actions related to NickServ, ChanServ, etc.
|
||||||
|
# internal unexpected runtime behavior, including potential bugs
|
||||||
|
# userinput raw lines sent by users
|
||||||
|
# useroutput raw lines sent to users
|
||||||
|
type: "* -userinput -useroutput"
|
||||||
|
|
||||||
|
# one of: debug info warn error
|
||||||
|
level: info
|
||||||
|
#-
|
||||||
|
# # example of a file log that avoids logging IP addresses
|
||||||
|
# method: file
|
||||||
|
# filename: ircd.log
|
||||||
|
# type: "* -userinput -useroutput -connect-ip"
|
||||||
|
# level: debug
|
||||||
|
|
||||||
|
# debug options
|
||||||
|
debug:
|
||||||
|
# when enabled, Ergo will attempt to recover from certain kinds of
|
||||||
|
# client-triggered runtime errors that would normally crash the server.
|
||||||
|
# this makes the server more resilient to DoS, but could result in incorrect
|
||||||
|
# behavior. deployments that would prefer to "start from scratch", e.g., by
|
||||||
|
# letting the process crash and auto-restarting it with systemd, can set
|
||||||
|
# this to false.
|
||||||
|
recover-from-errors: true
|
||||||
|
|
||||||
|
# optionally expose a pprof http endpoint: https://golang.org/pkg/net/http/pprof/
|
||||||
|
# it is strongly recommended that you don't expose this on a public interface;
|
||||||
|
# if you need to access it remotely, you can use an SSH tunnel.
|
||||||
|
# set to `null`, "", leave blank, or omit to disable
|
||||||
|
# pprof-listener: "localhost:6060"
|
||||||
|
|
||||||
|
# lock file preventing multiple instances of Ergo from accidentally being
|
||||||
|
# started at once. comment out or set to the empty string ("") to disable.
|
||||||
|
# this path is relative to the working directory; if your datastore.path
|
||||||
|
# is absolute, you should use an absolute path here as well.
|
||||||
|
lock-file: "ircd.lock"
|
||||||
|
|
||||||
|
# datastore configuration
|
||||||
|
datastore:
|
||||||
|
# path to the datastore
|
||||||
|
path: persist/ircd.db
|
||||||
|
|
||||||
|
# if the database schema requires an upgrade, `autoupgrade` will attempt to
|
||||||
|
# perform it automatically on startup. the database will be backed
|
||||||
|
# up, and if the upgrade fails, the original database will be restored.
|
||||||
|
autoupgrade: true
|
||||||
|
|
||||||
|
# connection information for MySQL (currently only used for persistent history):
|
||||||
|
mysql:
|
||||||
|
enabled: true
|
||||||
|
host: "mariadb"
|
||||||
|
port: 3306
|
||||||
|
# if socket-path is set, it will be used instead of host:port
|
||||||
|
#socket-path: "/var/run/mysqld/mysqld.sock"
|
||||||
|
user: "root"
|
||||||
|
password: "willbeoverwritten"
|
||||||
|
history-database: "ergo"
|
||||||
|
timeout: 3s
|
||||||
|
max-conns: 4
|
||||||
|
# this may be necessary to prevent middleware from closing your connections:
|
||||||
|
#conn-max-lifetime: 180s
|
||||||
|
|
||||||
|
# languages config
|
||||||
|
languages:
|
||||||
|
# whether to load languages
|
||||||
|
enabled: true
|
||||||
|
|
||||||
|
# default language to use for new clients
|
||||||
|
# 'en' is the default English language in the code
|
||||||
|
default: en
|
||||||
|
|
||||||
|
# which directory contains our language files
|
||||||
|
path: /ircd-bin/languages
|
||||||
|
|
||||||
|
# limits - these need to be the same across the network
|
||||||
|
limits:
|
||||||
|
# nicklen is the max nick length allowed
|
||||||
|
nicklen: 32
|
||||||
|
|
||||||
|
# identlen is the max ident length allowed
|
||||||
|
identlen: 20
|
||||||
|
|
||||||
|
# channellen is the max channel length allowed
|
||||||
|
channellen: 64
|
||||||
|
|
||||||
|
# awaylen is the maximum length of an away message
|
||||||
|
awaylen: 390
|
||||||
|
|
||||||
|
# kicklen is the maximum length of a kick message
|
||||||
|
kicklen: 390
|
||||||
|
|
||||||
|
# topiclen is the maximum length of a channel topic
|
||||||
|
topiclen: 390
|
||||||
|
|
||||||
|
# maximum number of monitor entries a client can have
|
||||||
|
monitor-entries: 100
|
||||||
|
|
||||||
|
# whowas entries to store
|
||||||
|
whowas-entries: 100
|
||||||
|
|
||||||
|
# maximum length of channel lists (beI modes)
|
||||||
|
chan-list-modes: 60
|
||||||
|
|
||||||
|
# maximum number of messages to accept during registration (prevents
|
||||||
|
# DoS / resource exhaustion attacks):
|
||||||
|
registration-messages: 1024
|
||||||
|
|
||||||
|
# message length limits for the new multiline cap
|
||||||
|
multiline:
|
||||||
|
max-bytes: 4096 # 0 means disabled
|
||||||
|
max-lines: 100 # 0 means no limit
|
||||||
|
|
||||||
|
# fakelag: prevents clients from spamming commands too rapidly
|
||||||
|
fakelag:
|
||||||
|
# whether to enforce fakelag
|
||||||
|
enabled: true
|
||||||
|
|
||||||
|
# time unit for counting command rates
|
||||||
|
window: 1s
|
||||||
|
|
||||||
|
# clients can send this many commands without fakelag being imposed
|
||||||
|
burst-limit: 5
|
||||||
|
|
||||||
|
# once clients have exceeded their burst allowance, they can send only
|
||||||
|
# this many commands per `window`:
|
||||||
|
messages-per-window: 2
|
||||||
|
|
||||||
|
# client status resets to the default state if they go this long without
|
||||||
|
# sending any commands:
|
||||||
|
cooldown: 2s
|
||||||
|
|
||||||
|
# exempt a certain number of command invocations per session from fakelag;
|
||||||
|
# this is to speed up "resynchronization" of client state during reattach
|
||||||
|
command-budgets:
|
||||||
|
"CHATHISTORY": 16
|
||||||
|
"MARKREAD": 16
|
||||||
|
"MONITOR": 1
|
||||||
|
"WHO": 4
|
||||||
|
|
||||||
|
# the roleplay commands are semi-standardized extensions to IRC that allow
|
||||||
|
# sending and receiving messages from pseudo-nicknames. this can be used either
|
||||||
|
# for actual roleplaying, or for bridging IRC with other protocols.
|
||||||
|
roleplay:
|
||||||
|
# are roleplay commands enabled at all? (channels and clients still have to
|
||||||
|
# opt in individually with the +E mode)
|
||||||
|
enabled: true
|
||||||
|
|
||||||
|
# require the "roleplay" oper capability to send roleplay messages?
|
||||||
|
require-oper: false
|
||||||
|
|
||||||
|
# require channel operator permissions to send roleplay messages?
|
||||||
|
require-chanops: false
|
||||||
|
|
||||||
|
# add the real nickname, in parentheses, to the end of every roleplay message?
|
||||||
|
add-suffix: true
|
||||||
|
|
||||||
|
# external services can integrate with the ircd using JSON Web Tokens (https://jwt.io).
|
||||||
|
# in effect, the server can sign a token attesting that the client is present on
|
||||||
|
# the server, is a member of a particular channel, etc.
|
||||||
|
extjwt:
|
||||||
|
# # default service config (for `EXTJWT #channel`).
|
||||||
|
# # expiration time for the token:
|
||||||
|
expiration: 45s
|
||||||
|
# # you can configure tokens to be signed either with HMAC and a symmetric secret:
|
||||||
|
#secret: "65PHvk0K1_sM-raTsCEhatVkER_QD8a0zVV8gG2EWcI"
|
||||||
|
# # or with an RSA private key:
|
||||||
|
#rsa-private-key-file: "privkey.pem"
|
||||||
|
|
||||||
|
# # named services (for `EXTJWT #channel service_name`):
|
||||||
|
services:
|
||||||
|
"3m":
|
||||||
|
expiration: 60s
|
||||||
|
rsa-private-key-file: "certs/3m.pem"
|
||||||
|
"grumble":
|
||||||
|
expiration: 30s
|
||||||
|
rsa-private-key-file: "certs/grumble.pem"
|
||||||
|
|
||||||
|
# history message storage: this is used by CHATHISTORY, HISTORY, znc.in/playback,
|
||||||
|
# various autoreplay features, and the resume extension
|
||||||
|
history:
|
||||||
|
# should we store messages for later playback?
|
||||||
|
# by default, messages are stored in RAM only; they do not persist
|
||||||
|
# across server restarts. however, you may want to understand how message
|
||||||
|
# history interacts with the GDPR and/or any data privacy laws that apply
|
||||||
|
# in your country and the countries of your users.
|
||||||
|
enabled: true
|
||||||
|
|
||||||
|
# how many channel-specific events (messages, joins, parts) should be tracked per channel?
|
||||||
|
channel-length: 2048
|
||||||
|
|
||||||
|
# how many direct messages and notices should be tracked per user?
|
||||||
|
client-length: 256
|
||||||
|
|
||||||
|
# how long should we try to preserve messages?
|
||||||
|
# if `autoresize-window` is 0, the in-memory message buffers are preallocated to
|
||||||
|
# their maximum length. if it is nonzero, the buffers are initially small and
|
||||||
|
# are dynamically expanded up to the maximum length. if the buffer is full
|
||||||
|
# and the oldest message is older than `autoresize-window`, then it will overwrite
|
||||||
|
# the oldest message rather than resize; otherwise, it will expand if possible.
|
||||||
|
autoresize-window: 3d
|
||||||
|
|
||||||
|
# number of messages to automatically play back on channel join (0 to disable):
|
||||||
|
autoreplay-on-join: 0
|
||||||
|
|
||||||
|
# maximum number of CHATHISTORY messages that can be
|
||||||
|
# requested at once (0 disables support for CHATHISTORY)
|
||||||
|
chathistory-maxmessages: 1000
|
||||||
|
|
||||||
|
# maximum number of messages that can be replayed at once during znc emulation
|
||||||
|
# (znc.in/playback, or automatic replay on initial reattach to a persistent client):
|
||||||
|
znc-maxmessages: 2048
|
||||||
|
|
||||||
|
# options to delete old messages, or prevent them from being retrieved
|
||||||
|
restrictions:
|
||||||
|
# if this is set, messages older than this cannot be retrieved by anyone
|
||||||
|
# (and will eventually be deleted from persistent storage, if that's enabled)
|
||||||
|
expire-time: 1w
|
||||||
|
|
||||||
|
# this restricts access to channel history (it can be overridden by channel
|
||||||
|
# owners). options are: 'none' (no restrictions), 'registration-time'
|
||||||
|
# (logged-in users cannot retrieve messages older than their account
|
||||||
|
# registration date, and anonymous users cannot retrieve messages older than
|
||||||
|
# their sign-on time, modulo the grace-period described below), and
|
||||||
|
# 'join-time' (users cannot retrieve messages older than the time they
|
||||||
|
# joined the channel, so only always-on clients can view history).
|
||||||
|
query-cutoff: 'none'
|
||||||
|
|
||||||
|
# if query-cutoff is set to 'registration-time', this allows retrieval
|
||||||
|
# of messages that are up to 'grace-period' older than the above cutoff.
|
||||||
|
# if you use 'registration-time', this is recommended to allow logged-out
|
||||||
|
# users to query history after disconnections.
|
||||||
|
grace-period: 1h
|
||||||
|
|
||||||
|
# options to store history messages in a persistent database (currently only MySQL).
|
||||||
|
# in order to enable any of this functionality, you must configure a MySQL server
|
||||||
|
# in the `datastore.mysql` section. enabling persistence overrides the history
|
||||||
|
# size limits above (`channel-length`, `client-length`, etc.); persistent
|
||||||
|
# history has no limits other than those imposed by expire-time.
|
||||||
|
persistent:
|
||||||
|
enabled: true
|
||||||
|
|
||||||
|
# store unregistered channel messages in the persistent database?
|
||||||
|
unregistered-channels: false
|
||||||
|
|
||||||
|
# for a registered channel, the channel owner can potentially customize
|
||||||
|
# the history storage setting. as the server operator, your options are
|
||||||
|
# 'disabled' (no persistent storage, regardless of per-channel setting),
|
||||||
|
# 'opt-in', 'opt-out', and 'mandatory' (force persistent storage, ignoring
|
||||||
|
# per-channel setting):
|
||||||
|
registered-channels: "opt-out"
|
||||||
|
|
||||||
|
# direct messages are only stored in the database for logged-in clients;
|
||||||
|
# you can control how they are stored here (same options as above).
|
||||||
|
# if you enable this, strict nickname reservation is strongly recommended
|
||||||
|
# as well.
|
||||||
|
direct-messages: "opt-out"
|
||||||
|
|
||||||
|
# options to control how messages are stored and deleted:
|
||||||
|
retention:
|
||||||
|
# allow users to delete their own messages from history,
|
||||||
|
# and channel operators to delete messages in their channel?
|
||||||
|
allow-individual-delete: true
|
||||||
|
|
||||||
|
# if persistent history is enabled, create additional index tables,
|
||||||
|
# allowing deletion of JSON export of an account's messages. this
|
||||||
|
# may be needed for compliance with data privacy regulations.
|
||||||
|
enable-account-indexing: false
|
||||||
|
|
||||||
|
# options to control storage of TAGMSG
|
||||||
|
tagmsg-storage:
|
||||||
|
# by default, should TAGMSG be stored?
|
||||||
|
default: true
|
||||||
|
|
||||||
|
# if `default` is false, store TAGMSG containing any of these tags:
|
||||||
|
whitelist:
|
||||||
|
- "+draft/react"
|
||||||
|
- "+react"
|
||||||
|
|
||||||
|
# if `default` is true, don't store TAGMSG containing any of these tags:
|
||||||
|
#blacklist:
|
||||||
|
# - "+draft/typing"
|
||||||
|
# - "typing"
|
||||||
|
|
||||||
|
# whether to allow customization of the config at runtime using environment variables,
|
||||||
|
# e.g., ERGO__SERVER__MAX_SENDQ=128k. see the manual for more details.
|
||||||
|
allow-environment-overrides: true
|
||||||
|
|
||||||
|
cef:
|
||||||
|
imagor:
|
||||||
|
# to be overwritten by envs
|
||||||
|
url: "https://example.com/embed/"
|
||||||
|
secret: "secretgoeshere"
|
||||||
|
redis: "redis://redis:6379/0?protocol=3"
|
||||||
2
configs/mariadb/init.sql
Normal file
2
configs/mariadb/init.sql
Normal file
|
|
@ -0,0 +1,2 @@
|
||||||
|
CREATE DATABASE ergo;
|
||||||
|
-- CREATE DATABASE ergo_ext;
|
||||||
697
configs/mediamtx/mediamtx.yaml
Normal file
697
configs/mediamtx/mediamtx.yaml
Normal file
|
|
@ -0,0 +1,697 @@
|
||||||
|
###############################################
|
||||||
|
# Global settings
|
||||||
|
|
||||||
|
# Settings in this section are applied anywhere.
|
||||||
|
|
||||||
|
###############################################
|
||||||
|
# Global settings -> General
|
||||||
|
|
||||||
|
# Verbosity of the program; available values are "error", "warn", "info", "debug".
|
||||||
|
logLevel: info
|
||||||
|
# Destinations of log messages; available values are "stdout", "file" and "syslog".
|
||||||
|
logDestinations: [stdout]
|
||||||
|
# If "file" is in logDestinations, this is the file which will receive the logs.
|
||||||
|
logFile: mediamtx.log
|
||||||
|
|
||||||
|
# Timeout of read operations.
|
||||||
|
readTimeout: 10s
|
||||||
|
# Timeout of write operations.
|
||||||
|
writeTimeout: 10s
|
||||||
|
# Size of the queue of outgoing packets.
|
||||||
|
# A higher value allows to increase throughput, a lower value allows to save RAM.
|
||||||
|
writeQueueSize: 512
|
||||||
|
# Maximum size of outgoing UDP packets.
|
||||||
|
# This can be decreased to avoid fragmentation on networks with a low UDP MTU.
|
||||||
|
udpMaxPayloadSize: 1472
|
||||||
|
|
||||||
|
# Command to run when a client connects to the server.
|
||||||
|
# This is terminated with SIGINT when a client disconnects from the server.
|
||||||
|
# The following environment variables are available:
|
||||||
|
# * RTSP_PORT: RTSP server port
|
||||||
|
# * MTX_CONN_TYPE: connection type
|
||||||
|
# * MTX_CONN_ID: connection ID
|
||||||
|
runOnConnect:
|
||||||
|
# Restart the command if it exits.
|
||||||
|
runOnConnectRestart: no
|
||||||
|
# Command to run when a client disconnects from the server.
|
||||||
|
# Environment variables are the same of runOnConnect.
|
||||||
|
runOnDisconnect:
|
||||||
|
|
||||||
|
###############################################
|
||||||
|
# Global settings -> Authentication
|
||||||
|
|
||||||
|
# Authentication method. Available values are:
|
||||||
|
# * internal: users are stored in the configuration file
|
||||||
|
# * http: an external HTTP URL is contacted to perform authentication
|
||||||
|
# * jwt: an external identity server provides authentication through JWTs
|
||||||
|
authMethod: http
|
||||||
|
|
||||||
|
# Internal authentication.
|
||||||
|
# list of users.
|
||||||
|
authInternalUsers:
|
||||||
|
# Default unprivileged user.
|
||||||
|
# Username. 'any' means any user, including anonymous ones.
|
||||||
|
- user: any
|
||||||
|
# Password. Not used in case of 'any' user.
|
||||||
|
pass:
|
||||||
|
# IPs or networks allowed to use this user. An empty list means any IP.
|
||||||
|
ips: []
|
||||||
|
# List of permissions.
|
||||||
|
permissions:
|
||||||
|
# Available actions are: publish, read, playback, api, metrics, pprof.
|
||||||
|
- action: publish
|
||||||
|
# Paths can be set to further restrict access to a specific path.
|
||||||
|
# An empty path means any path.
|
||||||
|
# Regular expressions can be used by using a tilde as prefix.
|
||||||
|
path:
|
||||||
|
- action: read
|
||||||
|
path:
|
||||||
|
- action: playback
|
||||||
|
path:
|
||||||
|
|
||||||
|
# Default administrator.
|
||||||
|
# This allows to use API, metrics and PPROF without authentication,
|
||||||
|
# if the IP is localhost.
|
||||||
|
- user: any
|
||||||
|
pass:
|
||||||
|
ips: ['127.0.0.1', '::1']
|
||||||
|
permissions:
|
||||||
|
- action: api
|
||||||
|
- action: metrics
|
||||||
|
- action: pprof
|
||||||
|
|
||||||
|
# HTTP-based authentication.
|
||||||
|
# URL called to perform authentication. Every time a user wants
|
||||||
|
# to authenticate, the server calls this URL with the POST method
|
||||||
|
# and a body containing:
|
||||||
|
# {
|
||||||
|
# "user": "user",
|
||||||
|
# "password": "password",
|
||||||
|
# "ip": "ip",
|
||||||
|
# "action": "publish|read|playback|api|metrics|pprof",
|
||||||
|
# "path": "path",
|
||||||
|
# "protocol": "rtsp|rtmp|hls|webrtc|srt",
|
||||||
|
# "id": "id",
|
||||||
|
# "query": "query"
|
||||||
|
# }
|
||||||
|
# If the response code is 20x, authentication is accepted, otherwise
|
||||||
|
# it is discarded.
|
||||||
|
authHTTPAddress: http://3m:8001/mediamtx/auth
|
||||||
|
|
||||||
|
# Actions to exclude from HTTP-based authentication.
|
||||||
|
# Format is the same as the one of user permissions.
|
||||||
|
authHTTPExclude:
|
||||||
|
- action: api
|
||||||
|
- action: metrics
|
||||||
|
- action: pprof
|
||||||
|
|
||||||
|
# JWT-based authentication.
|
||||||
|
# Users have to login through an external identity server and obtain a JWT.
|
||||||
|
# This JWT must contain the claim "mediamtx_permissions" with permissions,
|
||||||
|
# for instance:
|
||||||
|
# {
|
||||||
|
# ...
|
||||||
|
# "mediamtx_permissions": [
|
||||||
|
# {
|
||||||
|
# "action": "publish",
|
||||||
|
# "path": "somepath"
|
||||||
|
# }
|
||||||
|
# ]
|
||||||
|
# }
|
||||||
|
# Users are then expected to pass the JWT as a query parameter, i.e. ?jwt=...
|
||||||
|
# This is the JWKS URL that will be used to pull (once) the public key that allows
|
||||||
|
# to validate JWTs.
|
||||||
|
authJWTJWKS:
|
||||||
|
|
||||||
|
###############################################
|
||||||
|
# Global settings -> Control API
|
||||||
|
|
||||||
|
# Enable controlling the server through the Control API.
|
||||||
|
api: yes
|
||||||
|
# Address of the Control API listener.
|
||||||
|
apiAddress: :9997
|
||||||
|
# Enable TLS/HTTPS on the Control API server.
|
||||||
|
apiEncryption: no
|
||||||
|
# Path to the server key. This is needed only when encryption is yes.
|
||||||
|
# This can be generated with:
|
||||||
|
# openssl genrsa -out server.key 2048
|
||||||
|
# openssl req -new -x509 -sha256 -key server.key -out server.crt -days 3650
|
||||||
|
apiServerKey: server.key
|
||||||
|
# Path to the server certificate.
|
||||||
|
apiServerCert: server.crt
|
||||||
|
# Value of the Access-Control-Allow-Origin header provided in every HTTP response.
|
||||||
|
apiAllowOrigin: '*'
|
||||||
|
# List of IPs or CIDRs of proxies placed before the HTTP server.
|
||||||
|
# If the server receives a request from one of these entries, IP in logs
|
||||||
|
# will be taken from the X-Forwarded-For header.
|
||||||
|
apiTrustedProxies: []
|
||||||
|
|
||||||
|
###############################################
|
||||||
|
# Global settings -> Metrics
|
||||||
|
|
||||||
|
# Enable Prometheus-compatible metrics.
|
||||||
|
metrics: no
|
||||||
|
# Address of the metrics HTTP listener.
|
||||||
|
metricsAddress: :9998
|
||||||
|
# Enable TLS/HTTPS on the Metrics server.
|
||||||
|
metricsEncryption: no
|
||||||
|
# Path to the server key. This is needed only when encryption is yes.
|
||||||
|
# This can be generated with:
|
||||||
|
# openssl genrsa -out server.key 2048
|
||||||
|
# openssl req -new -x509 -sha256 -key server.key -out server.crt -days 3650
|
||||||
|
metricsServerKey: server.key
|
||||||
|
# Path to the server certificate.
|
||||||
|
metricsServerCert: server.crt
|
||||||
|
# Value of the Access-Control-Allow-Origin header provided in every HTTP response.
|
||||||
|
metricsAllowOrigin: '*'
|
||||||
|
# List of IPs or CIDRs of proxies placed before the HTTP server.
|
||||||
|
# If the server receives a request from one of these entries, IP in logs
|
||||||
|
# will be taken from the X-Forwarded-For header.
|
||||||
|
metricsTrustedProxies: []
|
||||||
|
|
||||||
|
###############################################
|
||||||
|
# Global settings -> PPROF
|
||||||
|
|
||||||
|
# Enable pprof-compatible endpoint to monitor performances.
|
||||||
|
pprof: no
|
||||||
|
# Address of the pprof listener.
|
||||||
|
pprofAddress: :9999
|
||||||
|
# Enable TLS/HTTPS on the pprof server.
|
||||||
|
pprofEncryption: no
|
||||||
|
# Path to the server key. This is needed only when encryption is yes.
|
||||||
|
# This can be generated with:
|
||||||
|
# openssl genrsa -out server.key 2048
|
||||||
|
# openssl req -new -x509 -sha256 -key server.key -out server.crt -days 3650
|
||||||
|
pprofServerKey: server.key
|
||||||
|
# Path to the server certificate.
|
||||||
|
pprofServerCert: server.crt
|
||||||
|
# Value of the Access-Control-Allow-Origin header provided in every HTTP response.
|
||||||
|
pprofAllowOrigin: '*'
|
||||||
|
# List of IPs or CIDRs of proxies placed before the HTTP server.
|
||||||
|
# If the server receives a request from one of these entries, IP in logs
|
||||||
|
# will be taken from the X-Forwarded-For header.
|
||||||
|
pprofTrustedProxies: []
|
||||||
|
|
||||||
|
###############################################
|
||||||
|
# Global settings -> Playback server
|
||||||
|
|
||||||
|
# Enable downloading recordings from the playback server.
|
||||||
|
playback: no
|
||||||
|
# Address of the playback server listener.
|
||||||
|
playbackAddress: :9996
|
||||||
|
# Enable TLS/HTTPS on the playback server.
|
||||||
|
playbackEncryption: no
|
||||||
|
# Path to the server key. This is needed only when encryption is yes.
|
||||||
|
# This can be generated with:
|
||||||
|
# openssl genrsa -out server.key 2048
|
||||||
|
# openssl req -new -x509 -sha256 -key server.key -out server.crt -days 3650
|
||||||
|
playbackServerKey: server.key
|
||||||
|
# Path to the server certificate.
|
||||||
|
playbackServerCert: server.crt
|
||||||
|
# Value of the Access-Control-Allow-Origin header provided in every HTTP response.
|
||||||
|
playbackAllowOrigin: '*'
|
||||||
|
# List of IPs or CIDRs of proxies placed before the HTTP server.
|
||||||
|
# If the server receives a request from one of these entries, IP in logs
|
||||||
|
# will be taken from the X-Forwarded-For header.
|
||||||
|
playbackTrustedProxies: []
|
||||||
|
|
||||||
|
###############################################
|
||||||
|
# Global settings -> RTSP server
|
||||||
|
|
||||||
|
# Enable publishing and reading streams with the RTSP protocol.
|
||||||
|
rtsp: yes
|
||||||
|
# List of enabled RTSP transport protocols.
|
||||||
|
# UDP is the most performant, but doesn't work when there's a NAT/firewall between
|
||||||
|
# server and clients, and doesn't support encryption.
|
||||||
|
# UDP-multicast allows to save bandwidth when clients are all in the same LAN.
|
||||||
|
# TCP is the most versatile, and does support encryption.
|
||||||
|
# The handshake is always performed with TCP.
|
||||||
|
protocols: [udp, multicast, tcp]
|
||||||
|
# Encrypt handshakes and TCP streams with TLS (RTSPS).
|
||||||
|
# Available values are "no", "strict", "optional".
|
||||||
|
encryption: "no"
|
||||||
|
# Address of the TCP/RTSP listener. This is needed only when encryption is "no" or "optional".
|
||||||
|
rtspAddress: :8554
|
||||||
|
# Address of the TCP/TLS/RTSPS listener. This is needed only when encryption is "strict" or "optional".
|
||||||
|
rtspsAddress: :8322
|
||||||
|
# Address of the UDP/RTP listener. This is needed only when "udp" is in protocols.
|
||||||
|
rtpAddress: :8000
|
||||||
|
# Address of the UDP/RTCP listener. This is needed only when "udp" is in protocols.
|
||||||
|
rtcpAddress: :8001
|
||||||
|
# IP range of all UDP-multicast listeners. This is needed only when "multicast" is in protocols.
|
||||||
|
multicastIPRange: 224.1.0.0/16
|
||||||
|
# Port of all UDP-multicast/RTP listeners. This is needed only when "multicast" is in protocols.
|
||||||
|
multicastRTPPort: 8002
|
||||||
|
# Port of all UDP-multicast/RTCP listeners. This is needed only when "multicast" is in protocols.
|
||||||
|
multicastRTCPPort: 8003
|
||||||
|
# Path to the server key. This is needed only when encryption is "strict" or "optional".
|
||||||
|
# This can be generated with:
|
||||||
|
# openssl genrsa -out server.key 2048
|
||||||
|
# openssl req -new -x509 -sha256 -key server.key -out server.crt -days 3650
|
||||||
|
serverKey: server.key
|
||||||
|
# Path to the server certificate. This is needed only when encryption is "strict" or "optional".
|
||||||
|
serverCert: server.crt
|
||||||
|
# Authentication methods. Available are "basic" and "digest".
|
||||||
|
# "digest" doesn't provide any additional security and is available for compatibility only.
|
||||||
|
rtspAuthMethods: []
|
||||||
|
|
||||||
|
###############################################
|
||||||
|
# Global settings -> RTMP server
|
||||||
|
|
||||||
|
# Enable publishing and reading streams with the RTMP protocol.
|
||||||
|
rtmp: yes
|
||||||
|
# Address of the RTMP listener. This is needed only when encryption is "no" or "optional".
|
||||||
|
rtmpAddress: :1935
|
||||||
|
# Encrypt connections with TLS (RTMPS).
|
||||||
|
# Available values are "no", "strict", "optional".
|
||||||
|
rtmpEncryption: "no"
|
||||||
|
# Address of the RTMPS listener. This is needed only when encryption is "strict" or "optional".
|
||||||
|
rtmpsAddress: :1936
|
||||||
|
# Path to the server key. This is needed only when encryption is "strict" or "optional".
|
||||||
|
# This can be generated with:
|
||||||
|
# openssl genrsa -out server.key 2048
|
||||||
|
# openssl req -new -x509 -sha256 -key server.key -out server.crt -days 3650
|
||||||
|
rtmpServerKey: server.key
|
||||||
|
# Path to the server certificate. This is needed only when encryption is "strict" or "optional".
|
||||||
|
rtmpServerCert: server.crt
|
||||||
|
|
||||||
|
###############################################
|
||||||
|
# Global settings -> HLS server
|
||||||
|
|
||||||
|
# Enable reading streams with the HLS protocol.
|
||||||
|
hls: no
|
||||||
|
# Address of the HLS listener.
|
||||||
|
hlsAddress: :8888
|
||||||
|
# Enable TLS/HTTPS on the HLS server.
|
||||||
|
# This is required for Low-Latency HLS.
|
||||||
|
hlsEncryption: no
|
||||||
|
# Path to the server key. This is needed only when encryption is yes.
|
||||||
|
# This can be generated with:
|
||||||
|
# openssl genrsa -out server.key 2048
|
||||||
|
# openssl req -new -x509 -sha256 -key server.key -out server.crt -days 3650
|
||||||
|
hlsServerKey: server.key
|
||||||
|
# Path to the server certificate.
|
||||||
|
hlsServerCert: server.crt
|
||||||
|
# Value of the Access-Control-Allow-Origin header provided in every HTTP response.
|
||||||
|
# This allows to play the HLS stream from an external website.
|
||||||
|
hlsAllowOrigin: '*'
|
||||||
|
# List of IPs or CIDRs of proxies placed before the HLS server.
|
||||||
|
# If the server receives a request from one of these entries, IP in logs
|
||||||
|
# will be taken from the X-Forwarded-For header.
|
||||||
|
hlsTrustedProxies: []
|
||||||
|
# By default, HLS is generated only when requested by a user.
|
||||||
|
# This option allows to generate it always, avoiding the delay between request and generation.
|
||||||
|
hlsAlwaysRemux: no
|
||||||
|
# Variant of the HLS protocol to use. Available options are:
|
||||||
|
# * mpegts - uses MPEG-TS segments, for maximum compatibility.
|
||||||
|
# * fmp4 - uses fragmented MP4 segments, more efficient.
|
||||||
|
# * lowLatency - uses Low-Latency HLS.
|
||||||
|
hlsVariant: lowLatency
|
||||||
|
# Number of HLS segments to keep on the server.
|
||||||
|
# Segments allow to seek through the stream.
|
||||||
|
# Their number doesn't influence latency.
|
||||||
|
hlsSegmentCount: 7
|
||||||
|
# Minimum duration of each segment.
|
||||||
|
# A player usually puts 3 segments in a buffer before reproducing the stream.
|
||||||
|
# The final segment duration is also influenced by the interval between IDR frames,
|
||||||
|
# since the server changes the duration in order to include at least one IDR frame
|
||||||
|
# in each segment.
|
||||||
|
hlsSegmentDuration: 1s
|
||||||
|
# Minimum duration of each part.
|
||||||
|
# A player usually puts 3 parts in a buffer before reproducing the stream.
|
||||||
|
# Parts are used in Low-Latency HLS in place of segments.
|
||||||
|
# Part duration is influenced by the distance between video/audio samples
|
||||||
|
# and is adjusted in order to produce segments with a similar duration.
|
||||||
|
hlsPartDuration: 200ms
|
||||||
|
# Maximum size of each segment.
|
||||||
|
# This prevents RAM exhaustion.
|
||||||
|
hlsSegmentMaxSize: 50M
|
||||||
|
# Directory in which to save segments, instead of keeping them in the RAM.
|
||||||
|
# This decreases performance, since reading from disk is less performant than
|
||||||
|
# reading from RAM, but allows to save RAM.
|
||||||
|
hlsDirectory: ''
|
||||||
|
# The muxer will be closed when there are no
|
||||||
|
# reader requests and this amount of time has passed.
|
||||||
|
hlsMuxerCloseAfter: 60s
|
||||||
|
|
||||||
|
###############################################
|
||||||
|
# Global settings -> WebRTC server
|
||||||
|
|
||||||
|
# Enable publishing and reading streams with the WebRTC protocol.
|
||||||
|
webrtc: yes
|
||||||
|
# Address of the WebRTC HTTP listener.
|
||||||
|
webrtcAddress: :8889
|
||||||
|
# Enable TLS/HTTPS on the WebRTC server.
|
||||||
|
webrtcEncryption: no
|
||||||
|
# Path to the server key.
|
||||||
|
# This can be generated with:
|
||||||
|
# openssl genrsa -out server.key 2048
|
||||||
|
# openssl req -new -x509 -sha256 -key server.key -out server.crt -days 3650
|
||||||
|
webrtcServerKey: server.key
|
||||||
|
# Path to the server certificate.
|
||||||
|
webrtcServerCert: server.crt
|
||||||
|
# Value of the Access-Control-Allow-Origin header provided in every HTTP response.
|
||||||
|
# This allows to play the WebRTC stream from an external website.
|
||||||
|
webrtcAllowOrigin: '*'
|
||||||
|
# List of IPs or CIDRs of proxies placed before the WebRTC server.
|
||||||
|
# If the server receives a request from one of these entries, IP in logs
|
||||||
|
# will be taken from the X-Forwarded-For header.
|
||||||
|
webrtcTrustedProxies: ["127.0.0.1", "172.16.0.0/12"]
|
||||||
|
# Address of a local UDP listener that will receive connections.
|
||||||
|
# Use a blank string to disable.
|
||||||
|
webrtcLocalUDPAddress: :8189
|
||||||
|
# Address of a local TCP listener that will receive connections.
|
||||||
|
# This is disabled by default since TCP is less efficient than UDP and
|
||||||
|
# introduces a progressive delay when network is congested.
|
||||||
|
webrtcLocalTCPAddress: :8189
|
||||||
|
# WebRTC clients need to know the IP of the server.
|
||||||
|
# Gather IPs from interfaces and send them to clients.
|
||||||
|
webrtcIPsFromInterfaces: yes
|
||||||
|
# List of interfaces whose IPs will be sent to clients.
|
||||||
|
# An empty value means to use all available interfaces.
|
||||||
|
webrtcIPsFromInterfacesList: []
|
||||||
|
# List of additional hosts or IPs to send to clients.
|
||||||
|
webrtcAdditionalHosts: []
|
||||||
|
# ICE servers. Needed only when local listeners can't be reached by clients.
|
||||||
|
# STUN servers allows to obtain and share the public IP of the server.
|
||||||
|
# TURN/TURNS servers forces all traffic through them.
|
||||||
|
webrtcICEServers2:
|
||||||
|
- url: stun:stun.l.google.com:19302
|
||||||
|
# if user is "AUTH_SECRET", then authentication is secret based.
|
||||||
|
# the secret must be inserted into the password field.
|
||||||
|
# username: ''
|
||||||
|
# password: ''
|
||||||
|
# clientOnly: false
|
||||||
|
|
||||||
|
###############################################
|
||||||
|
# Global settings -> SRT server
|
||||||
|
|
||||||
|
# Enable publishing and reading streams with the SRT protocol.
|
||||||
|
srt: no
|
||||||
|
# Address of the SRT listener.
|
||||||
|
srtAddress: :8890
|
||||||
|
|
||||||
|
###############################################
|
||||||
|
# Default path settings
|
||||||
|
|
||||||
|
# Settings in "pathDefaults" are applied anywhere,
|
||||||
|
# unless they are overridden in "paths".
|
||||||
|
pathDefaults:
|
||||||
|
|
||||||
|
###############################################
|
||||||
|
# Default path settings -> General
|
||||||
|
|
||||||
|
# Source of the stream. This can be:
|
||||||
|
# * publisher -> the stream is provided by a RTSP, RTMP, WebRTC or SRT client
|
||||||
|
# * rtsp://existing-url -> the stream is pulled from another RTSP server / camera
|
||||||
|
# * rtsps://existing-url -> the stream is pulled from another RTSP server / camera with RTSPS
|
||||||
|
# * rtmp://existing-url -> the stream is pulled from another RTMP server / camera
|
||||||
|
# * rtmps://existing-url -> the stream is pulled from another RTMP server / camera with RTMPS
|
||||||
|
# * http://existing-url/stream.m3u8 -> the stream is pulled from another HLS server / camera
|
||||||
|
# * https://existing-url/stream.m3u8 -> the stream is pulled from another HLS server / camera with HTTPS
|
||||||
|
# * udp://ip:port -> the stream is pulled with UDP, by listening on the specified IP and port
|
||||||
|
# * srt://existing-url -> the stream is pulled from another SRT server / camera
|
||||||
|
# * whep://existing-url -> the stream is pulled from another WebRTC server / camera
|
||||||
|
# * wheps://existing-url -> the stream is pulled from another WebRTC server / camera with HTTPS
|
||||||
|
# * redirect -> the stream is provided by another path or server
|
||||||
|
# * rpiCamera -> the stream is provided by a Raspberry Pi Camera
|
||||||
|
# If path name is a regular expression, $G1, G2, etc will be replaced
|
||||||
|
# with regular expression groups.
|
||||||
|
source: publisher
|
||||||
|
# If the source is a URL, and the source certificate is self-signed
|
||||||
|
# or invalid, you can provide the fingerprint of the certificate in order to
|
||||||
|
# validate it anyway. It can be obtained by running:
|
||||||
|
# openssl s_client -connect source_ip:source_port </dev/null 2>/dev/null | sed -n '/BEGIN/,/END/p' > server.crt
|
||||||
|
# openssl x509 -in server.crt -noout -fingerprint -sha256 | cut -d "=" -f2 | tr -d ':'
|
||||||
|
sourceFingerprint:
|
||||||
|
# If the source is a URL, it will be pulled only when at least
|
||||||
|
# one reader is connected, saving bandwidth.
|
||||||
|
sourceOnDemand: no
|
||||||
|
# If sourceOnDemand is "yes", readers will be put on hold until the source is
|
||||||
|
# ready or until this amount of time has passed.
|
||||||
|
sourceOnDemandStartTimeout: 10s
|
||||||
|
# If sourceOnDemand is "yes", the source will be closed when there are no
|
||||||
|
# readers connected and this amount of time has passed.
|
||||||
|
sourceOnDemandCloseAfter: 10s
|
||||||
|
# Maximum number of readers. Zero means no limit.
|
||||||
|
maxReaders: 0
|
||||||
|
# SRT encryption passphrase require to read from this path
|
||||||
|
srtReadPassphrase:
|
||||||
|
# If the stream is not available, redirect readers to this path.
|
||||||
|
# It can be can be a relative path (i.e. /otherstream) or an absolute RTSP URL.
|
||||||
|
fallback:
|
||||||
|
|
||||||
|
###############################################
|
||||||
|
# Default path settings -> Record
|
||||||
|
|
||||||
|
# Record streams to disk.
|
||||||
|
record: no
|
||||||
|
# Path of recording segments.
|
||||||
|
# Extension is added automatically.
|
||||||
|
# Available variables are %path (path name), %Y %m %d %H %M %S %f %s (time in strftime format)
|
||||||
|
recordPath: ./recordings/%path/%Y-%m-%d_%H-%M-%S-%f
|
||||||
|
# Format of recorded segments.
|
||||||
|
# Available formats are "fmp4" (fragmented MP4) and "mpegts" (MPEG-TS).
|
||||||
|
recordFormat: fmp4
|
||||||
|
# fMP4 segments are concatenation of small MP4 files (parts), each with this duration.
|
||||||
|
# MPEG-TS segments are concatenation of 188-bytes packets, flushed to disk with this period.
|
||||||
|
# When a system failure occurs, the last part gets lost.
|
||||||
|
# Therefore, the part duration is equal to the RPO (recovery point objective).
|
||||||
|
recordPartDuration: 1s
|
||||||
|
# Minimum duration of each segment.
|
||||||
|
recordSegmentDuration: 1h
|
||||||
|
# Delete segments after this timespan.
|
||||||
|
# Set to 0s to disable automatic deletion.
|
||||||
|
recordDeleteAfter: 24h
|
||||||
|
|
||||||
|
###############################################
|
||||||
|
# Default path settings -> Publisher source (when source is "publisher")
|
||||||
|
|
||||||
|
# Allow another client to disconnect the current publisher and publish in its place.
|
||||||
|
overridePublisher: yes
|
||||||
|
# SRT encryption passphrase required to publish to this path
|
||||||
|
srtPublishPassphrase:
|
||||||
|
|
||||||
|
###############################################
|
||||||
|
# Default path settings -> RTSP source (when source is a RTSP or a RTSPS URL)
|
||||||
|
|
||||||
|
# Transport protocol used to pull the stream. available values are "automatic", "udp", "multicast", "tcp".
|
||||||
|
rtspTransport: automatic
|
||||||
|
# Support sources that don't provide server ports or use random server ports. This is a security issue
|
||||||
|
# and must be used only when interacting with sources that require it.
|
||||||
|
rtspAnyPort: no
|
||||||
|
# Range header to send to the source, in order to start streaming from the specified offset.
|
||||||
|
# available values:
|
||||||
|
# * clock: Absolute time
|
||||||
|
# * npt: Normal Play Time
|
||||||
|
# * smpte: SMPTE timestamps relative to the start of the recording
|
||||||
|
rtspRangeType:
|
||||||
|
# Available values:
|
||||||
|
# * clock: UTC ISO 8601 combined date and time string, e.g. 20230812T120000Z
|
||||||
|
# * npt: duration such as "300ms", "1.5m" or "2h45m", valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h"
|
||||||
|
# * smpte: duration such as "300ms", "1.5m" or "2h45m", valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h"
|
||||||
|
rtspRangeStart:
|
||||||
|
|
||||||
|
###############################################
|
||||||
|
# Default path settings -> Redirect source (when source is "redirect")
|
||||||
|
|
||||||
|
# RTSP URL which clients will be redirected to.
|
||||||
|
sourceRedirect:
|
||||||
|
|
||||||
|
###############################################
|
||||||
|
# Default path settings -> Raspberry Pi Camera source (when source is "rpiCamera")
|
||||||
|
|
||||||
|
# ID of the camera
|
||||||
|
rpiCameraCamID: 0
|
||||||
|
# width of frames
|
||||||
|
rpiCameraWidth: 1920
|
||||||
|
# height of frames
|
||||||
|
rpiCameraHeight: 1080
|
||||||
|
# flip horizontally
|
||||||
|
rpiCameraHFlip: false
|
||||||
|
# flip vertically
|
||||||
|
rpiCameraVFlip: false
|
||||||
|
# brightness [-1, 1]
|
||||||
|
rpiCameraBrightness: 0
|
||||||
|
# contrast [0, 16]
|
||||||
|
rpiCameraContrast: 1
|
||||||
|
# saturation [0, 16]
|
||||||
|
rpiCameraSaturation: 1
|
||||||
|
# sharpness [0, 16]
|
||||||
|
rpiCameraSharpness: 1
|
||||||
|
# exposure mode.
|
||||||
|
# values: normal, short, long, custom
|
||||||
|
rpiCameraExposure: normal
|
||||||
|
# auto-white-balance mode.
|
||||||
|
# values: auto, incandescent, tungsten, fluorescent, indoor, daylight, cloudy, custom
|
||||||
|
rpiCameraAWB: auto
|
||||||
|
# auto-white-balance fixed gains. This can be used in place of rpiCameraAWB.
|
||||||
|
# format: [red,blue]
|
||||||
|
rpiCameraAWBGains: [0, 0]
|
||||||
|
# denoise operating mode.
|
||||||
|
# values: off, cdn_off, cdn_fast, cdn_hq
|
||||||
|
rpiCameraDenoise: "off"
|
||||||
|
# fixed shutter speed, in microseconds.
|
||||||
|
rpiCameraShutter: 0
|
||||||
|
# metering mode of the AEC/AGC algorithm.
|
||||||
|
# values: centre, spot, matrix, custom
|
||||||
|
rpiCameraMetering: centre
|
||||||
|
# fixed gain
|
||||||
|
rpiCameraGain: 0
|
||||||
|
# EV compensation of the image [-10, 10]
|
||||||
|
rpiCameraEV: 0
|
||||||
|
# Region of interest, in format x,y,width,height
|
||||||
|
rpiCameraROI:
|
||||||
|
# whether to enable HDR on Raspberry Camera 3.
|
||||||
|
rpiCameraHDR: false
|
||||||
|
# tuning file
|
||||||
|
rpiCameraTuningFile:
|
||||||
|
# sensor mode, in format [width]:[height]:[bit-depth]:[packing]
|
||||||
|
# bit-depth and packing are optional.
|
||||||
|
rpiCameraMode:
|
||||||
|
# frames per second
|
||||||
|
rpiCameraFPS: 30
|
||||||
|
# period between IDR frames
|
||||||
|
rpiCameraIDRPeriod: 60
|
||||||
|
# bitrate
|
||||||
|
rpiCameraBitrate: 1000000
|
||||||
|
# H264 profile
|
||||||
|
rpiCameraProfile: main
|
||||||
|
# H264 level
|
||||||
|
rpiCameraLevel: '4.1'
|
||||||
|
# Autofocus mode
|
||||||
|
# values: auto, manual, continuous
|
||||||
|
rpiCameraAfMode: continuous
|
||||||
|
# Autofocus range
|
||||||
|
# values: normal, macro, full
|
||||||
|
rpiCameraAfRange: normal
|
||||||
|
# Autofocus speed
|
||||||
|
# values: normal, fast
|
||||||
|
rpiCameraAfSpeed: normal
|
||||||
|
# Lens position (for manual autofocus only), will be set to focus to a specific distance
|
||||||
|
# calculated by the following formula: d = 1 / value
|
||||||
|
# Examples: 0 moves the lens to infinity.
|
||||||
|
# 0.5 moves the lens to focus on objects 2m away.
|
||||||
|
# 2 moves the lens to focus on objects 50cm away.
|
||||||
|
rpiCameraLensPosition: 0.0
|
||||||
|
# Specifies the autofocus window, in the form x,y,width,height where the coordinates
|
||||||
|
# are given as a proportion of the entire image.
|
||||||
|
rpiCameraAfWindow:
|
||||||
|
# enables printing text on each frame.
|
||||||
|
rpiCameraTextOverlayEnable: false
|
||||||
|
# text that is printed on each frame.
|
||||||
|
# format is the one of the strftime() function.
|
||||||
|
rpiCameraTextOverlay: '%Y-%m-%d %H:%M:%S - MediaMTX'
|
||||||
|
|
||||||
|
###############################################
|
||||||
|
# Default path settings -> Hooks
|
||||||
|
|
||||||
|
# Command to run when this path is initialized.
|
||||||
|
# This can be used to publish a stream when the server is launched.
|
||||||
|
# This is terminated with SIGINT when the program closes.
|
||||||
|
# The following environment variables are available:
|
||||||
|
# * MTX_PATH: path name
|
||||||
|
# * RTSP_PORT: RTSP server port
|
||||||
|
# * G1, G2, ...: regular expression groups, if path name is
|
||||||
|
# a regular expression.
|
||||||
|
runOnInit:
|
||||||
|
# Restart the command if it exits.
|
||||||
|
runOnInitRestart: no
|
||||||
|
|
||||||
|
# Command to run when this path is requested by a reader
|
||||||
|
# and no one is publishing to this path yet.
|
||||||
|
# This can be used to publish a stream on demand.
|
||||||
|
# This is terminated with SIGINT when there are no readers anymore.
|
||||||
|
# The following environment variables are available:
|
||||||
|
# * MTX_PATH: path name
|
||||||
|
# * MTX_QUERY: query parameters (passed by first reader)
|
||||||
|
# * RTSP_PORT: RTSP server port
|
||||||
|
# * G1, G2, ...: regular expression groups, if path name is
|
||||||
|
# a regular expression.
|
||||||
|
runOnDemand:
|
||||||
|
# Restart the command if it exits.
|
||||||
|
runOnDemandRestart: no
|
||||||
|
# Readers will be put on hold until the runOnDemand command starts publishing
|
||||||
|
# or until this amount of time has passed.
|
||||||
|
runOnDemandStartTimeout: 10s
|
||||||
|
# The command will be closed when there are no
|
||||||
|
# readers connected and this amount of time has passed.
|
||||||
|
runOnDemandCloseAfter: 10s
|
||||||
|
# Command to run when there are no readers anymore.
|
||||||
|
# Environment variables are the same of runOnDemand.
|
||||||
|
runOnUnDemand:
|
||||||
|
|
||||||
|
# Command to run when the stream is ready to be read, whenever it is
|
||||||
|
# published by a client or pulled from a server / camera.
|
||||||
|
# This is terminated with SIGINT when the stream is not ready anymore.
|
||||||
|
# The following environment variables are available:
|
||||||
|
# * MTX_PATH: path name
|
||||||
|
# * MTX_QUERY: query parameters (passed by publisher)
|
||||||
|
# * RTSP_PORT: RTSP server port
|
||||||
|
# * G1, G2, ...: regular expression groups, if path name is
|
||||||
|
# a regular expression.
|
||||||
|
# * MTX_SOURCE_TYPE: source type
|
||||||
|
# * MTX_SOURCE_ID: source ID
|
||||||
|
runOnReady:
|
||||||
|
# Restart the command if it exits.
|
||||||
|
runOnReadyRestart: no
|
||||||
|
# Command to run when the stream is not available anymore.
|
||||||
|
# Environment variables are the same of runOnReady.
|
||||||
|
runOnNotReady:
|
||||||
|
|
||||||
|
# custom
|
||||||
|
httpOnReady: http://3m:8001/mediamtx/add
|
||||||
|
httpOnNotReady: http://3m:8001/mediamtx/del
|
||||||
|
|
||||||
|
# Command to run when a client starts reading.
|
||||||
|
# This is terminated with SIGINT when a client stops reading.
|
||||||
|
# The following environment variables are available:
|
||||||
|
# * MTX_PATH: path name
|
||||||
|
# * MTX_QUERY: query parameters (passed by reader)
|
||||||
|
# * RTSP_PORT: RTSP server port
|
||||||
|
# * G1, G2, ...: regular expression groups, if path name is
|
||||||
|
# a regular expression.
|
||||||
|
# * MTX_READER_TYPE: reader type
|
||||||
|
# * MTX_READER_ID: reader ID
|
||||||
|
runOnRead:
|
||||||
|
# Restart the command if it exits.
|
||||||
|
runOnReadRestart: no
|
||||||
|
# Command to run when a client stops reading.
|
||||||
|
# Environment variables are the same of runOnRead.
|
||||||
|
runOnUnread:
|
||||||
|
|
||||||
|
# Command to run when a recording segment is created.
|
||||||
|
# The following environment variables are available:
|
||||||
|
# * MTX_PATH: path name
|
||||||
|
# * RTSP_PORT: RTSP server port
|
||||||
|
# * G1, G2, ...: regular expression groups, if path name is
|
||||||
|
# a regular expression.
|
||||||
|
# * MTX_SEGMENT_PATH: segment file path
|
||||||
|
runOnRecordSegmentCreate:
|
||||||
|
|
||||||
|
# Command to run when a recording segment is complete.
|
||||||
|
# The following environment variables are available:
|
||||||
|
# * MTX_PATH: path name
|
||||||
|
# * RTSP_PORT: RTSP server port
|
||||||
|
# * G1, G2, ...: regular expression groups, if path name is
|
||||||
|
# a regular expression.
|
||||||
|
# * MTX_SEGMENT_PATH: segment file path
|
||||||
|
runOnRecordSegmentComplete:
|
||||||
|
|
||||||
|
###############################################
|
||||||
|
# Path settings
|
||||||
|
|
||||||
|
# Settings in "paths" are applied to specific paths, and the map key
|
||||||
|
# is the name of the path.
|
||||||
|
# Any setting in "pathDefaults" can be overridden here.
|
||||||
|
# It's possible to use regular expressions by using a tilde as prefix,
|
||||||
|
# for example "~^(test1|test2)$" will match both "test1" and "test2",
|
||||||
|
# for example "~^prefix" will match all paths that start with "prefix".
|
||||||
|
paths:
|
||||||
|
# example:
|
||||||
|
# my_camera:
|
||||||
|
# source: rtsp://my_camera
|
||||||
|
|
||||||
|
# Settings under path "all_others" are applied to all paths that
|
||||||
|
# do not match another entry.
|
||||||
|
all_others:
|
||||||
67
configure.sh
Executable file
67
configure.sh
Executable file
|
|
@ -0,0 +1,67 @@
|
||||||
|
#!/bin/bash
|
||||||
|
|
||||||
|
generate_pass() { echo $(head -c 32 /dev/urandom | base64 | tr -d "=/+"); }
|
||||||
|
|
||||||
|
mkdir -p certs
|
||||||
|
if [ ! -f "certs/3m.pem" ]; then
|
||||||
|
openssl genrsa -out certs/3m.pem 2048
|
||||||
|
openssl rsa -in certs/3m.pem -pubout -out certs/3m.pub
|
||||||
|
fi
|
||||||
|
if [ ! -f "certs/grumble.pem" ]; then
|
||||||
|
openssl genrsa -out certs/grumble.pem 2048
|
||||||
|
openssl rsa -in certs/grumble.pem -pubout -out certs/grumble.pub
|
||||||
|
fi
|
||||||
|
|
||||||
|
envp() {
|
||||||
|
if [ -z "${!1}" ]; then
|
||||||
|
read -p "$2: " INPUT
|
||||||
|
echo "$1='$INPUT'" >> .env
|
||||||
|
export "$1=$INPUT"
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
envgen() {
|
||||||
|
if [ -z "${!1}" ]; then
|
||||||
|
echo "$1='$2'" >> .env
|
||||||
|
export "$1='$2'"
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
if [ -f ".env" ]; then
|
||||||
|
source .env
|
||||||
|
fi
|
||||||
|
|
||||||
|
|
||||||
|
envgen MYSQL_PASSWORD $(generate_pass)
|
||||||
|
envgen MINIO_ROOT_PASSWORD $(generate_pass)
|
||||||
|
envgen COTURN_PASSWORD $(generate_pass)
|
||||||
|
envgen MINIO_ROOT_USER "threem"
|
||||||
|
|
||||||
|
envp ERGO__NETWORK__NAME "What's the overall name of the network? No spaces or special characters (e.g. 'CEF')"
|
||||||
|
envp DOMAIN "What is your domain? Omit HTTP/HTTPS (e.g. 'cef.icu')"
|
||||||
|
envgen ERGO__SERVER__NAME $DOMAIN
|
||||||
|
envgen ERGO__DATASTORE__MYSQL__PASSWORD $MYSQL_PASSWORD
|
||||||
|
envgen THREEM_DBURL "mysql+mysqldb://root:$MYSQL_PASSWORD@mariadb/ergo_ext"
|
||||||
|
|
||||||
|
envp HOST_DOMAIN "What is the domain of your Minio configuration (e.g. 'i.cef.icu')"
|
||||||
|
envgen THREEM_MINIO_EXTERNAL_ADDR $HOST_DOMAIN
|
||||||
|
envp ERGO__SERVER__IP_CLOAKING__NETNAME "What do you want the fake TLD of a cloaked IP to be? (e.g. 'cef')"
|
||||||
|
envp ERGO__SERVER__OVERRIDE_SERVICES_HOSTNAME "What do you want the vhost of IRC services to be (e.g. 'cef.operative')"
|
||||||
|
|
||||||
|
envp VIDEO_DOMAIN "What is the domain of the video server? It MUST not be behind cloudflare (e.g. video.cef.icu)"
|
||||||
|
envgen MTX_WEBRTCADDITIONALHOSTS "$VIDEO_DOMAIN"
|
||||||
|
|
||||||
|
envgen VITE_IRC_WEBSOCKET "wss://$DOMAIN/chat"
|
||||||
|
envgen VITE_3M_ADDRESS "https://$DOMAIN/3m"
|
||||||
|
envgen VITE_HOSTING_ADDRESS "https://$HOST_DOMAIN"
|
||||||
|
|
||||||
|
envgen IMAGOR_SECRET $(generate_pass)
|
||||||
|
envgen IMAGOR_URL "https://$HOST_DOMAIN/embed/"
|
||||||
|
|
||||||
|
envgen THREEM_MEDIAMTX_API "http://mediamtx:9997"
|
||||||
|
envgen THREEM_MEDIAMTX_RTSP "mediamtx:8554"
|
||||||
|
envgen ERGO__CEF__IMAGOR__URL "https://$HOST_DOMAIN/embed/"
|
||||||
|
envgen ERGO__CEF__IMAGOR__SECRET "$IMAGOR_SECRET"
|
||||||
|
envgen VITE_VOICE_ADDRESS "wss://$DOMAIN/voice"
|
||||||
|
|
||||||
|
echo "Have you set up Minio? If not, run ./setup-minio.sh"
|
||||||
181
docker-compose.yml
Normal file
181
docker-compose.yml
Normal file
|
|
@ -0,0 +1,181 @@
|
||||||
|
services:
|
||||||
|
ergo:
|
||||||
|
container_name: ergo
|
||||||
|
image: ergo
|
||||||
|
environment:
|
||||||
|
ERGO__DATASTORE__MYSQL__PASSWORD: ${ERGO__DATASTORE__MYSQL__PASSWORD}
|
||||||
|
ERGO__SERVER__IP_CLOAKING__NETNAME: ${ERGO__SERVER__IP_CLOAKING__NETNAME}
|
||||||
|
ERGO__SERVER__OVERRIDE_SERVICES_HOSTNAME: ${ERGO__SERVER__OVERRIDE_SERVICES_HOSTNAME}
|
||||||
|
ERGO__SERVER__NAME: ${ERGO__SERVER__NAME}
|
||||||
|
ERGO__NETWORK__NAME: ${ERGO__NETWORK__NAME}
|
||||||
|
ERGO__CEF__IMAGOR__URL: ${ERGO__CEF__IMAGOR__URL}
|
||||||
|
ERGO__CEF__IMAGOR__SECRET: ${ERGO__CEF__IMAGOR__SECRET}
|
||||||
|
IMAGOR_SECRET: ${IMAGOR_SECRET}
|
||||||
|
IMAGOR_URL: ${IMAGOR_URL}
|
||||||
|
networks:
|
||||||
|
- cef
|
||||||
|
volumes:
|
||||||
|
- ergodata:/ircd/persist
|
||||||
|
- ${PWD}/certs:/ircd/certs
|
||||||
|
- type: bind
|
||||||
|
source: ${PWD}/configs/ergo/ircd.yaml
|
||||||
|
target: /ircd/ircd.yaml
|
||||||
|
read_only: true
|
||||||
|
- type: bind
|
||||||
|
source: ${PWD}/configs/ergo/ircd.motd
|
||||||
|
target: /ircd/ircd.motd
|
||||||
|
depends_on:
|
||||||
|
mariadb:
|
||||||
|
condition: service_healthy
|
||||||
|
restart: "always"
|
||||||
|
3m:
|
||||||
|
container_name: 3m
|
||||||
|
image: 3m
|
||||||
|
environment:
|
||||||
|
THREEM_MINIO_EXTERNAL_ADDR: ${THREEM_MINIO_EXTERNAL_ADDR}
|
||||||
|
THREEM_MINIO_ACCESS_KEY: ${THREEM_MINIO_ACCESS_KEY}
|
||||||
|
THREEM_MINIO_SECRET_KEY: ${THREEM_MINIO_SECRET_KEY}
|
||||||
|
THREEM_DBURL: ${THREEM_DBURL}
|
||||||
|
THREEM_MEDIAMTX_API: ${THREEM_MEDIAMTX_API}
|
||||||
|
THREEM_MEDIAMTX_RTSP: ${THREEM_MEDIAMTX_RTSP}
|
||||||
|
networks:
|
||||||
|
- cef
|
||||||
|
volumes:
|
||||||
|
- type: bind
|
||||||
|
source: ${PWD}/certs/3m.pub
|
||||||
|
target: /3m/keys/3m.pub
|
||||||
|
- type: bind
|
||||||
|
source: ${PWD}/configs/3m/config.py
|
||||||
|
target: /3m/config.py
|
||||||
|
depends_on:
|
||||||
|
- ergo
|
||||||
|
restart: "always"
|
||||||
|
mediamtx:
|
||||||
|
container_name: mediamtx
|
||||||
|
image: mediamtx
|
||||||
|
command: /mediamtx/mediamtx.yaml
|
||||||
|
environment:
|
||||||
|
MTX_WEBRTCADDITIONALHOSTS: ${MTX_WEBRTCADDITIONALHOSTS}
|
||||||
|
MTX_WEBRTCICESERVERS2_0_URL: "turn:${VIDEO_DOMAIN}:3478"
|
||||||
|
MTX_WEBRTCICESERVERS2_0_USERNAME: "AUTH_SECRET"
|
||||||
|
MTX_WEBRTCICESERVERS2_0_PASSWORD: ${COTURN_PASSWORD}
|
||||||
|
networks:
|
||||||
|
- cef
|
||||||
|
ports:
|
||||||
|
- "8189:8189/tcp"
|
||||||
|
- "8189:8189/udp"
|
||||||
|
volumes:
|
||||||
|
- type: bind
|
||||||
|
source: ${PWD}/configs/mediamtx/mediamtx.yaml
|
||||||
|
target: /mediamtx/mediamtx.yaml
|
||||||
|
restart: "always"
|
||||||
|
coturn:
|
||||||
|
container_name: coturn
|
||||||
|
image: "ghcr.io/coturn/coturn:edge-alpine"
|
||||||
|
network_mode: "host"
|
||||||
|
environment:
|
||||||
|
DETECT_EXTERNAL_IP: "yes"
|
||||||
|
DETECT_RELAY_IP: "yes"
|
||||||
|
COTURN_LOGIN: ${COTURN_LOGIN}
|
||||||
|
restart: "always"
|
||||||
|
ports:
|
||||||
|
- "3478:3478"
|
||||||
|
- "3478:3478/udp"
|
||||||
|
- "5349:5349"
|
||||||
|
- "5349:5349/udp"
|
||||||
|
- "49152-65535:49152-65535/udp"
|
||||||
|
command: "--fingerprint --use-auth-secret --static-auth-secret ${COTURN_PASSWORD} --realm cef.icu"
|
||||||
|
grumble:
|
||||||
|
container_name: grumble
|
||||||
|
image: grumble
|
||||||
|
environment:
|
||||||
|
GRUMBLE_ERGO_ADDR: "ergo"
|
||||||
|
networks:
|
||||||
|
- cef
|
||||||
|
volumes:
|
||||||
|
- type: bind
|
||||||
|
source: ${PWD}/certs/grumble.pub
|
||||||
|
target: /data/jwtpub.pem
|
||||||
|
depends_on:
|
||||||
|
- ergo
|
||||||
|
restart: "always"
|
||||||
|
minio:
|
||||||
|
container_name: minio
|
||||||
|
image: docker.io/minio/minio
|
||||||
|
command: server /data
|
||||||
|
environment:
|
||||||
|
MINIO_ROOT_USER: ${MINIO_ROOT_USER}
|
||||||
|
MINIO_ROOT_PASSWORD: ${MINIO_ROOT_PASSWORD}
|
||||||
|
networks:
|
||||||
|
- cef
|
||||||
|
volumes:
|
||||||
|
- miniodata:/data
|
||||||
|
restart: "always"
|
||||||
|
redis:
|
||||||
|
container_name: redis
|
||||||
|
image: docker.io/redis:7.2.5-alpine
|
||||||
|
networks:
|
||||||
|
- cef
|
||||||
|
restart: "always"
|
||||||
|
caddy:
|
||||||
|
container_name: caddy
|
||||||
|
image: docker.io/caddy:2.8.4-alpine
|
||||||
|
cap_add:
|
||||||
|
- NET_ADMIN
|
||||||
|
environment:
|
||||||
|
DOMAIN: ${DOMAIN}
|
||||||
|
HOST_DOMAIN: ${HOST_DOMAIN}
|
||||||
|
ports:
|
||||||
|
- "80:80"
|
||||||
|
- "443:443"
|
||||||
|
- "443:443/udp"
|
||||||
|
networks:
|
||||||
|
- cef
|
||||||
|
volumes:
|
||||||
|
- caddydata:/data
|
||||||
|
- caddyconfig:/config
|
||||||
|
- ${PWD}/www:/srv
|
||||||
|
- type: bind
|
||||||
|
source: ${PWD}/configs/caddy/Caddyfile
|
||||||
|
target: /etc/caddy/Caddyfile
|
||||||
|
restart: "always"
|
||||||
|
mariadb:
|
||||||
|
container_name: mariadb
|
||||||
|
image: docker.io/mariadb:11-ubi9
|
||||||
|
restart: always
|
||||||
|
environment:
|
||||||
|
MARIADB_ROOT_PASSWORD: ${MYSQL_PASSWORD}
|
||||||
|
networks:
|
||||||
|
- cef
|
||||||
|
volumes:
|
||||||
|
- mariadbdata:/var/lib/mysql
|
||||||
|
- ${PWD}/configs/mariadb:/docker-entrypoint-initdb.d
|
||||||
|
healthcheck:
|
||||||
|
test: ["CMD", "healthcheck.sh", "--connect", "--innodb_initialized"]
|
||||||
|
start_period: 10s
|
||||||
|
interval: 10s
|
||||||
|
timeout: 5s
|
||||||
|
retries: 3
|
||||||
|
imagor:
|
||||||
|
container_name: imagor
|
||||||
|
image: git.cef.icu/cef/imagorvideoextended:latest
|
||||||
|
environment:
|
||||||
|
IMAGOR_SECRET: ${IMAGOR_SECRET}
|
||||||
|
IMAGOR_SIGNER_TYPE: "sha256"
|
||||||
|
DEBUG: "1"
|
||||||
|
networks:
|
||||||
|
- cef
|
||||||
|
|
||||||
|
networks:
|
||||||
|
cef:
|
||||||
|
|
||||||
|
volumes:
|
||||||
|
ergodata:
|
||||||
|
external: true
|
||||||
|
miniodata:
|
||||||
|
external: true
|
||||||
|
mariadbdata:
|
||||||
|
external: true
|
||||||
|
caddyconfig:
|
||||||
|
caddydata:
|
||||||
|
external: true
|
||||||
19
setup-minio.sh
Executable file
19
setup-minio.sh
Executable file
|
|
@ -0,0 +1,19 @@
|
||||||
|
#!/bin/bash
|
||||||
|
docker compose up --no-start
|
||||||
|
docker container start minio
|
||||||
|
source .env
|
||||||
|
echo "waiting for minio to really start"
|
||||||
|
sleep 10
|
||||||
|
docker container exec -it minio sh -c "mc alias set local http://localhost:9000 $MINIO_ROOT_USER $MINIO_ROOT_PASSWORD"
|
||||||
|
if [ -z "$THREEM_MINIO_ACCESS_KEY" ]; then
|
||||||
|
ACCESSKEYINFO=$(docker container exec -it minio sh -c "mc admin user svcacct add local $MINIO_ROOT_USER")
|
||||||
|
AC=$(echo $ACCESSKEYINFO | grep -Eo "Access Key: \S+" | grep -Eo "\S+$")
|
||||||
|
SK=$(echo $ACCESSKEYINFO | grep -Eo "Secret Key: \S+" | grep -Eo "\S+$")
|
||||||
|
echo "THREEM_MINIO_ACCESS_KEY=$AC" >> .env
|
||||||
|
echo "THREEM_MINIO_SECRET_KEY=$SK" >> .env
|
||||||
|
fi
|
||||||
|
docker container exec -it minio sh -c "mc mb --ignore-existing local/pfp"
|
||||||
|
docker container exec -it minio sh -c "mc mb --ignore-existing local/uploads"
|
||||||
|
docker container exec -it minio sh -c "mc anonymous set download local/pfp"
|
||||||
|
docker container exec -it minio sh -c "mc anonymous set download local/uploads"
|
||||||
|
docker compose down
|
||||||
Loading…
Add table
Add a link
Reference in a new issue