1
1
Fork 0
mirror of https://code.mensbeam.com/MensBeam/Arsse.git synced 2024-12-22 21:22:40 +00:00

Standardize section capitalization

This does not (yet) apply to files, but may later
This commit is contained in:
J. King 2019-08-22 14:16:26 -04:00
parent d7f1963d7f
commit e122f97036
5 changed files with 12 additions and 12 deletions

View file

@ -32,7 +32,7 @@ sudo chown -R www-data:www-data "/usr/share/arsse"
sudo chmod o+rwX "/usr/share/arsse" sudo chmod o+rwX "/usr/share/arsse"
``` ```
# Next Steps # Next steps
If using a database other than SQLite, you will likely want to [set it up](Database_Setup) before doing anything else. If using a database other than SQLite, you will likely want to [set it up](Database_Setup) before doing anything else.

View file

@ -1,4 +1,4 @@
# The Configuration File # The configuration file
The Arsse looks for configuration in a file named `config.php` in the directory where it is installed. For example, if The Arsse is installed at `/usr/share/arsse`, it will look for configuration in the file `/usr/share/arsse/config.php`. It is not an error for this file not to exist or to be empty: The Arsse will function with no configuration whatsoever, provided other conditions allow. The Arsse looks for configuration in a file named `config.php` in the directory where it is installed. For example, if The Arsse is installed at `/usr/share/arsse`, it will look for configuration in the file `/usr/share/arsse/config.php`. It is not an error for this file not to exist or to be empty: The Arsse will function with no configuration whatsoever, provided other conditions allow.
@ -14,7 +14,7 @@ The configuration file is a PHP script which returns an associative array with k
The `config.defaults.php` file included with copies of The Arsse contains an annotated listing of every configuration setting with its default value. The settings are also documented in more detail below. The `config.defaults.php` file included with copies of The Arsse contains an annotated listing of every configuration setting with its default value. The settings are also documented in more detail below.
# List of All Settings # List of all settings
## General settings ## General settings

View file

@ -4,7 +4,7 @@
This section describes in brief some CLI commands. Please read [the general notes on the command line interface](index) before continuing. This section describes in brief some CLI commands. Please read [the general notes on the command line interface](index) before continuing.
# Adding Users # Adding users
When first installed, The Arsse has no users configured. You may add users by executing the following command: When first installed, The Arsse has no users configured. You may add users by executing the following command:
@ -19,7 +19,7 @@ $ sudo -u www-data php arsse.php user add "jane.doe"
Ji0ivMYqi6gKxQK1MHuE Ji0ivMYqi6gKxQK1MHuE
``` ```
# Setting and Changing Passwords # Setting and changing passwords
Setting's a user's password is practically identical to adding a password: Setting's a user's password is practically identical to adding a password:
@ -34,7 +34,7 @@ $ sudo -u www-data php arsse.php user set-pass "jane.doe"
Ummn173XjbJT4J3Gnx0a Ummn173XjbJT4J3Gnx0a
``` ```
## Setting and Changing Passwords for Fever ## Setting and changing passwords for Fever
Before a user can make use of [the Fever protocol](/en/Supported_Protocols/Fever), a Fever-specific password for that user must be set. It is _highly recommended_ that this not be the samer as the user's main password. The password can be set by adding the `--fever` option to the normal password-changing command: Before a user can make use of [the Fever protocol](/en/Supported_Protocols/Fever), a Fever-specific password for that user must be set. It is _highly recommended_ that this not be the samer as the user's main password. The password can be set by adding the `--fever` option to the normal password-changing command:

View file

@ -4,7 +4,7 @@
This section describes in brief some CLI commands. Please read [the general notes on the command line interface](index) before continuing. This section describes in brief some CLI commands. Please read [the general notes on the command line interface](index) before continuing.
# Importing Newsfeeds from OPML # Importing newsfeeds from OPML
It's possible to import not only newsfeeds but also folders and Fever groups using OPML files. The process is simple: It's possible to import not only newsfeeds but also folders and Fever groups using OPML files. The process is simple:
@ -14,7 +14,7 @@ sudo -u www-data php arsse.php import "user@example.com" "subscriptions.opml"
The importer is forgiving, but some OPML files may fail, with the reason printed out. Files are either imported in total, or not at all. The importer is forgiving, but some OPML files may fail, with the reason printed out. Files are either imported in total, or not at all.
# Exporting Newsfeeds to OPML # Exporting newsfeeds to OPML
It's possible to export not only newsfeeds but also folders and Fever groups to OPML files. The process is simple: It's possible to export not only newsfeeds but also folders and Fever groups to OPML files. The process is simple:
@ -40,7 +40,7 @@ The output might look like this:
</opml> </opml>
``` ```
# Managing Newsfeeds via OPML # Managing newsfeeds via OPML
Not all protocols supported by The Arsse allow modifying newsfeeds or folders, et cetera; additionally, not all clients support these capabilities even if the protocol has the necessary features. An OPML export/import sequence with the `--replace` import option specified, however, makes any kind of modification possible. For example: Not all protocols supported by The Arsse allow modifying newsfeeds or folders, et cetera; additionally, not all clients support these capabilities even if the protocol has the necessary features. An OPML export/import sequence with the `--replace` import option specified, however, makes any kind of modification possible. For example:

View file

@ -6,7 +6,7 @@ In normal operation The Arsse is expected to regularly check whether newsfeeds m
There are many ways to administer daemons, and many schedulers can be used. This section outlines a few, but many other arrangements are possible. There are many ways to administer daemons, and many schedulers can be used. This section outlines a few, but many other arrangements are possible.
# As a Daemon via Systemd # As a daemon via systemd
The Arsse includes a sample systemd service unit file which can be used to quickly get a daemon running with the following procedure: The Arsse includes a sample systemd service unit file which can be used to quickly get a daemon running with the following procedure:
@ -21,7 +21,7 @@ sudo systemctl enable --now arsse
The Arsse's feed updater can then be manipulated as with any other service. Consult [the `systemctl` manual](https://www.freedesktop.org/software/systemd/man/systemctl.html) for details. The Arsse's feed updater can then be manipulated as with any other service. Consult [the `systemctl` manual](https://www.freedesktop.org/software/systemd/man/systemctl.html) for details.
# As a Cron Job # As a cron job
Keeping newsfeeds updated with [cron](https://en.wikipedia.org/wiki/Cron) is not difficult. Simply run the following command: Keeping newsfeeds updated with [cron](https://en.wikipedia.org/wiki/Cron) is not difficult. Simply run the following command:
@ -38,7 +38,7 @@ And add a line such as this one:
Thereafter The Arsse's will be scheduled to check newsfeeds every two minutes. Consult the manual pages for the `crontab` [format](http://man7.org/linux/man-pages/man5/crontab.5.html) and [command](http://man7.org/linux/man-pages/man1/crontab.1.html) for details. Thereafter The Arsse's will be scheduled to check newsfeeds every two minutes. Consult the manual pages for the `crontab` [format](http://man7.org/linux/man-pages/man5/crontab.5.html) and [command](http://man7.org/linux/man-pages/man1/crontab.1.html) for details.
# Appendix: How Often Newsfeeds Are Fetched # Appendix: how often newsfeeds are fetched
Though by default The Arsse will wake up every two minutes, newsfeeds are not actually downloaded so frequently. Instead, each newsfeed is assigned a time at which it should next be fetched, and once that time is reached a [conditional request](https://developer.mozilla.org/en-US/docs/Web/HTTP/Conditional_requests) is made. The interval between requests for a particular newsfeed can vary from 15 minutes to 24 hours based on multiple factors such as: Though by default The Arsse will wake up every two minutes, newsfeeds are not actually downloaded so frequently. Instead, each newsfeed is assigned a time at which it should next be fetched, and once that time is reached a [conditional request](https://developer.mozilla.org/en-US/docs/Web/HTTP/Conditional_requests) is made. The interval between requests for a particular newsfeed can vary from 15 minutes to 24 hours based on multiple factors such as: