Skip to content

README.md

Latest commit

 

History

History
93 lines (74 loc) · 5.32 KB

README.md

File metadata and controls

93 lines (74 loc) · 5.32 KB
Raw

Spotweb

Spotweb is a decentralized usenet community based on the Spotnet protocol.

Spotweb requires an operational web server running PHP. It uses MySQL, PostgreSQL or SQLite to store its contents.

Travis-CI Status Coverage Status Scrutinizer Code Quality

Scrutinzer Status Code consistency Code Intelligence Status StyleCI

Maintainability Test Coverage

PHP versions checked by Scrutinizer

Features

Spotweb is one of the most-featured Spotnet clients currently available, featuring among other things:

  • Fast.
  • Customizable filter system from within the system.
  • Posting of comments and spots.
  • Showing and filtering on new spots since the last view.
  • Watchlist.
  • Easy to download multiple files.
  • Runs on NAS devices like Synology and QNAP.
  • Rating of spots.
  • Integration with Sick Gear , Sick beard and CouchPotato as a 'newznab' provider.
  • Platform independent (reported to work on Linux, *BSD and Windows).
  • Both central as user-specific blacklist support built-in.
  • Spam reporting.
  • Easy layout customization by providing custom CSS.
  • Growl/Notify My Android/Notify/Prowl and Twitter integration. (*)
  • Spot statistics on your system.
  • Sabnzbd and nzbget(*) integration.
  • Multi-language. (*)
  • Multiple-user ready. (*)
  • Opensource and open development model. (*)

(*) Unique feature among all known Spotnet clients.

Installation requirements

Spotweb has been tested on several different systems. It is commonly used on:

  • Unix-based (Linux, FreeBSD) operating systems or small NAS systems like Synology and QNAP.
  • Apache Webserver.
  • PHP with at least the following modules:
    • curl
    • dom
    • gettext
    • mbstring
    • xml
    • zip
    • zlib
    • gd
    • openssl
  • MySQL, PostgreSQL and SQLite, where SQLite is the least supported and tested database engine.

Refer to the current Spotweb compatibility and CI results for information about PHP version compatibility.

Before using Spotweb, open install.php in your browser and ensure all installation checks show OK.

Installation — Master branch

Installation can vary by platform. Consult the tutorials available on the Spotweb wiki. The basic steps are:

  1. Ensure you have a database server installed (MySQL, PostgreSQL or SQLite).
  2. Create an empty 'spotweb' database.
  3. Ensure you have a web server running and PHP is configured for this web server.
  4. Download the Spotweb ZIP file, or run git clone -b master https://github.com/spotweb/spotweb.git . from your public web directory.
  5. Unpack the ZIP file into a directory of your choice, if applicable.
  6. Open install.php in your browser and resolve any checks that are not marked OK.
  7. Follow the wizard and perform the instructions as given by the wizard.

Installation — Development branch

  1. Ensure you have a database server installed (MySQL, PostgreSQL or SQLite).
  2. Create an empty 'spotweb' database.
  3. Ensure you have a web server running and PHP is configured for this web server.
  4. Download the Spotweb development ZIP file, or run git clone -b develop https://github.com/spotweb/spotweb.git . from your public web directory.
  5. Unpack the ZIP file into a directory of your choice, if applicable.
  6. Open install.php in your browser and resolve any checks that are not marked OK.
  7. Follow the wizard and perform the instructions as given by the wizard.

Troubleshooting

When a blank page appears instead of your Spotweb installation, this usually indicates a syntax error in ownsettings.php or dbsettings.inc.php, or a configuration error in the web server.

Consult your web server's error log to identify the exact error and resolve it.