diff options
| author | 2023-03-04 13:30:45 +0100 | |
|---|---|---|
| committer | 2023-03-04 13:30:45 +0100 | |
| commit | b3239256dc6d188cda970adab516b3fcf1b86129 (patch) | |
| tree | d8e65dd9784834ba2e82ce7ee94b4718f8af19ea /docs/en/admins | |
| parent | 27b71ffa99f7dff013fb8d51d020ed628e0d2ce6 (diff) | |
| parent | 0fe0ce894cbad09757d719dd4b400b9862c1a12a (diff) | |
Merge branch 'edge' into latest
Diffstat (limited to 'docs/en/admins')
| -rw-r--r-- | docs/en/admins/02_Prerequisites.md | 2 | ||||
| -rw-r--r-- | docs/en/admins/05_Configuring_email_validation.md | 2 | ||||
| -rw-r--r-- | docs/en/admins/06_LinuxInstall.md | 9 | ||||
| -rw-r--r-- | docs/en/admins/07_LinuxUpdate.md | 12 | ||||
| -rw-r--r-- | docs/en/admins/08_FeedUpdates.md | 2 | ||||
| -rw-r--r-- | docs/en/admins/10_ServerConfig.md | 6 |
6 files changed, 16 insertions, 17 deletions
diff --git a/docs/en/admins/02_Prerequisites.md b/docs/en/admins/02_Prerequisites.md index 41dabc651..c2a2b3fa7 100644 --- a/docs/en/admins/02_Prerequisites.md +++ b/docs/en/admins/02_Prerequisites.md @@ -7,7 +7,7 @@ You need to verify that your server can run FreshRSS before installing it. If yo | Software | Recommended | Also Works With | | ------------- | ----------------------- | ----------------------- | | Web server | **Apache 2** | Nginx, lighttpd | -| PHP | **PHP 7+** | | +| PHP | **PHP 7.2+** | | | PHP modules | Required: libxml, cURL, JSON, PDO_MySQL, PCRE and ctype.<br />Required (32-bit only): GMP <br />Recommended: Zlib, mbstring, iconv, ZipArchive<br />*For the whole modules list see [Dockerfile](https://github.com/FreshRSS/FreshRSS/blob/edge/Docker/Dockerfile-Alpine#L7-L9)* | | | Database | **MySQL 5.5.3+** | SQLite 3.7.4+, PostgreSQL 9.5+ | | Browser | **Firefox** | Chrome, Opera, Safari, or Edge | diff --git a/docs/en/admins/05_Configuring_email_validation.md b/docs/en/admins/05_Configuring_email_validation.md index 69a06b53f..aec6b8b75 100644 --- a/docs/en/admins/05_Configuring_email_validation.md +++ b/docs/en/admins/05_Configuring_email_validation.md @@ -68,7 +68,7 @@ Once you’re done, don’t forget to reconfigure your environment to `productio ## Access the validation URL during development -You might find painful to configure a SMTP server when you’re developping and +You might find painful to configure a SMTP server when you’re developing and `mail` function will not work on your local machine. For the moment, there is no easy way to access the validation URL unless forging it. You’ll need to information: diff --git a/docs/en/admins/06_LinuxInstall.md b/docs/en/admins/06_LinuxInstall.md index e92fc3247..1af041efe 100644 --- a/docs/en/admins/06_LinuxInstall.md +++ b/docs/en/admins/06_LinuxInstall.md @@ -81,14 +81,7 @@ Change to the new FreshRSS directory, and set the permissions so that your Web s ```sh cd FreshRSS -chown -R :www-data . -sudo chmod -R g+r . -``` - -We’ll also need to allow the data folder to be written to, like so: - -```sh -chmod -R g+w ./data/ +sudo cli/access-permissions.sh ``` Optional: If you would like to allow updates from the Web interface, set write permissions diff --git a/docs/en/admins/07_LinuxUpdate.md b/docs/en/admins/07_LinuxUpdate.md index 834dfaaef..47b84e5ef 100644 --- a/docs/en/admins/07_LinuxUpdate.md +++ b/docs/en/admins/07_LinuxUpdate.md @@ -49,22 +49,22 @@ If your local user doesn’t have write access to the FreshRSS folder, use a sud 4. Update FreshRSS ```sh git checkout edge - git pull - git checkout $(git describe --tags --abbrev=0) + git pull --ff-only ``` - Note: If you want to use the rolling release, the last command is optional. + > ℹ️ Use `edge` for the rolling release or `latest` for the latest stable release. 5. (optional) Make sure you use the correct version ```sh git status ``` - The command should tell you the tag that you’re using. It must be the same as the one associated with [the latest release on GitHub](https://github.com/FreshRSS/FreshRSS/releases/latest). If you use the rolling release, it should tell you that your `edge` branch is up to date with `origin`. + The command should tell you the branch that you’re using. It must be the same as the one associated with [the latest release on GitHub](https://github.com/FreshRSS/FreshRSS/releases/latest). + If you use the rolling release, it should tell you that your `edge` branch is up to date with `origin`. 6. Re-set correct permissions so that your web server can access the files ```sh - chown -R :www-data . && chmod -R g+r . && chmod -R g+w ./data/ + cli/access-permissions.sh ``` ## Using the Zip archive @@ -91,7 +91,7 @@ If your local user doesn’t have write access to the FreshRSS folder, use a sud 5. Re-set permissions ```sh - chown -R :www-data . && chmod -R g+r . && chmod -R g+w ./data/ + cli/access-permissions.sh ``` 6. Clean up the FreshRSS directory by deleting the downloaded zip and the temporary directory diff --git a/docs/en/admins/08_FeedUpdates.md b/docs/en/admins/08_FeedUpdates.md index 2072188bd..79c2bbea6 100644 --- a/docs/en/admins/08_FeedUpdates.md +++ b/docs/en/admins/08_FeedUpdates.md @@ -6,7 +6,7 @@ FreshRSS is updated by the `./app/actualize_script.php` script. Knowing this, we **Note:** the following examples assume that FreshRSS is installed to `/usr/share/FreshRSS`. You’ll need to modify the FreshRSS path to reflect your own system. -**Note:** If you cannot configure a local Cronjob, [see an alternative using online cron](../users/03_Main_view.md#online-cron). +**Note:** If you cannot configure a local Cronjob, [see an alternative using online cron](../users/09_refreshing_feeds.md#online-cron). ## Cron as a trigger diff --git a/docs/en/admins/10_ServerConfig.md b/docs/en/admins/10_ServerConfig.md index 6c5823a2d..87bd74d09 100644 --- a/docs/en/admins/10_ServerConfig.md +++ b/docs/en/admins/10_ServerConfig.md @@ -1,8 +1,13 @@ # Apache/Nginx Configuration Files +> ℹ️ For improved security, remove sensitive information in the Web server logs by using our [`sensitive-log.sh` script](https://github.com/FreshRSS/FreshRSS/blob/edge/cli/sensitive-log.sh), +on the model of our [reference Apache configuration](https://github.com/FreshRSS/FreshRSS/blob/edge/Docker/FreshRSS.Apache.conf) used for our official Docker images +(see [`CustomLog`](https://httpd.apache.org/docs/current/mod/mod_log_config.html#customlog)). + ## Apache configuration This is an example Apache virtual hosts configuration file. It covers HTTP and HTTPS configuration. +For more details, check our [reference Apache configuration](https://github.com/FreshRSS/FreshRSS/blob/edge/Docker/FreshRSS.Apache.conf) used for our official Docker images. ```apache <VirtualHost *:80> @@ -24,6 +29,7 @@ This is an example Apache virtual hosts configuration file. It covers HTTP and H </Directory> ErrorLog ${APACHE_LOG_DIR}/freshrss_error.log + # Consider piping the logs for cleaning passwords; cf. comment higher up. CustomLog ${APACHE_LOG_DIR}/freshrss_access.log combined AllowEncodedSlashes On |
