aboutsummaryrefslogtreecommitdiff
path: root/docs/en/admins
diff options
context:
space:
mode:
authorGravatar Alexandre Alapetite <alexandre@alapetite.fr> 2022-01-08 21:58:55 +0100
committerGravatar GitHub <noreply@github.com> 2022-01-08 21:58:55 +0100
commit1acd3ab09be1b65bfd6122ee351490c3b5527bb8 (patch)
treef11de558e7a09522a45d1c155d9707ecda6bf1eb /docs/en/admins
parent916df412f5b6f7fb9bcfb705a3c8c23e35304410 (diff)
Use typographic quotes (#4133)
* Use typographic quotes * A few fixes * Fix * Fix not saved * Implement feedback * Detail * Revert spoken English fixes Left for a future dedicated discussion * More reverts * Final reverts * Final minor
Diffstat (limited to 'docs/en/admins')
-rw-r--r--docs/en/admins/01_Index.md2
-rw-r--r--docs/en/admins/03_Installation.md12
-rw-r--r--docs/en/admins/04_Frequently_Asked_Questions.md2
-rw-r--r--docs/en/admins/04_Updating.md4
-rw-r--r--docs/en/admins/05_Backup.md12
-rw-r--r--docs/en/admins/05_Configuring_email_validation.md30
-rw-r--r--docs/en/admins/06_LinuxInstall.md14
-rw-r--r--docs/en/admins/07_LinuxUpdate.md12
-rw-r--r--docs/en/admins/08_FeedUpdates.md10
-rw-r--r--docs/en/admins/13_Default_user.md2
10 files changed, 50 insertions, 50 deletions
diff --git a/docs/en/admins/01_Index.md b/docs/en/admins/01_Index.md
index 9842cba8f..ebf09dc07 100644
--- a/docs/en/admins/01_Index.md
+++ b/docs/en/admins/01_Index.md
@@ -2,7 +2,7 @@
Learn how to install, update, and backup FreshRSS, as well as how to use the command line tools.
-1. [Prerequisites](02_Prerequisites.md): What you'll need to run FreshRSS
+1. [Prerequisites](02_Prerequisites.md): What you’ll need to run FreshRSS
2. [General installation instructions](03_Installation.md) for FreshRSS
3. [Update your installation](04_Updating.md) to the latest stable or development version
diff --git a/docs/en/admins/03_Installation.md b/docs/en/admins/03_Installation.md
index e96200911..a77054a27 100644
--- a/docs/en/admins/03_Installation.md
+++ b/docs/en/admins/03_Installation.md
@@ -1,12 +1,12 @@
# General Installation Instructions
-These instructions are intended as general guidelines for installing FreshRSS. You may wish to consult the [Step-by-step Tutorial for installing FreshRSS on Debian 9/Ubuntu 16.04](06_LinuxInstall.md) if you don't currently have a web server and don't have experience setting one up.
+These instructions are intended as general guidelines for installing FreshRSS. You may wish to consult the [Step-by-step Tutorial for installing FreshRSS on Debian 9/Ubuntu 16.04](06_LinuxInstall.md) if you don’t currently have a web server and don’t have experience setting one up.
-Before you begin, make sure that you've read the [prerequisites](02_Prerequisites.md) for running FreshRSS. As shorthand, `.` refers to the directory to which your FreshRSS installation lives.
+Before you begin, make sure that you’ve read the [prerequisites](02_Prerequisites.md) for running FreshRSS. As shorthand, `.` refers to the directory to which your FreshRSS installation lives.
-1. If the computer you're running on is not currently running a web server, you'll first need to install and configure a web server, a version of PHP, and an appropriate database, as listed in the prerequisites. Specially, if you are using NGINX, please keep in mind that FreshRSS needs some specified variables to run properly. So make sure you've checked our configuration file. [Example Apache and Nginx configuration files can be found here](10_ServerConfig.md).
+1. If the computer you’re running on is not currently running a web server, you’ll first need to install and configure a web server, a version of PHP, and an appropriate database, as listed in the prerequisites. Specially, if you are using NGINX, please keep in mind that FreshRSS needs some specified variables to run properly. So make sure you’ve checked our configuration file. [Example Apache and Nginx configuration files can be found here](10_ServerConfig.md).
-2. Download your chosen version of FreshRSS, or fetch it via git. It's advisable that you put FreshRSS in `/usr/share/`, and symlink the `./p/` folder to the root of your web server.[^1]
+2. Download your chosen version of FreshRSS, or fetch it via git. It’s advisable that you put FreshRSS in `/usr/share/`, and symlink the `./p/` folder to the root of your web server.[^1]
3. Give ownership of the FreshRSS folder to your web server user (often `www-data`). Give group read permissions to all files in `.`[^2], and group write permissions to `./data/`.
@@ -14,7 +14,7 @@ Before you begin, make sure that you've read the [prerequisites](02_Prerequisite
5. Create a database for FreshRSS to use. Note the username and password for this database, as it will be needed during installation!
-6. Using your supported web browser of choice, navigate to the address you've installed your server to complete the installation from the GUI.[^3]
+6. Using your supported web browser of choice, navigate to the address you’ve installed your server to complete the installation from the GUI.[^3]
7. You can then customize [the configuration of your instance](https://github.com/FreshRSS/FreshRSS/blob/edge/config.default.php#L3-L4), [the default configuration for new users](https://github.com/FreshRSS/FreshRSS/blob/edge/config-user.default.php#L3-L5) or [the default set of feeds for new users](https://github.com/FreshRSS/FreshRSS/blob/edge/opml.default.xml#L2-L5).
@@ -24,4 +24,4 @@ Before you begin, make sure that you've read the [prerequisites](02_Prerequisite
[^2]: If you wish to allow updates from the web interface, also give group write permissions to this folder.
-[^3]: Assuming your server is `http://example.net`, this address could be `http://example.net/p/` if you didn't follow our previous advice about not exposing the `./p/` folder.
+[^3]: Assuming your server is `http://example.net`, this address could be `http://example.net/p/` if you didn’t follow our previous advice about not exposing the `./p/` folder.
diff --git a/docs/en/admins/04_Frequently_Asked_Questions.md b/docs/en/admins/04_Frequently_Asked_Questions.md
index cbabc3867..2e18ba802 100644
--- a/docs/en/admins/04_Frequently_Asked_Questions.md
+++ b/docs/en/admins/04_Frequently_Asked_Questions.md
@@ -15,7 +15,7 @@ You only have to do is to run the following command:
Alternatively, you can edit configuration files manually.
To do so, you need to change the *default_user* value in the file *./data/config.php*.
-As the file is a PHP file, you have to make sure that it's still valid after the update by running the following command:
+As the file is a PHP file, you have to make sure that it’s still valid after the update by running the following command:
```sh
php -l ./data/config.php
```
diff --git a/docs/en/admins/04_Updating.md b/docs/en/admins/04_Updating.md
index 2004d5318..27874d25c 100644
--- a/docs/en/admins/04_Updating.md
+++ b/docs/en/admins/04_Updating.md
@@ -4,7 +4,7 @@ The following is general procedure; [specific commands for Linux may be found he
## Backing Up
-Before you update to a new version of FreshRSS, it's always a good idea to backup your current installation. Simply make an archive of your FreshRSS directory, which can be restored if needed by following the "Updating from a Zip Archive" section at the bottom of this document.
+Before you update to a new version of FreshRSS, it’s always a good idea to backup your current installation. Simply make an archive of your FreshRSS directory, which can be restored if needed by following the "Updating from a Zip Archive" section at the bottom of this document.
## Updating From the Web
@@ -18,7 +18,7 @@ If you installed FreshRSS using git, you can update, change branches, or switch
Generally, the update procedure via git works as follows:
-1. Making sure you're in your FreshRSS install directory, and fetch updates.
+1. Making sure you’re in your FreshRSS install directory, and fetch updates.
2. Checkout the branch you wish to use.
3. Perform a hard reset to discard local changes.
4. Delete manual additions. Be sure to move your backup out of the directory before doing this step!
diff --git a/docs/en/admins/05_Backup.md b/docs/en/admins/05_Backup.md
index cf8516f29..ccc7810aa 100644
--- a/docs/en/admins/05_Backup.md
+++ b/docs/en/admins/05_Backup.md
@@ -1,6 +1,6 @@
# Backup
-This tutorial demonstrates commands for backing up FreshRSS. It assumes that your main FreshRSS directory is `/usr/share/FreshRSS`; If you've installed it somewhere else, substitute your path as necessary.
+This tutorial demonstrates commands for backing up FreshRSS. It assumes that your main FreshRSS directory is `/usr/share/FreshRSS`; If you’ve installed it somewhere else, substitute your path as necessary.
## Installation Backup
@@ -8,19 +8,19 @@ Do this before an upgrade.
### Creating a Backup
-First, Enter the directory you wish to save your backup to. Here, for example, we'll save the backup to the user home directory
+First, Enter the directory you wish to save your backup to. Here, for example, we’ll save the backup to the user home directory
```sh
cd ~
```
-Next, we'll create a gzipped tar archive of the FreshRSS directory. The following command will archive the entire contents of your FreshRSS installation in it's current state.
+Next, we’ll create a gzipped tar archive of the FreshRSS directory. The following command will archive the entire contents of your FreshRSS installation in it’s current state.
```sh
tar -czf FreshRSS-backup.tgz -C /usr/share/FreshRSS/ .
```
-And you're done!
+And you’re done!
### Restoring from a Backup
@@ -56,14 +56,14 @@ You can export your feed list in OPML format either from the web interface, or f
### Saving Articles
-**If you are using MySQL**
+**If you are using MySQL**
You can use [phpMyAdmin](https://www.phpmyadmin.net/) or MySQL tools, where `<db_user>` is your database username, `<db_host>` is the hostname of your web server containing your FreshRSS database, and `<freshrss_db>` is the database used by FreshRSS:
```sh
mysqldump --skip-comments --disable-keys --user=<db_user> --password --host <db_host> --result-file=freshrss.dump.sql --databases <freshrss_db>
```
-**From any database**
+**From any database**
You can use the [Command-Line Interface](https://github.com/FreshRSS/FreshRSS/blob/edge/cli/README.md) to export your database to a SQLite database file:
```sh
diff --git a/docs/en/admins/05_Configuring_email_validation.md b/docs/en/admins/05_Configuring_email_validation.md
index 66b26bd3b..500a2b5aa 100644
--- a/docs/en/admins/05_Configuring_email_validation.md
+++ b/docs/en/admins/05_Configuring_email_validation.md
@@ -1,14 +1,14 @@
# Configuring the email address validation
FreshRSS can verify that users give a valid email address. It is not configured
-by default so you'll have to follow these few steps to verify email addresses.
+by default so you’ll have to follow these few steps to verify email addresses.
It is intended to administrators who host users and want to be sure to be able
to contact them.
## Force email validation
-In your `data/config.php` file, you'll find a `force_email_validation` item:
+In your `data/config.php` file, you’ll find a `force_email_validation` item:
set it to `true`. An email field now appears on the registration page and
emails are sent when users change their email.
@@ -19,45 +19,45 @@ You can also enable this feature directly in FreshRSS: `Administration` >
By default, FreshRSS will attempt to send emails with the [`mail`](https://www.php.net/manual/en/function.mail.php)
function of PHP. It is the simpler solution but it might not work as expected.
-For example, we don't support (yet?) sending emails from inside our official
+For example, we don’t support (yet?) sending emails from inside our official
Docker images. We recommend to use a proper SMTP server.
-To configure a SMTP server, you'll have to modify the `data/config.php` file.
+To configure a SMTP server, you’ll have to modify the `data/config.php` file.
First, change the `mailer` item to `smtp` (instead of the default `mail`).
Then, you should change the `smtp` options like you would do with a regular
email client. You can find the full list of options in the [`config.default.php` file](https://github.com/FreshRSS/FreshRSS/blob/edge/config.default.php).
-If you're not sure to what each item is corresponding, you may find useful [the
+If you’re not sure to what each item is corresponding, you may find useful [the
PHPMailer documentation](http://phpmailer.github.io/PHPMailer/classes/PHPMailer.PHPMailer.PHPMailer.html#properties)
(which is used by FreshRSS under the hood).
## Check your SMTP server is correctly configured
-To do so, once you've enabled the `force_email_validation` option, you only
+To do so, once you’ve enabled the `force_email_validation` option, you only
need to change your email address on the profile page and check that an email
arrives on the new address.
If it fails, you can change the environment (in `data/config.php` file, change
-`production` to `development`). PHPMailer will become more verbose and you'll
-be able to see what happens in the PHP logs. If something's wrong here, you'll
+`production` to `development`). PHPMailer will become more verbose and you’ll
+be able to see what happens in the PHP logs. If something’s wrong here, you’ll
probably better served by asking to your favorite search engine than asking us.
-If you think that something's wrong in FreshRSS code, don't hesitate to open a
+If you think that something’s wrong in FreshRSS code, don’t hesitate to open a
ticket though.
-Also, make sure the email didn't arrive in your spam.
+Also, make sure the email didn’t arrive in your spam.
-Once you're done, don't forget to reconfigure your environment to `production`.
+Once you’re done, don’t forget to reconfigure your environment to `production`.
## 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 developping 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
+no easy way to access the validation URL unless forging it. You’ll need to
information:
- the username of the user to validate (you should know it)
-- its validation token, that you'll find in its configuration file:
+- its validation token, that you’ll find in its configuration file:
```console
$ # For instance, for a user called `alice`
@@ -67,4 +67,4 @@ $ grep email_validation_token data/users/alice/config.php | cut -d \' -f 4 -
Then, the validation URL should be `http://localhost:8080/i/?c=user&a=validateEmail&username=alice&token=3d75042a4471994a0346e18ae87602f19220a795`
-Don't forget to adapt this URL with the correct port, username and token.
+Don’t forget to adapt this URL with the correct port, username and token.
diff --git a/docs/en/admins/06_LinuxInstall.md b/docs/en/admins/06_LinuxInstall.md
index ab42fb992..e92fc3247 100644
--- a/docs/en/admins/06_LinuxInstall.md
+++ b/docs/en/admins/06_LinuxInstall.md
@@ -1,6 +1,6 @@
# Installation on Debian 9/Ubuntu 16.04
-This tutorial will give you step-by-step commands to install the latest stable release of FreshRSS with Apache and MySQL using git. It's always recommended that you [backup your installation](05_Backup.md) before updating
+This tutorial will give you step-by-step commands to install the latest stable release of FreshRSS with Apache and MySQL using git. It’s always recommended that you [backup your installation](05_Backup.md) before updating
Please note: Commands need to be run as an administrator; either perform the following from a sudo shell (`sudo -s`) or use an administrator account.
@@ -13,7 +13,7 @@ apt install apache2
a2enmod headers expires rewrite ssl
```
-Then, you have to configure Apache. You can create a file in `/etc/apache2/sites-available`, based on [our example configuration file](10_ServerConfig.md). Once you're done, create a symbolic link from this file to the `sites-enabled` folder:
+Then, you have to configure Apache. You can create a file in `/etc/apache2/sites-available`, based on [our example configuration file](10_ServerConfig.md). Once you’re done, create a symbolic link from this file to the `sites-enabled` folder:
```sh
ln -s /etc/apache2/sites-available/freshrss.conf /etc/apache2/sites-enabled/freshrss.conf
@@ -31,7 +31,7 @@ Install the PHP module for Apache
apt install libapache2-mod-php
```
-Next, we'll need to install and configure MySQL. Install MySQL components like so:
+Next, we’ll need to install and configure MySQL. Install MySQL components like so:
```sh
sudo apt install mysql-server mysql-client php-mysql
@@ -43,8 +43,8 @@ MySQL must now be started:
service mysql-server start
```
-We'll need to configure MySQL.
-**Note:** As you've just installed mysql, there will be no root password; simply hit enter on the first step
+We’ll need to configure MySQL.
+**Note:** As you’ve just installed mysql, there will be no root password; simply hit enter on the first step
```sh
mysql_secure_installation
@@ -64,7 +64,7 @@ service apache2 restart
## Part 2: Installing FreshRSS
-Begin by installing git, if you don't already have it installed.
+Begin by installing git, if you don’t already have it installed.
```sh
apt install git
@@ -85,7 +85,7 @@ chown -R :www-data .
sudo chmod -R g+r .
```
-We'll also need to allow the data folder to be written to, like so:
+We’ll also need to allow the data folder to be written to, like so:
```sh
chmod -R g+w ./data/
diff --git a/docs/en/admins/07_LinuxUpdate.md b/docs/en/admins/07_LinuxUpdate.md
index 6323c2a1a..bc8a00aeb 100644
--- a/docs/en/admins/07_LinuxUpdate.md
+++ b/docs/en/admins/07_LinuxUpdate.md
@@ -1,8 +1,8 @@
# Updating on Linux
-This tutorial demonstrates commands for updating FreshRSS. It assumes that your main FreshRSS directory is `/usr/share/FreshRSS`; If you've installed it somewhere else, substitute your path as necessary.
+This tutorial demonstrates commands for updating FreshRSS. It assumes that your main FreshRSS directory is `/usr/share/FreshRSS`; If you’ve installed it somewhere else, substitute your path as necessary.
-**Note that FreshRSS contains a built-in update system.** It's easier to use if you don't understand the commands that follow. It's available through the web interface of your FreshRSS installation, Administration → Update.
+**Note that FreshRSS contains a built-in update system.** It’s easier to use if you don’t understand the commands that follow. It’s available through the web interface of your FreshRSS installation, Administration → Update.
## Pausing automatic feed updates
@@ -24,7 +24,7 @@ You may wish to run the cron task or systemd unit (`freshrss.service`) immediate
**You must have used git to install FreshRSS to use this update method.**
-If your local user doesn't have write access to the FreshRSS folder, use a sudo shell (`sudo -s`), prefix the following commands with `sudo`, or switch to an account that does have write access to the folder.
+If your local user doesn’t have write access to the FreshRSS folder, use a sudo shell (`sudo -s`), prefix the following commands with `sudo`, or switch to an account that does have write access to the folder.
1. Change to your FreshRSS directory
```sh
@@ -42,7 +42,7 @@ If your local user doesn't have write access to the FreshRSS folder, use a sudo
git clean -f -d
```
- Note: If you wish to keep your changes, it's better to [create a pull request](https://github.com/FreshRSS/FreshRSS/compare) or [an extension](../developers/03_Backend/05_Extensions.md).
+ Note: If you wish to keep your changes, it’s better to [create a pull request](https://github.com/FreshRSS/FreshRSS/compare) or [an extension](../developers/03_Backend/05_Extensions.md).
4. Update FreshRSS
```sh
@@ -58,7 +58,7 @@ If your local user doesn't have write access to the FreshRSS folder, use a sudo
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 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`.
6. Re-set correct permissions so that your web server can access the files
```sh
@@ -67,7 +67,7 @@ If your local user doesn't have write access to the FreshRSS folder, use a sudo
## Using the Zip archive
-If your local user doesn't have write access to the FreshRSS folder, use a sudo shell (`sudo -s`), prefix the following commands with `sudo`, or switch to an account that does have write access to the folder.
+If your local user doesn’t have write access to the FreshRSS folder, use a sudo shell (`sudo -s`), prefix the following commands with `sudo`, or switch to an account that does have write access to the folder.
1. Change to your FreshRSS directory
```sh
diff --git a/docs/en/admins/08_FeedUpdates.md b/docs/en/admins/08_FeedUpdates.md
index e1a02af31..2072188bd 100644
--- a/docs/en/admins/08_FeedUpdates.md
+++ b/docs/en/admins/08_FeedUpdates.md
@@ -2,17 +2,17 @@
FreshRSS is updated by the `./app/actualize_script.php` script. Knowing this, we can periodically trigger it to ensure up-to-date feeds.
-**Note:** the update script won't update any particular feed more often than once every twenty minutes, so it doesn't make sense to trigger it much more frequently than that.
+**Note:** the update script won’t update any particular feed more often than once every twenty minutes, so it doesn’t make sense to trigger it much more frequently than that.
-**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:** 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).
## Cron as a trigger
-You'll need to check the Cron documentation for your specific distribution ([Debian/Ubuntu](https://help.ubuntu.com/community/CronHowto), [Red Hat/Fedora/CentOS](https://fedoraproject.org/wiki/Administration_Guide_Draft/Cron), [Slackware](https://docs.slackware.com/fr:slackbook:process_control?#cron), [Gentoo](https://wiki.gentoo.org/wiki/Cron), [Arch Linux](https://wiki.archlinux.org/index.php/Cron) ...) to make sure you set the Cron job correctly.
+You’ll need to check the Cron documentation for your specific distribution ([Debian/Ubuntu](https://help.ubuntu.com/community/CronHowto), [Red Hat/Fedora/CentOS](https://fedoraproject.org/wiki/Administration_Guide_Draft/Cron), [Slackware](https://docs.slackware.com/fr:slackbook:process_control?#cron), [Gentoo](https://wiki.gentoo.org/wiki/Cron), [Arch Linux](https://wiki.archlinux.org/index.php/Cron) …) to make sure you set the Cron job correctly.
-It's advisable that you run the Cron job as your Web server user (often `www-data`).
+It’s advisable that you run the Cron job as your Web server user (often `www-data`).
### Example on Debian/Ubuntu
@@ -25,7 +25,7 @@ Edit `/etc/crontab` and append the following line:
## Systemd as a trigger
-Some systems can't use a Cron job, but they can use systemd. It's easy to configure it to mimic Cron's features.
+Some systems can’t use a Cron job, but they can use systemd. It’s easy to configure it to mimic Cron’s features.
First you need to add a `freshrss.timer` file in `/etc/systemd/system/` with the following content:
diff --git a/docs/en/admins/13_Default_user.md b/docs/en/admins/13_Default_user.md
index 946d53814..16312111f 100644
--- a/docs/en/admins/13_Default_user.md
+++ b/docs/en/admins/13_Default_user.md
@@ -16,7 +16,7 @@ The default user is used for the anonymous reading.
How to enable the anonymous reading mode:
* go to settings `Administration` → `Authentication`
-* enable the checkbox of `Allow anonymous reading of the default user's articles`
+* enable the checkbox of `Allow anonymous reading of the default user’s articles`
* when no user is logged in then the feeds of the default user is shown
## Change the default user