Atheme is a set of IRC services designed for large IRC networks with high scalability requirements. It is relatively mature software, with behavior that is tunable using modules and a highly detailed configuration file. https://atheme.github.io
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Ed Kellett adc0fb7f2f
Don't save last seen times for logged-in nicks
4 days ago
.github/workflows .gitattributes: update for commit 8c3926d73eb23f567a25 10 months ago
build-aux configure.ac: rename autoconf/ to build-aux/ 10 months ago
contrib Don't save last seen times for logged-in nicks 1 day ago
dist Implement certfp list length max check (#848) 1 month ago
doc Document Insp 3 support 5 months ago
email/default email/default/setpass: don't encourage contact for unsolicited receipt 7 months ago
help Remove reference to SET FOUNDER in help for DROP 7 months ago
include include/atheme/privs.h: tidy up 1 day ago
libathemecore libathemecore/ptasks.c: stats c: show uplink host 1 day ago
libmowgli-2 @ ffc46e5f3d libmowgli-2/: bump to latest HEAD 11 months ago
m4 m4/atheme-libtest-*.m4: correct copy/paste mistake on temporary variable name 7 months ago
modules Don't save last seen times for logged-in nicks 1 day ago
po Update my e-mail address 7 months ago
scripts Enable GitHub Actions Continuous Integration 11 months ago
src Update my e-mail address 7 months ago
tools Update my e-mail address 7 months ago
.gitattributes .gitattributes: remove files that no longer exist 7 months ago
.gitignore Clean up and split up .gitignore files 2 years ago
.gitmodules gitmodules: change URLs to https:// 5 years ago
.mailmap libathemecore/version.c: update 2 years ago
ABOUT-NLS ABOUT-NLS: update from upstream 3 years ago
BSDmakefile Add a stub BSDmakefile that redirects to gmake. 9 years ago
COPYING COPYING: Make symlink to doc/LICENSE 3 years ago
GIT-Access.txt README.md, GIT-Access.txt: Some small improvements 11 months ago
INSTALL Merge pull request #793 from ProgVal/patch-1 6 months ago
Makefile Update my e-mail address 7 months ago
NEWS.md Don't save last seen times for logged-in nicks 1 day ago
README.md The Great Migration 8 months ago
SECURITY.md The Great Migration 8 months ago
TODO Discontinuation notices 7 years ago
autogen.sh autogen.sh: remove '-I m4' option to aclocal 4 years ago
buildsys.mk.in Update my e-mail address 7 months ago
buildsys.module.mk Update my e-mail address 7 months ago
configure m4/atheme-libtest-*.m4: correct copy/paste mistake on temporary variable name 7 months ago
configure.ac The Great Migration 8 months ago
extra.mk.in modules/contrib/: transition to independent build system 10 months ago
mingw-build.sh mingw-build: --disable-nls no longer needed 10 years ago

README.md

Atheme IRC Services

Atheme is a set of IRC services designed for large IRC networks with high scalability requirements. It is relatively mature software, with some code and design derived from another package called Shrike.

Atheme’s behavior is tunable using modules and a highly detailed configuration file. Almost all behavior can be changed at deployment time just by editing the configuration.

Obtaining Atheme

If you have a modern version of Git (1.6.5 or newer), you can recursively clone the repository:

$ git clone --recursive 'https://github.com/atheme/atheme/' atheme-devel
$ cd atheme-devel

If you have an older version of Git, you must clone the repository, and then fetch its submodules:

$ git clone 'https://github.com/atheme/atheme/' atheme-devel
$ cd atheme-devel
$ git submodule init
$ git submodule update

If you don’t have Git, you can download a package archive from our website at https://atheme.github.io/.

If you are browsing our GitHub repository, please do NOT click the “Download ZIP” button or the “Source code” links there, as they will give you an archive that lacks the required submodules. There are proper .tar.bz2 or .tar.xz archives attached to each release under “Assets”, which is what the “Download” button on our website will take you to.

Basic build instructions for the impatient

Obtain the source code repository and change into its directory (using the commands given above).

If you are building Atheme on a GNU/Linux system, or something which can sufficiently emulate that (like WSL 2 on Windows 10), execute the following commands:

$ ./configure
$ make
$ make install

If you are building Atheme on an OpenBSD (or similar) system, execute the following commands instead:

# pkg_add gmake
$ ./configure --disable-linker-defs
$ gmake
$ gmake install

Library Detection

If your user-installed libraries that you want Atheme to use are installed by your package manager to a directory such as /usr/local/, you may need to supplement the default compiler and linker search paths so that Atheme can detect those libraries (e.g. cracklib from FreeBSD Ports):

$ ./configure CPPFLAGS="-I/usr/local/include" LDFLAGS="-L/usr/local/lib"

The following libraries generally require pkg-config to be installed:

  • PHC Argon2 Reference Implementation (libargon2.pc)
  • OpenSSL (libcrypto.pc)
  • GNU libidn (libidn.pc)
  • GNU Nettle (nettle.pc)
  • PCRE (libpcre.pc)
  • libqrencode (libqrencode.pc)
  • Sodium (libsodium.pc)

If you do not have pkg-config installed and want to use one or more of these libraries, please see ./configure --help for the options to set to override pkg-config discovery for those libraries. For example, if you wish to use GNU libidn, and it is installed into a default search path for your compiler and linker, and you do not have pkg-config installed, execute:

$ ./configure LIBIDN_CFLAGS="" LIBIDN_LIBS="-lidn"

If a library relies on populating LIBFOO_CFLAGS with some preprocessor definitions, or populating LIBFOO_LIBS with some library linking flags, this will generally fail. Install pkg-config for the best results.

Choice of compiler and its features

If you wish to compile Atheme with the LLVM project’s C compiler (clang), you may also wish to use LLVM’s linker (lld). You can accomplish this as follows:

$ ./configure CC="clang" LDFLAGS="-fuse-ld=lld"

If you want to use compiler sanitizers, and you want to build with Clang, you MUST also use LLD, as most of the sanitizers in Clang require LTO to function properly, and Clang in LTO mode emits LLVM bitcode, not machine code. The linker is ultimately responsible for performing most of the LTO heavy lifting, and translating the result into machine code, and most other linkers do not know how to do this.

To use compiler sanitizers with GCC (supported):

$ ./configure --disable-heap-allocator --disable-linker-defs \
    --enable-compiler-sanitizers CC="gcc"

To use compiler sanitizers with Clang (recommended):

$ ./configure --disable-heap-allocator --disable-linker-defs \
    --enable-compiler-sanitizers CC="clang" LDFLAGS="-fuse-ld=lld"

If you do enable the sanitizers, it is recommended to enable the configuration option general::db_save_blocking; see the example configuration file for more details.

The sanitizers are not recommended for production usage, but they are recommended for developers, including third parties writing new features and/or modifying the source code.

Getting More Help

If you’re still lost, read the INSTALL file or check out our wiki for more hints.