-
Notifications
You must be signed in to change notification settings - Fork 14
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Revised README.md Install/Upgrade instructions and added file for tem…
…plating documentation. Conflicts: README.md
- Loading branch information
pferandnes
authored and
Sebastian Vassiliou
committed
Apr 12, 2012
1 parent
febaf96
commit 4f451dc
Showing
1 changed file
with
78 additions
and
78 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,78 +1,78 @@ | ||
| MagIRC | ||
| ====== | ||
|
|
||
| Thank you for your interest in MagIRC, a PHP-based Web Frontend for IRC Services released under the GPLv3 license. | ||
|
|
||
| About MagIRC | ||
| ------------ | ||
| This software is a complete rewrite of phpDenora, a PHP-based Web Frontend for the [Denora Stats](http://www.denorastats.org) project. | ||
| In the future it will interface with other IRC services like [Anope](http://www.anope.org/) but the priority for now is to replace phpDenora since it is aged. | ||
|
|
||
| Main features | ||
| ------------- | ||
| * [Smarty](http://www.smarty.net/) templating engine | ||
| * [jQuery](http://www.jquery.com/)-based UI with AJAX interactions | ||
| * HTML5 and CSS3 | ||
| * Easy installation | ||
| * Administration panel | ||
| * Slick design | ||
|
|
||
| Requirements | ||
| ------------ | ||
| * Web Server with PHP 5.3+ and the *pdo_mysql*, *mcrypt* and *gettext* modules installed | ||
| * Web Browser supporting HTML5, CSS3 and JavaScript | ||
| * [Denora Stats](http://www.denorastats.org) server with MySQL enabled | ||
| * Supported IRC Daemons: Bahamut, Charybdis, InspIRCd, ircd-rizon, IRCu, Nefarious, Ratbox, ScaryNet, Unreal | ||
|
|
||
| Limitations | ||
| ----------- | ||
| The current version is considered to be **alpha** and has some known limitations: | ||
|
|
||
| * English only: MagIRC already has gettext localization built in, but it will be activated only once the software is nearly finished to avoid too much work maintaining language files for rapidly changing code. This is scheduled for the **beta** release. | ||
| * Only one default theme: MagIRC allows to install additional themes, but things need to be sorted out before fully this. This is scheduled for the **release candidate**. | ||
|
|
||
| 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; | ||
|
|
||
| Installation | ||
| ------------ | ||
| 1. Pull the latest MagIRC package from https://github.com/h9k/magirc/. | ||
| 2. Extract the MagIRC archive to your web server and move it's conetent to the MagIRC directory. | ||
| 3. Use your web browser to navigate to the setup folder on your server and follow on-screen instructions. | ||
| Example: http://`yourpathtomagirc`/setup | ||
|
|
||
| Note: If you are on Apache you can enable mod_rewrite by using "a2enmod rewrite; service apache2 restart" | ||
| and rename htaccess.txt in the root to .htaccess. | ||
|
|
||
| Upgrading | ||
| --------- | ||
| 1. Pull the latest MagIRC package from https://github.com/h9k/magirc/. | ||
| 2. Extract the MagIRC archive to your web server and move it's conetent to the MagIRC directory. | ||
| 3. Use your web browser to navigate to the setup folder on your server and follow on-screen instructions. | ||
| Example: http://`yourpathtomagirc`/setup/ | ||
| MagIRC | ||
| ====== | ||
|
|
||
| Thank you for your interest in MagIRC, a PHP-based Web Frontend for IRC Services released under the GPLv3 license. | ||
|
|
||
| About MagIRC | ||
| ------------ | ||
| This software is a complete rewrite of phpDenora, a PHP-based Web Frontend for the [Denora Stats](http://www.denorastats.org) project. | ||
| In the future it will interface with other IRC services like [Anope](http://www.anope.org/) but the priority for now is to replace phpDenora since it is aged. | ||
|
|
||
| Main features | ||
| ------------- | ||
| * [Smarty](http://www.smarty.net/) templating engine | ||
| * [jQuery](http://www.jquery.com/)-based UI with AJAX interactions | ||
| * HTML5 and CSS3 | ||
| * Easy installation | ||
| * Administration panel | ||
| * Slick design | ||
|
|
||
| Requirements | ||
| ------------ | ||
| * Web Server with PHP 5.3+ and the *pdo_mysql*, *mcrypt* and *gettext* modules installed | ||
| * Web Browser supporting HTML5, CSS3 and JavaScript | ||
| * [Denora Stats](http://www.denorastats.org) server with MySQL enabled | ||
| * Supported IRC Daemons: Bahamut, Charybdis, InspIRCd, ircd-rizon, IRCu, Nefarious, Ratbox, ScaryNet, Unreal | ||
|
|
||
| Limitations | ||
| ----------- | ||
| The current version is considered to be **alpha** and has some known limitations: | ||
|
|
||
| * English only: MagIRC already has gettext localization built in, but it will be activated only once the software is nearly finished to avoid too much work maintaining language files for rapidly changing code. This is scheduled for the **beta** release. | ||
| * Only one default theme: MagIRC allows to install additional themes, but things need to be sorted out before fully this. This is scheduled for the **release candidate**. | ||
|
|
||
| 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; | ||
|
|
||
| Installation | ||
| ------------ | ||
| 1. Pull the latest MagIRC package from https://github.com/h9k/magirc/. | ||
| 2. Extract the MagIRC archive to your web server and move it's conetent to the MagIRC directory. | ||
| 3. Use your web browser to navigate to the setup folder on your server and follow on-screen instructions. | ||
| Example: http://`yourpathtomagirc`/setup | ||
|
|
||
| Note: If you are on Apache you can enable mod_rewrite by using "a2enmod rewrite; service apache2 restart" | ||
| and rename htaccess.txt in the root to .htaccess. | ||
|
|
||
| Upgrading | ||
| --------- | ||
| 1. Pull the latest MagIRC package from https://github.com/h9k/magirc/. | ||
| 2. Extract the MagIRC archive to your web server and move it's conetent to the MagIRC directory. | ||
| 3. Use your web browser to navigate to the setup folder on your server and follow on-screen instructions. | ||
| Example: http://`yourpathtomagirc`/setup/ |