mirror of
https://code.mensbeam.com/MensBeam/Arsse.git
synced 2024-12-22 21:22:40 +00:00
Re-organize sections
This commit is contained in:
parent
4fd060f001
commit
6705ea1585
9 changed files with 11 additions and 7 deletions
|
@ -51,4 +51,4 @@ It's also possible to instead use a cron job to schedule newsfeed checks, but us
|
||||||
|
|
||||||
In order for the various synchronization protocols to work, a Web server [must be configured](Web_Server_Configuration), and in order for The Arsse to serve users, those users [must be created](Managing_Users). The following manual pages provide details on how to get this set up.
|
In order for the various synchronization protocols to work, a Web server [must be configured](Web_Server_Configuration), and in order for The Arsse to serve users, those users [must be created](Managing_Users). The following manual pages provide details on how to get this set up.
|
||||||
|
|
||||||
You may also want to review the `config.defaults.php` file included in the download package and create [a configuration file](/en/Configuring_The_Arsse), though The Arsse can function even without using a configuration file.
|
You may also want to review the `config.defaults.php` file included in the download package and create [a configuration file](Configuration), though The Arsse can function even without using a configuration file.
|
||||||
|
|
|
@ -8,9 +8,9 @@
|
||||||
<dt>Minimum version</dt>
|
<dt>Minimum version</dt>
|
||||||
<dd>3.8.3</dd>
|
<dd>3.8.3</dd>
|
||||||
<dt>Configuration</dt>
|
<dt>Configuration</dt>
|
||||||
<dd><a href="/en/Configuring_The_Arsse#page_Database-settings">General</a>, <a href="/en/Configuring_The_Arsse#page_Database-settings-specific-to-SQLite-3">Specific</a></dd>
|
<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>
|
||||||
</dl>
|
</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/Configuring_The_Arsse#page_dbSQLite3File).
|
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).
|
||||||
|
|
||||||
Regardless of the location chosen, The Arsse **must** be able to both read from and write to the database file, as well as create files in its directory. This is because SQLite also creates a write-ahead log file and a shared-memory file during operation.
|
Regardless of the location chosen, The Arsse **must** be able to both read from and write to the database file, as well as create files in its directory. This is because SQLite also creates a write-ahead log file and a shared-memory file during operation.
|
||||||
|
|
|
@ -8,7 +8,7 @@
|
||||||
<dt>Minimum version</dt>
|
<dt>Minimum version</dt>
|
||||||
<dd>10</dd>
|
<dd>10</dd>
|
||||||
<dt>Configuration</dt>
|
<dt>Configuration</dt>
|
||||||
<dd><a href="/en/Configuring_The_Arsse#page_Database-settings">General</a>, <a href="/en/Configuring_The_Arsse#page_Database-settings-specific-to-PostgreSQL">Specific</a></dd>
|
<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>
|
||||||
</dl>
|
</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.
|
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.
|
||||||
|
@ -22,7 +22,7 @@ sudo -u postgres psql -c "CREATE USER arsseuser WITH PASSWORD 'super secret pass
|
||||||
sudo -u postgres psql -c "CREATE DATABASE arssedb WITH OWNER arsseuser"
|
sudo -u postgres psql -c "CREATE DATABASE arssedb WITH OWNER arsseuser"
|
||||||
```
|
```
|
||||||
|
|
||||||
Tha Arsse must then be configured to use the created database. A suitable [configuration file](/en/Configuring_The_Arsse) might look like this:
|
Tha Arsse must then be configured to use the created database. A suitable [configuration file](/en/Getting_Started/Configuration) might look like this:
|
||||||
|
|
||||||
```php
|
```php
|
||||||
<?php
|
<?php
|
||||||
|
|
|
@ -8,7 +8,7 @@
|
||||||
<dt>Minimum version</dt>
|
<dt>Minimum version</dt>
|
||||||
<dd>8.0.11</dd>
|
<dd>8.0.11</dd>
|
||||||
<dt>Configuration</dt>
|
<dt>Configuration</dt>
|
||||||
<dd><a href="/en/Configuring_The_Arsse#page_Database-settings">General</a>, <a href="/en/Configuring_The_Arsse#page_Database-settings-specific-to-MySQL">Specific</a></dd>
|
<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>
|
||||||
</dl>
|
</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.
|
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.
|
||||||
|
@ -25,7 +25,7 @@ sudo mysql -e "CREATE DATABASE arssedb"
|
||||||
sudo mysql -e "GRANT ALL ON arssedb.* TO 'arsseuser'@'localhost'"
|
sudo mysql -e "GRANT ALL ON arssedb.* TO 'arsseuser'@'localhost'"
|
||||||
```
|
```
|
||||||
|
|
||||||
Tha Arsse must then be configured to use the created database. A suitable [configuration file](/en/Configuring_The_Arsse) might look like this:
|
Tha Arsse must then be configured to use the created database. A suitable [configuration file](/en/Getting_Started/Configuration) might look like this:
|
||||||
|
|
||||||
```php
|
```php
|
||||||
<?php
|
<?php
|
||||||
|
|
|
@ -1,3 +1,7 @@
|
||||||
|
# The Configuration File
|
||||||
|
|
||||||
|
# List of All Settings
|
||||||
|
|
||||||
## General settings
|
## General settings
|
||||||
|
|
||||||
### lang
|
### lang
|
Loading…
Reference in a new issue