Downloading The Arsse

The Arsse should run on any operating system for which PHP and a Web server are available, but only the combination of Linux, Systemd, Nginx, and PHP-FPM has been extensively tested.

Below are very generic instructions and suggestions for installing The Arsse on systems for which pre-built packages are not available.

Requirements

The Arsse has the following requirements:

• A Web server such as:
  • Nginx
  • Apache HTTP server 2.4 or later
• PHP 7.3.0 or later with the following extensions:
  • intl, json, hash, filter, and dom
  • simplexml, and iconv
  • One of:
    • sqlite3 or pdo_sqlite for SQLite databases
    • pgsql or pdo_pgsql for PostgreSQL 10 or later databases
    • mysqli or pdo_mysql for MySQL/Percona 8.0.11 or later databases
  • curl (optional)
  • posix and pcntl (both optional)
• An interface between PHP and the Web server, such as PHP-FPM
• Privileges either to create and run system services, or to run cron jobs

Installation

1. Download the latest release and extract it somewhere, such as /usr/share/arsse/
2. Set up your database
3. Create a configuration file if needed
4. Consult the files under dist/nginx and dist/apache for sample Web server configuration
5. Consult dist/arsse for a sample executable script which drops privileges on POSIX systems
6. Start the newsfeed fetching service:
   • Sample Systemd service files are available under dist/systemd
   • A sample System V init script is available in dist/init.sh
   • A persistent process can be started by running php arsse.php daemon
   • It is also possible to use cron or a similar task-scheduling tool
7. Create users to grant them access

Upgrading

Upgrading The Arsse is usually simple:

1. Download the latest release
2. Check the UPGRADING file for any special notes
3. Stop the newsfeed refreshing service if it is running
4. Back up your configurationm and database
5. Extract the new version on top of the old one
6. Restart the newsfeed refreshing service

By default The Arsse will perform any required database schema upgrades when the new version is executed.

Occasionally changes to Web server configuration have been required, when new protocols become supported; such changes are always explicit in the UPGRADING file