mirror/Arsse
1
1
Fork 0
mirror of https://code.mensbeam.com/MensBeam/Arsse.git synced 2024-12-22 13:12:41 +00:00
Code Issues Activity

Add an index for the "Getting Started" section; other tweaks

Browse source
This commit is contained in:
J. King 2019-08-24 15:02:29 -04:00
parent 3ea2eeb817
commit 5bf791709b
6 changed files with 10 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
docs/en/020_Getting_Started/020_Download_and_Installation.md
View file

@ -8,8 +8,6 @@ Installation from source code is also possible, but the release packages are rec
# Installation
At present installing The Arsse is largely a manual process. We hope to some day make this easier by integrating the software into commonly used package managers, but for now the below instructions should serve as a useful guide.
In order for The Arsse to function correctly, [its requirements](Requirements) must first be satisfied. The process of installing the required PHP extensions differs from one system to the next, but on Debian the following series of commands should do:
```sh

2
docs/en/020_Getting_Started/040_Database_Setup/000_SQLite.md
View file

@ -8,7 +8,7 @@
<dt>Minimum version</dt>
<dd>3.8.3</dd>
<dt>Configuration</dt>
<dd><a href="/en/Getting_Started/Configuration#page_Database-settings">General</a>, <a href="/en/Getting_Started/Configuration#page_Database-settings-specific-to-SQLite-3">Specific</a></dd>
<dd><a href="../Configuration.html#page_Database-settings">General</a>, <a href="../Configuration.html#page_Database-settings-specific-to-SQLite-3">Specific</a></dd>
</dl>
SQLite requires very little set-up. By default the database will be created at the root of The Arsse's program directory (e.g. `/usr/share/arsse/arsse.db`), but this can be changed with the [`dbSQLite3File` setting](/en/Getting_Started/Configuration#page_dbSQLite3File).

2
docs/en/020_Getting_Started/040_Database_Setup/010_PostgreSQL.md
View file

@ -8,7 +8,7 @@
<dt>Minimum version</dt>
<dd>10</dd>
<dt>Configuration</dt>
<dd><a href="/en/Getting_Started/Configuration#page_Database-settings">General</a>, <a href="/en/Getting_Started/Configuration#page_Database-settings-specific-to-PostgreSQL">Specific</a></dd>
<dd><a href="../Configuration.html#page_Database-settings">General</a>, <a href="../Configuration.html#page_Database-settings-specific-to-PostgreSQL">Specific</a></dd>
</dl>
If for whatever reason an SQLite database does not suit your configuration, PostgreSQL is the best alternative. It is functionally equivalent to SQLite in every way.

4
docs/en/020_Getting_Started/040_Database_Setup/020_MySQL.md
View file

@ -8,12 +8,12 @@
<dt>Minimum version</dt>
<dd>8.0.11</dd>
<dt>Configuration</dt>
<dd><a href="/en/Getting_Started/Configuration#page_Database-settings">General</a>, <a href="/en/Getting_Started/Configuration#page_Database-settings-specific-to-MySQL">Specific</a></dd>
<dd><a href="../Configuration.html#page_Database-settings">General</a>, <a href="../Configuration.html#page_Database-settings-specific-to-MySQL">Specific</a></dd>
</dl>
While MySQL can be used as a database for The Arsse, this is **not recommended** due to MySQL's technical limitations. It is fully functional, but may fail with some newsfeeds where other database systems do not. Additionally, it is particularly important before upgrading from one version of The Arsse to the next to back up your database: a failure in a database upgrade can corrupt your database much more easily than when using other database systems.
Please note that as of this writing MariaDB cannot be used in place of MySQL as it lacks features of MySQL 8 which The Arsse requires. The awkwardly-named _Percona Server for MySQL_, on the other hand, should work, though this has not been tested.
Please note that as of this writing MariaDB cannot be used in place of MySQL as it lacks features of MySQL 8 which The Arsse requires. The awkwardly-named [_Percona Server for MySQL_](https://www.percona.com/software/mysql-database/percona-server), on the other hand, should work, though this has not been tested.
# Set-up

6
docs/en/020_Getting_Started/040_Database_Setup/index.md
View file

@ -1,8 +1,8 @@
The Arsse supports the following database backends:
- SQLite 3.8.3 and later
- PostgreSQL 10 and later
- MySQL 8.0.11 and later
- [SQLite 3.8.3](SQLite) and later
- [PostgreSQL 10](PostgreSQL) and later
- [MySQL 8.0.11](MySQL) and later
All of the above are supported both via their PDO driver extensions as well as their native PHP extensions. One or the other is selected based on availability in your PHP installation.

3
docs/en/020_Getting_Started/index.md Normal file
View file

@ -0,0 +1,3 @@
Presently installing and setting up The Arsse is a manual process. We hope to have pre-configured installation packages available for various operating systems eventually, but for now the pages in this section should help get you up and running.
Though The Arsse itself makes no assumptions about the operating system which hosts it, we use and have the most experience with Debian; the instructions contained here therefore are for Debian systems will will probably either not work with other systems or not be consistent with their conventions. Nevertheless, they should still serve as a useful guide.