From dc8fbb11b2a200c177c336db75fa38c6f12426db Mon Sep 17 00:00:00 2001 From: Retro_Guy Date: Thu, 3 Dec 2020 16:40:08 -0700 Subject: [PATCH] Separate README and INSTALL files --- INSTALL.md | 47 +++++++++++++++++++++++++++++++++++++++ README.md | 64 +++++++++++++++++------------------------------------- 2 files changed, 67 insertions(+), 44 deletions(-) create mode 100644 INSTALL.md diff --git a/INSTALL.md b/INSTALL.md new file mode 100644 index 0000000..46a505c --- /dev/null +++ b/INSTALL.md @@ -0,0 +1,47 @@ +Installing Rocksolid Light (rslight) - a web based Usenet news client + +Requirements: + +You will need a web server: rslight has been tested with apache2, lighttpd, nginx +and synchronet web servers + +php is required, and your web server must be configured to serve .php. + +php-mbstring (to support other character sets), sharutils (for uudecode) and +openssl are required. +phpmailer is required if email confirmation is to be used. +These are the names for Debian packages. Other distributions should +also provide these in some way. + +If you get errors, check your log files to see what packages I've failed to mention. + +For FreeBSD12: php72, php72-extensions, sharutils, php72-pcntl, php72-sockets, php72-mbstring, php72-openssl +Optional: phpmailer, gnupg + +Installation: + +1. Set up your webserver to handle php files + +2. Extract rslight into a temporary location + +3. Run the provided install script (debian-install.sh or freebsd-install.sh) as root +and answer the prompts. This will configure locations, create directories and move files +into place. + +4. Load common/setup.php in your browser to configure your site. The admin password +was displayed during install but can also be found in your config directory in +admin.inc.php + +5. Add a cron job for the root user. Change the directories in this line to match your setup +as shown in the installation script. Set the minutes as you wish. The paths must match your +installation: + +*/5 * * * * cd /usr/local/www/html/spoolnews ; bash -lc "php /etc/rslight/scripts/cron.php" +This will start the nntp server, then drop privileges to your web user and begin pulling +articles from the remote server to create your spool. You won't see articles immediately +in rslight, please wait 15-30 minutes to begin to see articles appear. + +If you have trouble, post to rocksolid.nodes.help and we'll try to help. + +Retro Guy +retroguy@novabbs.com diff --git a/README.md b/README.md index 059cc77..0415d51 100644 --- a/README.md +++ b/README.md @@ -5,55 +5,31 @@ Visit https://www.novabbs.com to try Rocksolid Light ![ScreenShot](https://www.novabbs.com/images/rslight-480.png) Rocksolid Light is based on NewsPortal, which discontinued development in 2008, and was -developed by Florian Amrhein https://florian-amrhein.de/newsportal/ +developed by Florian Amrhein https://florian-amrhein.de/newsportal/ -Rocksolid Light contains some major code and feature changes, but would not exist +rslight contains some major code and feature changes, but would not exist without NewsPortal as a basis for development. -Requirements: +Rocksolid Light is a php web forum interface that basically uses nntp as a backend. +Forums can be Usenet newsgroups, or any groups you wish to create. Forums can be +synchronized with other rslight installs, or other nntp servers. -You will need a web server: rslight has been tested with apache2, lighttpd, nginx -and synchronet web servers +* Does not require Javascript +* Synchronizes via nntp, but does not require Usenet specifically + * rslight is a nntp server, and can connect to other rslight sites +* Built in nntp server compatible with some news clients + * Read and Post using a news client + * Tested with Claws Mail, Thunderbird, Knews, tin and some others +* Synchronizes and works well in slow networks (tested in tor and i2p) +* No database required -php is required, and your web server must be configured to serve .php. +* Interface works reasonably well on small devices +* Colors in CSS are in a separate file for easy testing and modification +* Groups can be renamed for cleaner display +* Configuration and options can be different per 'section' -php-mbstring (to support other character sets), sharutils (for uudecode) and -openssl are required. -phpmailer is required if email confirmation is to be used. -These are the names for Debian packages. Other distributions should -also provide these in some way. +See INSTALL.md for installation instructions. -If you get errors, check your log files to see what packages I've failed to mention. +If you have trouble, post to rocksolid.nodes.help (www.novabbs.com) and we'll try to help. -For FreeBSD12: php72, php72-extensions, sharutils, php72-pcntl, php72-sockets, php72-mbstring, php72-openssl -Optional: phpmailer, gnupg - -Installation: - -1. Set up your webserver to handle php files - -2. Extract rslight into a temporary location - -3. Run the provided install script (debian-install.sh or freebsd-install.sh) as root -and answer the prompts. This will configure locations, create directories and move files -into place. - -4. Edit configuration file - -Load common/setup.php in your browser to configure your site. The admin password -was displayed during install but can also be found in your config directory in -admin.inc.php - -5. Add a cron job for the root user. Change the directories in this line to match your setup -as shown in the installation script. Set the minutes as you wish. The paths must match your -installation: - -*/5 * * * * cd /usr/local/www/html/spoolnews ; bash -lc "php /etc/rslight/scripts/cron.php" -This will start the nntp server, then drop privileges to your web user and begin pulling -articles from the remote server to create your spool. You won't see articles immediately -in rslight, please wait 15-30 minutes to begin to see articles appear. - -If you have trouble, post to rocksolid.nodes.help and we'll try to help. - -Retro Guy -retroguy@novabbs.com +Retro Guy retroguy@novabbs.com \ No newline at end of file