-
-
-
-
diff -r ad210aa137a4 -r dcc7e491fbc9 doc/makedoc
--- a/doc/makedoc Thu Aug 06 18:34:10 2009 +0200
+++ /dev/null Thu Jan 01 00:00:00 1970 +0000
@@ -1,1 +0,0 @@
-xmlto --skip-validation html -m config.xsl sonews.xml
diff -r ad210aa137a4 -r dcc7e491fbc9 doc/sonews.css
--- a/doc/sonews.css Thu Aug 06 18:34:10 2009 +0200
+++ /dev/null Thu Jan 01 00:00:00 1970 +0000
@@ -1,35 +0,0 @@
-body
-{
- font-family: Liberation Sans,Verdana,sans-serif;
- font-size: 11pt;
-}
-
-.screen {
- font-family: monospace;
- font-size: 1em;
- display: block;
- padding: 10px;
- border: 1px solid #bbb;
- background-color: #eee;
- color: #000;
- overflow: auto;
- border-radius: 2.5px;
- -moz-border-radius: 2.5px;
- margin: 0.5em 2em;
-
-}
-
-.programlisting {
- font-family: monospace;
- font-size: 1em;
- display: block;
- padding: 10px;
- border: 1px solid #bbb;
- background-color: #ddd;
- color: #000;
- overflow: auto;
- border-radius: 2.5px;
- -moz-border-radius: 2.5px;
- margin: 0.5em 2em;
-}
-
diff -r ad210aa137a4 -r dcc7e491fbc9 doc/sonews.xml
--- a/doc/sonews.xml Thu Aug 06 18:34:10 2009 +0200
+++ /dev/null Thu Jan 01 00:00:00 1970 +0000
@@ -1,305 +0,0 @@
-
-
-
-]>
-
- sonews Usenet News Server
-
- sonews is NNTP server than can provide
- access to both local and global Usenets newsgroups. It is written in
- Java and uses a relational
- database as backend.
-
-
- 2009/07/28:
- sonews/1.0.0
- (binary tarball,
- source tarball) new major release.
- A lot of refactoring was done to make the code more robust and
- maintainable. Of course, several bugs were fixed, too ;)
- The 0.5.x line moves from unstable to testing in the DEB repository although
- the 1.0.x seems no less stable. If in doubt choose 1.0.x.
-
-
- 2009/07/01:
- sonews/0.5.1
- (binary tarball,
- source tarball) bugfix
- release.
- Broken Cancel-mechanism and broken buildscript fixed.
- See
- changelog for more details.
-
-
- 2009/06/29:
- sonews/0.5.0
- (binary tarball,
- source tarball) final
- released.
- The setup is a little clumsy but the software is stable and works well.
-
-
-
- Introduction
- sonews is a RCF3977 compliant NNTP Usenet server.
- It is written in Java and uses a relation database management system
- (RDBMS) as backend (currently
- PostgreSQL and
- MySQL).
- sonews is highly multithreaded and uses Java NIO asynchronous sockets
- to handle thousands of concurrent connections.
- sonews is Free and Open Source Software (FOSS) licensed under the
- terms of the
- GNU General Public License
- Version 3 (or later).
-
-
- History
- Ancestor of sonews is probably the Neat NNTP Daemon (n3tpd)
- although there is very little code in sonews that can be identified
- as direct derivation.
- sonews was developed as diploma thesis project of Christian Lins at
- StarOffice development
- in Hamburg and is now a Free Software project.
-
-
-
- Roadmap
-
- For sonews/1.1.x a plugin API for storage backends and command handlers
- is planned.
- See Bugtracker for
- issues with target sonews/1.1.x.
-
-
-
-
-
- Installation and initial setup
-
- Download & Installation
-
- Debian based systems
- You can install sonews with
- APT
- easily.
- Add the following line to /etc/apt/sources.list:
- deb http://packages.xerxys.info/debian/ testing main # for sonews/0.5.x
- deb http://packages.xerxys.info/debian/ unstable main # for sonews/1.0.x
- And add the GPG-Key for package authentification, see
- Xerxys Debian Repository
- for more details.
- Then force an update of your local package list:
- # apt-get update
- To install sonews and all prerequisites issue the following command:
- # apt-get install sonews
- This method should work for all recent Debian-based distributions
-(Debian, Ubuntu, etc.).
-
-
-
- Other *nix systems
- See Files Section for recent binary and source tarballs.
- Use the binary archive and extract it in a directory of your choice. Make sure your system
-provides the necessary prerequisites:
-
-
- Java6 compatible runtime (JRE)
-
-
- Java Mail API implementation, e.g. Sun Java Mail.
-GNU JavaMail has a broken POP3 Provider and does not work with sonews.
-
-
- JSP Servlet Container (e.g.
- Kitten) [optional]
-
-
-
-
-
-
- Initial database setup
- Before you start sonews, you must prepare the database. Currently sonews is known
-to work with PostgreSQL and MySQL.
- It is highly recommended to create an own database for every sonews instance, e.g.
-called 'sonews'. Additionally, it is recommended to create a unique database user
-for sonews, e.g. 'sonewsuser'. Please do not use the root user for sonews!
-The sonews user needs rights for SELECT, INSERT and UPDATE statements.
-Refer to the database's manual for instructions.
- You will find the SQL Schema definitions in the helpers subdirectory of
-the source and binary distributions. You can create the tables manually using
-this templates or you can use the setup helper:
- user@debian$ sonews setup
- or on other *nix systems:
- user@nix$ java -jar sonews.jar org.sonews.util.DatabaseSetup
- The tool will ask for some information about your database environment,
-connect to the database, create the tables and creates a default bootstrap
-config file called sonews.conf.
-
-
-
-
- Running sonews
-
- Configuration
- There is a bootstrap configuration in /etc/sonews/sonews.conf and a regular configuration
-in the database table config.
- There are various configuration values that can be adapted:
-
-
- ‘sonews.article.maxsize’
-
- Maximum allowed body size of a news message given in kilobytes. Please note that
-for MySQL the ‘max_allowed_packet’ configuration variable must
-be set to a value higher than ‘sonews.article.maxsize’ otherwise posting
-of large mails will fail.
-
-
-
- ‘sonews.debug’
-
-
- If set to true every(!) data going through sonews' socket
- is written to sonews.log. After a high traffic night the logfile can be
- several gigabytes large, so be careful with this setting.
-
-
-
-
- ‘sonews.hostname’
-
-
- Canonical name of the server instance. This variable is part of
- the server's hello message to the client and used to generate
- Message-Ids.
- It is highly recommended to set sonews.hostname to the full
- qualified domain name (FQDN) of the host machine.
-
-
-
-
- ‘sonews.timeout’
-
-
- Socket timeout for client connections in seconds. Default as
- recommended in RFC3977 is 180 seconds.
-
-
-
-
- ‘sonews.port’
-
-
- Listening port of sonews daemon. This value can be overridden
- with the -p command line argument.
-
-
-
-
- ‘sonews.xdaemon.host’
-
-
- Hostname or IP address of the client machine that is allowed to
- use the XDAEMON command. Default: localhost
-
-
-
-
-
-
-
- Command line arguments
- If you like to start sonews directly, you can use one of the following
-arguments:
- java -jar sonews.jar [arguments]
- where arguments:
- -c|-config <path to config file> if custom config file preferred
- -dumpjdbcdriver Prints out a list of available JDBC drivers
- -feed Enables feed daemon for pulling news from peer servers
- -h|-help This output
- -mlgw Enables the Mailinglist Gateway poller
- -p portnumber Port on which sonews is listening for incoming connections.
- Overrides port settings in config file and database.
-
-
-
- Webinterface
- The package sonews-web provides an optional webinterface that can be used to
-review statistical information and configuration values of sonews.
- sonews-web start|stop
- The webinterface uses the the lightweight Servlet Container Kitten and is
-per default listening on HTTP-Port 8080 (go to http://localhost:8080/sonews).
-
-
-
- Newsgroup configuration
-
- Currently some manual work is necessary to create a newsgroup hosted
- by a sonews instance.
-
-
- One possibility is to talk via Telnet to the sonews instance and
- use the non-standard command XDAEMON.
- telnet localhost 119
- XDAEMON GROUPADD local.test 0
- Please note that the XDAEMON command has restricted access and is only
- available via local connections (default, can be changed with config
- value sonews.xdaemon.host).
-
-
- You can also use the web interface to create newsgroups.
-
-
-
-
-
- Development
- You're welcome to create patches with bugfixes or additional features. The
-Mercurial DSCM makes this step an easy task.
- Just clone the public Mercurial repository:
- hg clone http://code.xerxys.info:8000/hg/sonews/ sonews-trunk
- Then make your changes, create a bundle of changesets and send this to me via email.
-Or ask for push access to the public repository.
-
- There is a nightly generated Javadoc API documentation that will help
- you to get in touch with the sonews source.
-
- Some debugging hints: if the server blocks and does not longer respond you
-probably found a deadlock. Do not kill the process with "kill -9 <pid>"
-but send a SIGQUIT signal with "kill -3 <pid>" and the Java VM will output
-a stracktrace of all threads. This output is the most valuable information to
-fix the deadlock.
-
-
- Contributors
- Maintainer and project lead:
-Christian Lins (contact christian.lins (at) fh-osnabrueck.de)
-
-
-
- Sponsors
- The author thanks Sun Microsystems for fully
-financing the first version of sonews. A really free software supporting company!
- If you like to support sonews with a donation of any kind (hardware, books, money, donuts,...),
- feel free to contact the project leader.
-A friendly email or a bug report is most welcome, too :-)
-
-
-
-
- Links and further information
-
-
- Bugtracker, register necessary, see project 'sonews'.
-
-
- Sun Microsystems, friendly sponsor.
-
-
- University of Applied Sciences Osnabrueck
-
-
-
-
This work by Christian Lins is licensed under a Creative Commons Attribution-Share Alike 3.0 License.
-