README

Thank you for your interest in MagIRC, a PHP-based Web Frontend for IRC Services released under the GPLv3 license.

This software is a complete rewrite of phpDenora, a PHP-based Web Frontend for the Denora Stats project.

Meanwhile, MagIRC also works with Anope 2.0, which supersedes Denora. We recommend using Anope, since it is being actively maintained and has improved performance and stability over Denora. In case you want to migrate from Denora to Anope, we created a script for this task (see below).

Main features

REST service
Twig templating engine
jQuery-based UI with AJAX interactions
HTML5 and CSS3
Easy installation
Administration panel
Slick design

Requirements

Web Server with PHP 5.6+ and the pdo_mysql, gettext and xml extensions installed
Web Browser supporting HTML5, CSS3 and JavaScript
Any of the following:
- Denora Stats v1.5 server with MySQL enabled
- Anope v2.0 with the m_mysql, m_chanstats and irc2sql modules enabled
Supported IRC Daemons: Bahamut, Charybdis, InspIRCd, ircd-rizon, IRCu, Nefarious, Ratbox, ScaryNet, Unreal

Magirc installation / upgrade

Using composer and yarn (recommended)

Execute the following command:
- To install:
  - composer create-project magirc/magirc
  - yarn
- To update:
  - composer update
  - yarn
  - Clean up cached pages with rm -r tmp/*
Use your web browser to navigate to the setup folder on your server and follow on-screen instructions. Example: https://yourpathtomagirc/setup/

Using a release package

Download the latest MagIRC release package from GitHub
Extract the MagIRC archive to your web server and move its content to the MagIRC directory.
Use your web browser to navigate to the setup folder on your server and follow on-screen instructions. Example: https://yourpathtomagirc/setup/

Using git

You need a git client, composer and yarn

Execute the following commands:
- To install:
  - git clone git://github.com/h9k/magirc.git
  - composer install
  - yarn
- To update:
  - git pull
  - composer update
  - yarn
Use your web browser to navigate to the setup folder on your server and follow on-screen instructions. Example: https://yourpathtomagirc/setup/

Anope configuration

You need Anope 2.0.0 or later and the following modules enabled and set up:

m_mysql
m_chanstats
irc2sql

These modules are included in the Anope codebase under extra. Please refer to the Anope documentation on how to set those up.

Also, you will need additional database tables, views and stored procedures for the Anope database in order to get the data needed by MagIRC. Please look at the setup/sql/anope.sql file and adapt it if needed (table prefixes, etc.) and run it against your Anope database.

Note that you need the MySQL event_scheduler set to ON in the MySQL server. If you have enough rights, you can turn it on via SET GLOBAL event_scheduler = ON;.

If you have access to the server configuration, you can modify the msql configuration file (usually my.cnf or mysqld.cnf) by setting event_scheduler = on in the [mysqld] block.

NOTE: Ubuntu/Debian users: You should ONLY edit the file located under /etc/mysql/mysql.conf.d/ directory, otherwise MySQL will refuse to start/restart. On other distros/OS's, you should look for where the mysqld.cnf file is located.

Migrating from Denora to Anope

If you want to switch from Denora to Anope, please proceed as follows:

Install Anope (see above)
Shut down Denora
Make Anope join the network and double check that it is working fine, e.g. the MySQL tables are being filled with data
Configure the setup/tools/denora2anope.php script and then run it from command line with php denora2anope.php. Be patient and do not interrupt the process!

Denora configuration

Required Denora settings

Change this to a higher value, such as 15 days (15d) to keep information for a longer time. Important: the servercache value must NOT be smaller than the usercache value!

usercache 15d;
servercache 30d;

Change this to 1h

uptimefreq 1h;

Enable the following parameters by removing the '#' in front:

ctcpusers;
keepusers;
keepservers;

Disable the following parameter by adding a '#' in front:

#largenet;

Optional Denora settings

Limiting chanstats to +r users improves nick tracking. To use this feature enable the following parameters by removing the '#' in front:

ustatsregistered;

Web Server configuration

Apache

The AcceptPathInfo directive should be set to Default or On in the Apache configuration. It is by default on most servers.

To enable URL rewriting make sure your apache has the mod_rewrite module enabled. Then rename htaccess.txt to .htaccess and enable rewriting in the MagIRC Admin Panel. This is optional, MagIRC also works without rewriting on Apache.

It is also recommended, if you allow slashes / in your nicknames or channel names, to set AllowEncodedSlashes On

Nginx

Your Nginx configuration file should look like this, adapted to your needs of course:

server {
	listen 80;
	server_name magirc.example.com;

	access_log /var/log/nginx/magirc_access.log main;
	error_log /var/log/nginx/magirc_error.log info;

	root /path/to/magirc;
	index index.php index.html;

	location / {
		try_files $uri $uri/ /index.php;
	}

	location ~ ^(/.+\.php)(/.*)?$ {
		try_files $1 =404;
		include /etc/nginx/fastcgi.conf;
		fastcgi_pass 127.0.0.1:9000;
		fastcgi_index index.php;
	}
}

This will work with or without Magirc rewrite. If you do not have /etc/nginx/fastcgi.conf, include /etc/nginx/fastcgi_params.

If MagIRC is installed in a directory within your webroot (example.com/magirc/), your Nginx configuration file should look like this, adapted to your needs of course:

server {
	listen 80;
	server_name example.com;

	access_log /var/log/nginx/magirc_access.log main;
	error_log /var/log/nginx/magirc_error.log info;

	root /path/to/webroot;
	index index.php index.html;

	location /magirc {
		try_files $uri $uri/ /magirc/index.php;
	}

	location ~ ^(/magirc/.+\.php)(/.*)?$ {
		try_files $1 =404;
		include /etc/nginx/fastcgi.conf;
		fastcgi_pass 127.0.0.1:9000;
		fastcgi_index index.php;
	}
}

lighttpd

Your lighttpd configuration file should contain this code (along with other settings you may need). This code requires lighttpd >= 1.4.24.

url.rewrite-if-not-file = ("^" => "/index.php")

magirc / magirc

Maintainers

Details