2003-05-28 14:33:19 +00:00
|
|
|
************************************************************************
|
|
|
|
** NeoStats - IRC Statistical Services **
|
2008-02-24 02:45:41 +00:00
|
|
|
** Copyright (c) 1999-2008 NeoStats Group. All Rights Reserved. **
|
2003-05-28 14:33:19 +00:00
|
|
|
** This program and all associated documentation is free but **
|
|
|
|
** copyrighted software; see the file COPYING for details. **
|
|
|
|
** Homepage: http://www.neostats.net/ **
|
|
|
|
************************************************************************
|
|
|
|
|
|
|
|
Thank you for downloading NeoStats.
|
|
|
|
|
|
|
|
NeoStats is a powerful and extendable set of *services* for IRC. By
|
2003-10-06 20:10:42 +00:00
|
|
|
Services, we do not mean NickServ/Chanserv etc but additional services.
|
|
|
|
These additional services include things like StatServ which gives you
|
|
|
|
statistics on the number of users/operators/channels/servers, and
|
|
|
|
MoraleServ, which is a *fun* module, to send funny messages to users,
|
|
|
|
and utility modules. Some modules have a useful function on your
|
|
|
|
network, other modules are developed for fun, and to make your IRC
|
2004-07-27 12:44:20 +00:00
|
|
|
network more attractive to users.
|
2003-05-28 14:33:19 +00:00
|
|
|
|
2004-10-27 21:46:15 +00:00
|
|
|
The 3.0 series of NeoStats offers many improvements over previous
|
|
|
|
versions. A detailed list of changes can be found in the ChangeLog file,
|
|
|
|
but a brief summary is:
|
|
|
|
- Simplified configure, build and install process.
|
|
|
|
- Improved debug mode to provide information to us more easily in
|
|
|
|
the event of problems and avoid polluting general logs with
|
|
|
|
debug information.
|
|
|
|
- New segfault log file to log any segfaults which occur with
|
|
|
|
NeoStats for better support.
|
|
|
|
- New and improved API for module coders.
|
|
|
|
- Many updates to the various modules.
|
|
|
|
- New backend database storage based on standard DBM systems.
|
|
|
|
- New athentication modules and API to allow custom authentication.
|
|
|
|
- Improved protocol module API to make it easier to add support for
|
|
|
|
other IRCds.
|
|
|
|
- Many optimisations of the core to speed up NeoStats operation and
|
|
|
|
reduce the resource requirements.
|
|
|
|
- DCC chat support to allow users to operate NeoStats via a DCC chat
|
|
|
|
session.
|
|
|
|
- Native Windows support including full support for modules.
|
|
|
|
- All commands have configurable user levels.
|
2008-03-05 04:12:56 +00:00
|
|
|
- Perl API, so you can write new modules or extend existing modules
|
|
|
|
in the Perl Scripting Language
|
|
|
|
- Automatic notification of new versions, when they become available
|
|
|
|
- a large range of supported IRCd's
|
2002-02-27 11:19:15 +00:00
|
|
|
|
2003-05-28 14:33:19 +00:00
|
|
|
Visit http://www.neostats.net for the latest news and NeoStats updates.
|
|
|
|
|
|
|
|
Please read all documentation included with NeoStats carefully. The
|
|
|
|
documents contain all the information you need to get NeoStats running
|
2008-03-05 04:12:56 +00:00
|
|
|
on your network. These documents include README, and the wiki, at
|
|
|
|
http://wiki.neostats.net/confluence/display/NeoStats/Home
|
2003-05-28 14:33:19 +00:00
|
|
|
|
2003-10-06 20:10:42 +00:00
|
|
|
-----------------------------------<>-----------------------------------
|
2004-07-27 12:44:20 +00:00
|
|
|
All documentation applies to version 3.0.0 and higher. For older
|
2003-05-28 14:33:19 +00:00
|
|
|
versions consult the documentation with that version or consider
|
|
|
|
upgrading. New versions of NeoStats have many new features and bug
|
|
|
|
fixes. We are not able to provide support for older versions of
|
|
|
|
NeoStats.
|
|
|
|
|
|
|
|
Following is a quick guide to the main NeoStats documentation:
|
|
|
|
|
2003-10-06 20:10:42 +00:00
|
|
|
README - This file. How to install and configure NeoStats
|
|
|
|
and support information.
|
2003-05-28 14:33:19 +00:00
|
|
|
RELNOTES - Release notes about the current version. This is
|
2003-10-06 20:10:42 +00:00
|
|
|
displayed during the installation process but you should
|
|
|
|
refer to it if you have problems.
|
|
|
|
ChangeLog - Information about what has changed between versions.
|
|
|
|
Consult this document for detailed information about the
|
2004-07-27 12:44:20 +00:00
|
|
|
changes.
|
2008-03-05 04:12:56 +00:00
|
|
|
The Majority of Documentation can now be found on our NeoStats Wiki,
|
|
|
|
located at http://wiki.neostats.net/confluence/display/NeoStats/Home
|
|
|
|
You are encouraged to check that site, as thats where most recent
|
|
|
|
version of our documenation will be
|
|
|
|
|
2003-05-28 14:33:19 +00:00
|
|
|
-----------------------------------<>-----------------------------------
|
|
|
|
|
|
|
|
Contents
|
|
|
|
--------
|
|
|
|
|
|
|
|
1. Installing and configuring NeoStats
|
2003-10-06 20:10:42 +00:00
|
|
|
1.1 General notes
|
|
|
|
1.2 Getting Started.
|
|
|
|
1.3 Running configure
|
|
|
|
1.4 Compiling NeoStats
|
|
|
|
1.5 Installing NeoStats
|
2004-07-27 13:02:00 +00:00
|
|
|
1.6 Setting up the neostats.conf file
|
2003-10-06 20:10:42 +00:00
|
|
|
1.7 Compiling additional modules
|
|
|
|
1.8 Running NeoStats
|
|
|
|
1.9 Notes for upgraders
|
2003-05-28 14:33:19 +00:00
|
|
|
2. Support Information
|
2003-10-06 20:10:42 +00:00
|
|
|
2.1 Before contacting support
|
|
|
|
2.2 Where to get support
|
|
|
|
2.3 What to provide when requesting support.
|
2003-05-28 14:33:19 +00:00
|
|
|
3. Contributions
|
|
|
|
|
|
|
|
|
|
|
|
1. Installing and configuring NeoStats
|
|
|
|
--------------------------------------
|
|
|
|
|
|
|
|
This section explains how to install and configure NeoStats. We
|
2003-10-06 20:10:42 +00:00
|
|
|
recommend that you read this section in full before trying to install
|
|
|
|
NeoStats.
|
2003-05-28 14:33:19 +00:00
|
|
|
|
2003-10-06 20:10:42 +00:00
|
|
|
If you have any problems NOT addressed in this or other documents,
|
2003-05-28 14:33:19 +00:00
|
|
|
please see the Support section for how to contact us for help.
|
|
|
|
|
2003-10-06 20:10:42 +00:00
|
|
|
|
2003-05-28 14:33:19 +00:00
|
|
|
1.1 General notes
|
|
|
|
-----------------
|
|
|
|
|
2003-10-06 20:10:42 +00:00
|
|
|
All commands and filenames are case sensitive. This means that
|
|
|
|
NeoStats, neostats and NEOSTATS are all different things. When
|
|
|
|
typing commands you should use the same case as provided in this
|
|
|
|
file or things will not work correctly.
|
|
|
|
|
2003-05-28 14:33:19 +00:00
|
|
|
|
|
|
|
1.2 Getting Started
|
|
|
|
-------------------
|
|
|
|
|
2003-10-06 20:10:42 +00:00
|
|
|
First, you need to uncompress NeoStats. To do this type the following:
|
2003-05-28 14:33:19 +00:00
|
|
|
|
2004-07-07 13:54:38 +00:00
|
|
|
tar xvfz NeoStats3.0.x.tar.gz
|
2003-05-28 14:33:19 +00:00
|
|
|
|
2003-10-06 20:10:42 +00:00
|
|
|
This will vary depending on the version you run of NeoStats. Change the
|
2004-07-07 13:54:38 +00:00
|
|
|
x in NeoStats3.0.x.tar.gz to match your filename e.g.
|
2003-05-28 14:33:19 +00:00
|
|
|
|
2004-07-07 13:54:38 +00:00
|
|
|
NeoStats3.0.0.tar.gz
|
2003-05-28 14:33:19 +00:00
|
|
|
|
2003-10-06 20:10:42 +00:00
|
|
|
For systems that don't run a new version of tar you need to do this:
|
|
|
|
|
2004-07-07 13:54:38 +00:00
|
|
|
gzip -d NeoStats3.0.x.tar.gz
|
|
|
|
tar xvf NeoStats3.0.x.tar
|
2003-05-28 14:33:19 +00:00
|
|
|
|
|
|
|
1.3 Running configure
|
|
|
|
---------------------
|
|
|
|
|
2004-07-07 13:54:38 +00:00
|
|
|
You must first run the configure script so that NeoStats can determine
|
|
|
|
your build environment.
|
2003-05-28 14:33:19 +00:00
|
|
|
|
2004-07-07 13:54:38 +00:00
|
|
|
To run configure, you must first change to the directory where you
|
2003-10-06 20:10:42 +00:00
|
|
|
uncompressed NeoStats. e.g.
|
2003-05-28 14:33:19 +00:00
|
|
|
|
2004-07-07 13:54:38 +00:00
|
|
|
cd ~/NeoStats3.0.0
|
2003-05-28 14:33:19 +00:00
|
|
|
|
2003-10-06 20:10:42 +00:00
|
|
|
Your prompt should look something like:
|
|
|
|
|
2004-09-02 20:59:46 +00:00
|
|
|
[user@host NeoStats3.0.0]
|
2003-05-28 14:33:19 +00:00
|
|
|
|
2003-10-06 20:10:42 +00:00
|
|
|
Now type:
|
|
|
|
|
2004-07-07 13:54:38 +00:00
|
|
|
./configure
|
2003-10-06 20:10:42 +00:00
|
|
|
|
2004-07-07 13:54:38 +00:00
|
|
|
The configure script will then check to see if all necessary programs to
|
|
|
|
run NeoStats are installed on your system.
|
2003-10-06 20:10:42 +00:00
|
|
|
|
|
|
|
Optional settings:
|
|
|
|
------------------
|
|
|
|
|
2004-07-07 13:54:38 +00:00
|
|
|
There are some options you can pass to configure if you wish.
|
2003-10-06 20:10:42 +00:00
|
|
|
|
|
|
|
Debugging:
|
|
|
|
|
|
|
|
Most users will never look at this option. It compiles NeoStats
|
|
|
|
with debugging turned on. I would only suggest using this if you
|
2005-02-22 20:02:58 +00:00
|
|
|
have problems and are about to make a bug report.
|
2003-10-06 20:10:42 +00:00
|
|
|
|
|
|
|
--enable-debug Enables Debugging
|
|
|
|
|
|
|
|
Enabling RAW command:
|
|
|
|
|
|
|
|
We strongly recommend against the use of this option. Use of RAW
|
|
|
|
commands can cause desync on your network and badly formatted commands
|
|
|
|
can crash your network. If you do enable this option, we will not
|
|
|
|
provide any support for your use of this command. Please do not contact
|
|
|
|
us for support of the RAW command.
|
|
|
|
|
|
|
|
--enable-raw
|
|
|
|
|
2003-05-28 14:33:19 +00:00
|
|
|
|
|
|
|
1.4 Compiling NeoStats
|
|
|
|
----------------------
|
|
|
|
|
2005-02-22 20:02:58 +00:00
|
|
|
You should now be back at a shell prompt, type:
|
2003-05-28 14:33:19 +00:00
|
|
|
|
2003-10-06 20:10:42 +00:00
|
|
|
make
|
2003-05-28 14:33:19 +00:00
|
|
|
|
2003-10-06 20:10:42 +00:00
|
|
|
it will go through the source and compile it into an executable
|
2004-10-27 21:46:15 +00:00
|
|
|
binary file.
|
2003-05-28 14:33:19 +00:00
|
|
|
|
|
|
|
|
|
|
|
1.5 Installing NeoStats
|
|
|
|
-----------------------
|
|
|
|
|
2003-10-06 20:10:42 +00:00
|
|
|
If you are upgrading a working version of NeoStats. Please read section
|
|
|
|
1.9 Notes for Upgraders now.
|
2003-05-28 14:33:19 +00:00
|
|
|
|
2004-07-07 13:54:38 +00:00
|
|
|
NeoStats must be "installed" into its own directory. By default NeoStats
|
|
|
|
will install into ~/NeoStats3.0/ i.e. in your home directory e.g.
|
2003-05-28 14:33:19 +00:00
|
|
|
|
2004-07-07 13:54:38 +00:00
|
|
|
/home/fish/NeoStats3.0/
|
2003-10-06 20:10:42 +00:00
|
|
|
|
|
|
|
If you wish to change the install location, please type
|
2003-05-28 14:33:19 +00:00
|
|
|
|
2003-10-06 20:10:42 +00:00
|
|
|
./configure --help
|
|
|
|
|
|
|
|
and follow the instructions on screen.
|
2003-05-28 14:33:19 +00:00
|
|
|
|
2003-10-06 20:10:42 +00:00
|
|
|
To install NeoStats type:
|
2003-05-28 14:33:19 +00:00
|
|
|
|
2003-10-06 20:10:42 +00:00
|
|
|
make install
|
2003-05-28 14:33:19 +00:00
|
|
|
|
2003-10-06 20:10:42 +00:00
|
|
|
This will create the necessary files, and copy them to the
|
|
|
|
installation directory.
|
2003-05-28 14:33:19 +00:00
|
|
|
|
2003-10-06 20:10:42 +00:00
|
|
|
|
2004-07-27 13:02:00 +00:00
|
|
|
1.6 Setting up the neostats.conf file
|
|
|
|
-------------------------------------
|
2003-10-06 20:10:42 +00:00
|
|
|
|
|
|
|
Now you should change to the installation directory (~/NeoStats/, or
|
|
|
|
whatever you specified in ./configure) e.g.
|
|
|
|
|
2004-07-07 13:54:38 +00:00
|
|
|
cd ~/NeoStats3.0
|
2003-10-06 20:10:42 +00:00
|
|
|
|
|
|
|
Your prompt should look something like:
|
|
|
|
|
2004-07-07 13:54:38 +00:00
|
|
|
[user@host NeoStats3.0]
|
2003-10-06 20:10:42 +00:00
|
|
|
|
|
|
|
Once in this directory, you need to create a configuration file. You
|
|
|
|
should now run the makeconf script and answer the questions:
|
|
|
|
|
2004-10-27 21:46:15 +00:00
|
|
|
./bin/makeconf
|
2003-10-06 20:10:42 +00:00
|
|
|
|
2004-07-27 13:02:00 +00:00
|
|
|
You must edit neostats.conf to check that everything is set the way you
|
2003-10-06 20:10:42 +00:00
|
|
|
want it before NeoStats will run. You can do this with:
|
|
|
|
|
2004-07-27 13:02:00 +00:00
|
|
|
pico neostats.conf
|
2003-10-06 20:10:42 +00:00
|
|
|
|
2004-10-03 21:46:03 +00:00
|
|
|
All the options are described in the neostats.conf file and you should
|
|
|
|
refer to this file for assistance.
|
2003-10-06 20:10:42 +00:00
|
|
|
|
2004-10-03 21:46:03 +00:00
|
|
|
When you are finished, save the file. If using pico as in the previous
|
|
|
|
example, press Ctrl-X then hit Y and enter to save the file and exit.
|
2003-05-28 14:33:19 +00:00
|
|
|
|
|
|
|
1.7 Compiling additional modules
|
|
|
|
--------------------------------
|
|
|
|
|
2003-10-06 20:10:42 +00:00
|
|
|
If you have downloaded other NeoStats modules e.g. OPSB, you should now
|
|
|
|
install them. If you are upgrading NeoStats, you must rebuild all other
|
|
|
|
separate modules to work with the new version of NeoStats. See the
|
|
|
|
documentation with these modules for instructions on building and
|
2004-10-27 21:46:15 +00:00
|
|
|
installing them.
|
|
|
|
|
|
|
|
Modules written for previous series of NeoStats will not work with the
|
|
|
|
3.0 series. You must contact the module author for an updated version of
|
|
|
|
the module. All official modules have a 3.0 compatible version available.
|
2003-05-28 14:33:19 +00:00
|
|
|
|
|
|
|
1.8 Running NeoStats
|
|
|
|
--------------------
|
|
|
|
|
2003-10-06 20:10:42 +00:00
|
|
|
NeoStats is now configured and installed.
|
2003-05-28 14:33:19 +00:00
|
|
|
|
2003-10-06 20:10:42 +00:00
|
|
|
Before running NeoStats you must make sure that your server(s) have C:
|
|
|
|
N: and U: lines for your NeoStats server.
|
2004-10-27 21:46:15 +00:00
|
|
|
WE WILL NOT ASSIST YOU WITH ADDING C: N: AND U: LINES TO YOUR SERVER,
|
2003-10-06 20:10:42 +00:00
|
|
|
YOU SHOULD READ THE IRCD DOCUMENTATION IF YOU DO NOT KNOW HOW TO DO
|
|
|
|
IT!!! DO NOT CONTACT US ABOUT C: N: and U: Lines
|
2003-05-28 14:33:19 +00:00
|
|
|
|
2003-10-06 20:10:42 +00:00
|
|
|
Once your C/N/U lines are setup, you need to start NeoStats. You should
|
|
|
|
change to the directory where NeoStats in installed e.g.
|
2003-05-28 14:33:19 +00:00
|
|
|
|
2004-07-07 13:54:38 +00:00
|
|
|
cd ~/NeoStats3.0
|
2002-03-28 05:29:36 +00:00
|
|
|
|
2003-10-06 20:10:42 +00:00
|
|
|
Then to run NeoStats type:
|
|
|
|
|
2008-03-05 04:12:56 +00:00
|
|
|
./neostats start
|
2003-10-06 20:10:42 +00:00
|
|
|
|
|
|
|
It should link and sync with your server in a matter of seconds.
|
|
|
|
|
2008-03-05 04:12:56 +00:00
|
|
|
Please now read
|
|
|
|
http://wiki.neostats.net/confluence/display/NeoStats/Operator+Manual
|
|
|
|
for details on how to operate NeoStats from an IRC Client.
|
2003-05-28 14:33:19 +00:00
|
|
|
|
2003-10-07 14:26:21 +00:00
|
|
|
If anything goes wrong, there *might* be an error message in the log
|
2004-10-27 21:46:15 +00:00
|
|
|
files. Have a look in ~/NeoStats3.0/logs/neostats-date.log it might give
|
|
|
|
you a clue to what's wrong! NeoStats might also send a wallops to the
|
|
|
|
network about what went wrong. Check the status window of your IRC client.
|
2003-10-06 20:10:42 +00:00
|
|
|
|
|
|
|
There are some command line options for NeoStats that you may find
|
|
|
|
useful:
|
|
|
|
|
|
|
|
-h will display a help screen showing these options.
|
|
|
|
-v will display the version number
|
2005-02-01 23:05:43 +00:00
|
|
|
-d 1-10 Enable debugging output 1 = lowest, 10 = highest
|
2003-10-06 20:10:42 +00:00
|
|
|
-n Do not load any modules on startup
|
|
|
|
-q Quiet start - for cron scripts
|
|
|
|
-f Do not fork into background (for debugging)
|
|
|
|
|
|
|
|
To use these options, add the option(s) you require when you run
|
|
|
|
NeoStats, e.g.:
|
|
|
|
|
2008-03-05 04:12:56 +00:00
|
|
|
./neostats start -h
|
2003-10-06 20:10:42 +00:00
|
|
|
|
|
|
|
Note: although you can combine most of these options, -v (version)
|
|
|
|
and -h (help) will return information to you and NeoStats will not
|
|
|
|
process any other options you pass.
|
2003-05-28 14:33:19 +00:00
|
|
|
|
|
|
|
|
|
|
|
1.9 Notes for upgraders
|
|
|
|
-----------------------
|
|
|
|
|
2004-10-27 21:46:15 +00:00
|
|
|
This section is for users upgrading a NeoStats 3.0 series installation
|
|
|
|
only. If you are upgrading from an older series of NeoStats such as
|
|
|
|
2.5.x, you must treat it as a new installation. Your configuration and
|
|
|
|
data from 2.5.x is not compatible with NeoStats 3.0.
|
|
|
|
|
|
|
|
If you are upgrading from an older version of the 3.0 series we
|
|
|
|
recommend that you backup the current version first.
|
2003-05-28 14:33:19 +00:00
|
|
|
|
2003-10-06 20:10:42 +00:00
|
|
|
If you are running crontab for NeoStats, we recommend that you disable
|
|
|
|
this before making the upgrade so that cron does not start up an older
|
|
|
|
versopn while you are working on the upgrade.
|
2002-12-26 05:21:44 +00:00
|
|
|
|
2003-10-06 20:10:42 +00:00
|
|
|
Make sure that NeoStats is not running. In an IRC client connected to
|
|
|
|
your network type:
|
|
|
|
|
|
|
|
/msg NeoStats shutdown Upgrade
|
|
|
|
|
|
|
|
NeoStats will save important information so wait for this to finish.
|
|
|
|
|
|
|
|
To make the backup go to your home directory and type:
|
|
|
|
|
2004-10-27 21:46:15 +00:00
|
|
|
cp NeoStats3.0 NeoStatsBackup -r
|
2003-10-06 20:10:42 +00:00
|
|
|
|
|
|
|
If you fail to perform this backup and the upgrade causes you problems,
|
|
|
|
you might lose all NeoStats information.
|
|
|
|
|
|
|
|
We also recommend rebuilding any additional modules after upgrading
|
|
|
|
NeoStats. You may not need to upgrade the additional module, just
|
|
|
|
rebuild and reinstall it after the make install in Step 1.4 above.
|
|
|
|
|
|
|
|
If after upgrading, NeoStats crashes when loading one of your modules
|
|
|
|
e.g. OPSB, this usually means that you did not rebuild the module for
|
|
|
|
the latest version of NeoStats.
|
|
|
|
|
|
|
|
If you do run into problems upgrading and need to restore your backup,
|
|
|
|
you can do so by going to your home directory and typing:
|
|
|
|
|
2004-10-27 21:46:15 +00:00
|
|
|
cp NeoStatsBackup NeoStats3.0 -r
|
2003-10-06 20:10:42 +00:00
|
|
|
|
|
|
|
Your old modules will also be restored along with the old version of
|
|
|
|
NeoStats so there is no need to rebuild them for a restore.
|
2003-05-28 14:33:19 +00:00
|
|
|
|
|
|
|
|
|
|
|
-----------------------------------<>-----------------------------------
|
|
|
|
|
|
|
|
2 Support Information
|
|
|
|
---------------------
|
|
|
|
|
|
|
|
2.1 Before contacting support
|
|
|
|
-----------------------------
|
|
|
|
|
|
|
|
** IMPORTANT - PLEASE READ BEFORE CONTACTING US **
|
|
|
|
|
2004-07-27 12:44:20 +00:00
|
|
|
In order that we can dedicate time to developing NeoStats and can address
|
|
|
|
support issues quickly, there are some ways you can help to reduce
|
|
|
|
unnecessary support calls to the NeoStats team.
|
|
|
|
|
|
|
|
First, check you are using the latest release version of NeoStats as found on
|
|
|
|
the NeoStats download page. It could be that your problem is fixed or your
|
|
|
|
suggestion implemented in the latest version. We are not able to provide
|
|
|
|
support for older versions of NeoStats than the current release.
|
|
|
|
|
|
|
|
We provide no support for SVN snapshots whether released on the web site or
|
|
|
|
not. If you have downloaded a SVN snapshot and are having problems, you should
|
|
|
|
revert back to your previous working version or if this is your first
|
|
|
|
installation, the current release build as indicated on the web site. Please
|
|
|
|
do not contact us about problems with SVN versions. We will advise users
|
|
|
|
occasionally to try a SVN snapshot to fix a problem, but as we do not put our
|
|
|
|
SVN versions through extensive testing, there might be new bugs or problems.
|
|
|
|
|
|
|
|
We may occasionally provide a custom modification to resolve a problem. Other
|
|
|
|
than in this event, we provide no support for modified versions of NeoStats.
|
|
|
|
If you have modified NeoStats in any way and experience problems, you should
|
|
|
|
only contact us if you can reproduce the problem with an unmodified version.
|
|
|
|
We are not able to support modifications to NeoStats made by others.
|
|
|
|
|
|
|
|
Before contacting us with a problem or a bug, please make sure you have read
|
|
|
|
all the documentation provided. You should then check the web site bug list
|
|
|
|
and search the forums to see if your problem has already been reported and if
|
|
|
|
a solution has been posted.
|
|
|
|
|
2005-02-22 20:02:58 +00:00
|
|
|
Read the log files. NeoStats tries to log problems it encounters and the log
|
|
|
|
file should tell you what went wrong. If the error in the log file does not
|
|
|
|
help you, you still need to tell us what it says.
|
|
|
|
|
2004-07-27 12:44:20 +00:00
|
|
|
Before sending us a suggestion, you should check the forums carefully to see
|
|
|
|
if your suggestion has already been made and if the NeoStats team have decided
|
|
|
|
to implement it or not.
|
2003-05-28 14:33:19 +00:00
|
|
|
|
|
|
|
You do not have to read all the messages to find out if your issue has
|
2004-07-27 12:44:20 +00:00
|
|
|
already been discussed. The use of the "Search" feature on the forums is a
|
|
|
|
great way to quickly get answers to your problem if other users have already
|
|
|
|
encountered the issue.
|
|
|
|
|
2005-02-22 20:02:58 +00:00
|
|
|
Read the post entitled Bug Reporting Guidelines in the forum before posting.
|
|
|
|
This is at the top of all the support forums. It reminds you what
|
|
|
|
information you must provide to get support.
|
|
|
|
|
2004-07-27 12:44:20 +00:00
|
|
|
NeoStats Group are only able to help with issues affecting NeoStats. We are
|
|
|
|
not able to help set up your IRC Server or Services on your network (including
|
|
|
|
the setup of C: N: and U: lines) so please don't ask us. If you have a
|
|
|
|
question about your IRC Server or Services package, please check the
|
|
|
|
documentation that came with them and contact their team if you still need
|
|
|
|
assistance.
|
|
|
|
|
|
|
|
The RAW command is an unsupported command. If you need help using it, you
|
|
|
|
should probably not be using it. Please do not ask us for help on the RAW
|
|
|
|
command.
|
2003-05-28 14:33:19 +00:00
|
|
|
|
|
|
|
Thank you.
|
|
|
|
|
|
|
|
|
|
|
|
2.1 Where to get support
|
|
|
|
------------------------
|
|
|
|
|
|
|
|
You can get support for NeoStats in a number of different ways so choose
|
|
|
|
the one that suits you best.
|
|
|
|
|
|
|
|
* Bug reporting system
|
2005-02-22 20:02:58 +00:00
|
|
|
You can check this to see if there are any known bugs in NeoStats and
|
|
|
|
find out when they are fixed. For the bug tracking system, visit:
|
2003-10-06 20:10:42 +00:00
|
|
|
|
2005-02-22 20:02:58 +00:00
|
|
|
http://bugs.neostats.net/
|
2003-10-06 20:10:42 +00:00
|
|
|
|
|
|
|
* Message boards available at:
|
|
|
|
|
|
|
|
http://www.neostats.net/boards/
|
2003-05-28 14:33:19 +00:00
|
|
|
|
2008-03-05 04:12:56 +00:00
|
|
|
* The Neostats Wiki available at:
|
|
|
|
http://wiki.neostats.net/confluence/display/NeoStats/
|
|
|
|
|
2003-10-06 20:10:42 +00:00
|
|
|
* The NeoStats IRC support channel at:
|
2003-05-28 14:33:19 +00:00
|
|
|
|
2003-10-06 20:10:42 +00:00
|
|
|
server: irc.irc-chat.net
|
|
|
|
channel: #neostats
|
|
|
|
|
|
|
|
Be warned that we are not always available on the channel to help you.
|
2003-05-28 14:33:19 +00:00
|
|
|
|
|
|
|
2.2 What to provide when requesting support
|
|
|
|
-------------------------------------------
|
|
|
|
|
2003-10-06 20:10:42 +00:00
|
|
|
It always helps to provide as much information as possible about your
|
|
|
|
environment when asking for help. Please make sure you include at least
|
|
|
|
the following information:
|
|
|
|
|
|
|
|
Operating system version (i.e., Redhat 7.0, Mandrake 9.1 etc)
|
|
|
|
gcc version (found via gcc -v)
|
|
|
|
Version of NeoStats you are using and if the problem is with a
|
|
|
|
module, the version of the module (found via /msg neostats modlist)
|
|
|
|
The type of IRCD you are attempting to connect to (and version
|
|
|
|
number)
|
2005-02-22 20:02:58 +00:00
|
|
|
NeoStats will generate a file called segfault.log if it crashes. If
|
|
|
|
this file exists, you must send it to us.
|
|
|
|
|
2003-10-06 20:10:42 +00:00
|
|
|
We may request that you enable debugging and submit us the results of
|
2005-02-22 20:02:58 +00:00
|
|
|
debugging. To enable debugging, use the following command to start
|
2003-10-06 20:10:42 +00:00
|
|
|
NeoStats:
|
|
|
|
|
2004-10-27 21:46:15 +00:00
|
|
|
./bin/neostats -d10
|
2003-10-06 20:10:42 +00:00
|
|
|
|
2005-02-22 20:02:58 +00:00
|
|
|
When it crashes, or the bug has been reproduced, send the following
|
|
|
|
files:
|
2003-10-06 20:10:42 +00:00
|
|
|
|
2005-02-22 20:02:58 +00:00
|
|
|
segfault.log
|
2004-07-07 13:54:38 +00:00
|
|
|
logs/debug.log
|
2003-10-06 20:10:42 +00:00
|
|
|
|
|
|
|
This will help us to be able to reproduce the bug and create a fix for
|
|
|
|
it.
|
2003-05-28 14:33:19 +00:00
|
|
|
|
2008-03-05 04:12:56 +00:00
|
|
|
Sometimes we might request you to run a GDB backtrace of the problem
|
|
|
|
In order to generate that you will execute the following commands:
|
|
|
|
|
|
|
|
gdb bin/neostats
|
|
|
|
|
|
|
|
when you arrive at the GDB command prompt, type:
|
|
|
|
|
|
|
|
run -fd 10
|
|
|
|
|
|
|
|
now go and make NeoStats crash in some way. when it crashs, you will
|
|
|
|
be returned to the GDB command prompt. Type:
|
|
|
|
|
|
|
|
bt full
|
|
|
|
|
|
|
|
and save that output to send to us. To exit GDB, just type "quit"
|
|
|
|
|
2005-02-22 20:02:58 +00:00
|
|
|
Remember you cannot give us too much information about your system and
|
|
|
|
setup, but if you do not give us enough, we cannot help you and if we
|
|
|
|
have to keep asking you to provide more information, that is less time
|
|
|
|
we are spending fixing and developing NeoStats.
|
|
|
|
|
2003-05-28 14:33:19 +00:00
|
|
|
-----------------------------------<>-----------------------------------
|
|
|
|
|
|
|
|
3. Contributions
|
|
|
|
----------------
|
|
|
|
|
2003-10-06 20:10:42 +00:00
|
|
|
Want to Help us?
|
2003-05-28 14:33:19 +00:00
|
|
|
|
|
|
|
We are always looking for help.
|
|
|
|
|
2003-10-06 20:10:42 +00:00
|
|
|
Currently, what we really are looking for is people to help us out with
|
2008-03-05 04:12:56 +00:00
|
|
|
our documentation on the wiki and of course, other people that can code
|
2003-10-06 20:10:42 +00:00
|
|
|
in C to help us with development.
|
2003-05-28 14:33:19 +00:00
|
|
|
|
2008-03-05 04:12:56 +00:00
|
|
|
if you would like to have a go at writting your own module, in either
|
|
|
|
C or Perl, you can consult
|
|
|
|
http://wiki.neostats.net/confluence/display/Dev for documenation. We
|
|
|
|
will also provide you with a SVN repository, bug tracker, and all the
|
|
|
|
other tools that we use (such as build servers etc) if you want it.
|
|
|
|
Just contact Fish to find out how to get started.
|
2003-05-28 14:33:19 +00:00
|
|
|
|
2003-10-06 20:10:42 +00:00
|
|
|
If you would like to help out, See Support Information above for details
|
|
|
|
on how to contact us.
|
2003-05-28 14:33:19 +00:00
|
|
|
|
2008-03-05 04:12:56 +00:00
|
|
|
Finally, as I (Fish) do not have a single artistic bone in my body, I'm
|
|
|
|
always looking for people to help out with our websites at
|
|
|
|
http://www.neostats.net and http://secure.irc-chat.net/. If you are any
|
|
|
|
good with HTML and would like to help us "spruce" up our webpages, just
|
|
|
|
contact me.
|
|
|
|
|
2003-05-28 14:33:19 +00:00
|
|
|
-----------------------------------<>-----------------------------------
|
|
|
|
|
|
|
|
************************************************************************
|
2008-03-05 04:12:56 +00:00
|
|
|
** This document was last updated on March 5th, 2008 by Fish **
|
2003-09-29 12:46:22 +00:00
|
|
|
************************************************************************
|