J. King
3 years ago
7 changed files with 95 additions and 28 deletions
@ -0,0 +1,53 @@ |
|||||
|
# 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](https://nginx.org) |
||||
|
- [Apache HTTP server](https://httpd.apache.org) 2.4 or later |
||||
|
- PHP 7.1.0 or later with the following extensions: |
||||
|
- [intl](https://php.net/manual/en/book.intl.php), [json](https://php.net/manual/en/book.json.php), [hash](https://php.net/manual/en/book.hash.php), [filter](https://php.net/manual/en/book.filter.php), and [dom](https://php.net/manual/en/book.dom.php) |
||||
|
- [simplexml](https://php.net/manual/en/book.simplexml.php), and [iconv](https://php.net/manual/en/book.iconv.php) |
||||
|
- One of: |
||||
|
- [sqlite3](https://php.net/manual/en/book.sqlite3.php) or [pdo_sqlite](https://php.net/manual/en/ref.pdo-sqlite.php) for SQLite databases |
||||
|
- [pgsql](https://php.net/manual/en/book.pgsql.php) or [pdo_pgsql](https://php.net/manual/en/ref.pdo-pgsql.php) for PostgreSQL 10 or later databases |
||||
|
- [mysqli](https://php.net/manual/en/book.mysqli.php) or [pdo_mysql](https://php.net/manual/en/ref.pdo-mysql.php) for MySQL/Percona 8.0.11 or later databases |
||||
|
- [curl](https://php.net/manual/en/book.curl.php) (optional) |
||||
|
- [posix](https://php.net/manual/en/book.posix.php) and [pcntl](https://php.net/manual/en/book.pcntl.php) (both optional) |
||||
|
- An interface between PHP and the Web server, such as [PHP-FPM](https://php.net/manual/en/install.fpm.php) |
||||
|
- Privileges either to create and run system services, or to run cron jobs |
||||
|
|
||||
|
# Installation |
||||
|
|
||||
|
1. Download [the latest release](https://thearsse.com/releases/current) and extract it somewhere, such as `/usr/share/arsse/` |
||||
|
2. [Set up your database](/en/Getting_Started/Database_Setup) |
||||
|
3. Create [a configuration file](/en/Getting_Started/Configuration) 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](/en/Using_The_Arsse/Other_Topics.html#page_Refreshing_newsfeeds_with_a_cron_job) or a similar task-scheduling tool |
||||
|
7. [Create users](/en/Using_The_Arsse/Managing_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 |
@ -0,0 +1,16 @@ |
|||||
|
# Installing from a package manager |
||||
|
|
||||
|
We currently provide a few pre-built installation packages for the following operating systems: |
||||
|
|
||||
|
- [Arch Linux and derivatives](On_Arch_Linux) |
||||
|
- [Debian and derivatives](On_Debian_and_Derivatives) |
||||
|
|
||||
|
These packages significantly simplify installation, though a bit of manual effort may still be required. Updating The Arsse using these packages should require no manual intervention. |
||||
|
|
||||
|
# Installing manually |
||||
|
|
||||
|
For other systems The Arsse must currently be installed manually. As each operating system is different, we can only provide very general instructions: |
||||
|
|
||||
|
- [Installing on other systems](On_Other_Systems) |
||||
|
|
||||
|
We hope to support more operating systems in the future. |
@ -1,20 +0,0 @@ |
|||||
Presently installing and setting up The Arsse involves some manual labour. We have packages for Arch Linux and hope to have installation packages available for other operating systems eventually, but for now the pages in this section should help get you up and running on Arch Linux or Debian-based systems, with Nginx or Apache HTTP Server. |
|
||||
|
|
||||
It is also be possible to run The Arsse on other operating systems (including Windows) and with other Web servers, but the configuration required to do so is not documented in this manual. |
|
||||
|
|
||||
# Requirements |
|
||||
|
|
||||
For reference, The Arsse has the following requirements: |
|
||||
|
|
||||
- A Linux server running Nginx or Apache 2.4 |
|
||||
- PHP 7.1.0 or later with the following extensions: |
|
||||
- [intl](https://php.net/manual/en/book.intl.php), [json](https://php.net/manual/en/book.json.php), [hash](https://php.net/manual/en/book.hash.php), [filter](https://php.net/manual/en/book.filter.php), and [dom](https://php.net/manual/en/book.dom.php) |
|
||||
- [simplexml](https://php.net/manual/en/book.simplexml.php), and [iconv](https://php.net/manual/en/book.iconv.php) |
|
||||
- One of: |
|
||||
- [sqlite3](https://php.net/manual/en/book.sqlite3.php) or [pdo_sqlite](https://php.net/manual/en/ref.pdo-sqlite.php) for SQLite databases |
|
||||
- [pgsql](https://php.net/manual/en/book.pgsql.php) or [pdo_pgsql](https://php.net/manual/en/ref.pdo-pgsql.php) for PostgreSQL 10 or later databases |
|
||||
- [mysqli](https://php.net/manual/en/book.mysqli.php) or [pdo_mysql](https://php.net/manual/en/ref.pdo-mysql.php) for MySQL/Percona 8.0.11 or later databases |
|
||||
- [curl](https://php.net/manual/en/book.curl.php) (optional) |
|
||||
- Privileges either to create and run systemd services, or to run cron jobs |
|
||||
|
|
||||
Instructions for how to satisfy the PHP extension requirements for Arch Linux and Debian systems are included in the next section. |
|
Loading…
Reference in new issue