pegasus-coder / atheme Goto Github PK

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.

You can either git clone https://github.com/atheme/atheme.git or download a package via our website at https://atheme.github.io/ -- Please do not click the "Download" buttons on GitHub as they lack needed submodules, etc.

If you are running this code from Git, you should read GIT-Access.txt for instructions on how to fully check out the atheme tree, as it is spread across many repositories.

Whatever you do, make sure you do not install Atheme into the same location as the source. Atheme will default to installing in $HOME/atheme, so make sure you plan accordingly for this.

$ git submodule update --init
$ ./configure
$ make
$ make install

If you are on an OpenBSD system, or similar, you will need to do things slightly differently:

# pkg_add gmake
$ git submodule update --init
$ ./configure --disable-linker-defs
$ gmake
$ gmake install

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.

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.

If you're still lost, read the INSTALL or GIT-Access.txt files or check out our wiki (http://github.com/atheme/atheme/wiki) for more hints.

See also:

• GitHub
• Website
• Wiki
• Freenode / #atheme