soju

README

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

• Getting started
• Man page

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

Documentation

Index

• func NewRetryListener(ln net.Listener) net.Listener
• type Config
• type Logger
  • func NewLogger(out io.Writer, debug bool) Logger
• type Server
  • func NewServer(db database.Database) *Server
  • func (s *Server) Config() *Config
  • func (s *Server) Handle(ic ircConn)
  • func (s *Server) HandleAdmin(ic ircConn)
  • func (s *Server) Serve(ln net.Listener, handler func(ircConn)) error
  • func (s *Server) ServeHTTP(w http.ResponseWriter, req *http.Request)
  • func (s *Server) SetConfig(cfg *Config)
  • func (s *Server) Shutdown()
  • func (s *Server) Start() error
  • func (s *Server) Stats() *ServerStats
• type ServerStats
• type UserUpdateFunc

Functions

func NewRetryListener

func NewRetryListener(ln net.Listener) net.Listener

Types

type Config

type Config struct {
	Hostname                  string
	Title                     string
	MsgStoreDriver            string
	MsgStorePath              string
	HTTPOrigins               []string
	HTTPIngress               string
	AcceptProxyIPs            config.IPSet
	MaxUserNetworks           int
	MOTD                      string
	UpstreamUserIPs           []*net.IPNet
	DisableInactiveUsersDelay time.Duration
	EnableUsersOnAuth         bool
	Auth                      auth.Authenticator
	FileUploader              fileupload.Uploader
}

type Logger

type Logger interface {
	Printf(format string, v ...interface{})
	Debugf(format string, v ...interface{})
}

func NewLogger

func NewLogger(out io.Writer, debug bool) Logger

type Server

type Server struct {
	Logger          Logger
	Identd          *identd.Identd        // can be nil
	MetricsRegistry prometheus.Registerer // can be nil
	// contains filtered or unexported fields
}

func NewServer

func NewServer(db database.Database) *Server

func (*Server) Config

func (s *Server) Config() *Config

func (*Server) Handle

func (s *Server) Handle(ic ircConn)

func (*Server) HandleAdmin

func (s *Server) HandleAdmin(ic ircConn)

func (*Server) Serve

func (s *Server) Serve(ln net.Listener, handler func(ircConn)) error

func (*Server) ServeHTTP

func (s *Server) ServeHTTP(w http.ResponseWriter, req *http.Request)

func (*Server) SetConfig

func (s *Server) SetConfig(cfg *Config)

func (*Server) Shutdown

func (s *Server) Shutdown()

func (*Server) Start

func (s *Server) Start() error

func (*Server) Stats

func (s *Server) Stats() *ServerStats

type ServerStats

type ServerStats struct {
	Users       int
	Downstreams int64
	Upstreams   int64
}

type UserUpdateFunc

type UserUpdateFunc func(record *database.User) error