e510cef208
The service file will run `/usr/bin/soju --config /etc/soju/config`. By default it'll run as a dynamically created `soju` user and group (DynamicUser=yes), and it will run in a constrained environment[1], only having write access to /var/lib/soju and /run/soju If the admin creates a static `soju` user and group, those static uid/gid will be used, with the same service constraints. This can be useful to share the static `soju` group with other services, so they can access the soju logs and database even if the service is not running (or before it's running). The procedure for the initial user and database scaffold still works normally, when run as `root`: ``` mkdir /var/lib/soju/ sojudb -config /etc/soju/config create-user myname -admin ``` NOTE: systemd will automatically change the ownership of files in /var/lib/soju/ when the service is started. `sojuctl` will work for root, or with `sudo -u soju`, just normally. References: - [1] https://www.freedesktop.org/software/systemd/man/systemd.exec.html#DynamicUser= |
||
---|---|---|
auth | ||
cmd | ||
config | ||
contrib | ||
database | ||
doc | ||
identd | ||
msgstore | ||
xirc | ||
.build.yml | ||
.editorconfig | ||
.gitignore | ||
certfp.go | ||
config.in | ||
conn.go | ||
downstream.go | ||
go.mod | ||
go.sum | ||
irc_test.go | ||
irc.go | ||
LICENSE | ||
Makefile | ||
rate.go | ||
README.md | ||
server_test.go | ||
server.go | ||
service_test.go | ||
service.go | ||
upstream.go | ||
user.go |
soju
soju is a user-friendly IRC bouncer. soju connects to upstream IRC servers on behalf of the user to provide extra functionality. soju supports many features such as multiple users, numerous IRCv3 extensions, chat history playback and detached channels. It is well-suited for both small and large deployments.
Usage
Building and installing
Dependencies:
- Go
- BSD or GNU make
- a C89 compiler (optional, for SQLite)
- scdoc (optional, for man pages)
For end users, a Makefile
is provided:
make
sudo make install
For development, you can use go run ./cmd/soju
as usual.
To link with the system libsqlite3, set GOFLAGS="-tags=libsqlite3"
. To disable
SQLite support, set GOFLAGS="-tags=nosqlite"
. To use an alternative SQLite
library that does not require CGO, set GOFLAGS="-tags=moderncsqlite"
. To
build with PAM authentication support, set GOFLAGS="-tags=pam"
.
Contributing
Send patches on the mailing list or on GitHub, report bugs on the issue tracker. Discuss in #soju on Libera Chat.
License
AGPLv3, see LICENSE.
Copyright (C) 2020 The soju Contributors