diff options
| author | 2021-03-15 00:00:25 +0100 | |
|---|---|---|
| committer | 2021-03-15 00:00:25 +0100 | |
| commit | 1c3159058fd256ec7163a29c9865dbd3dbe05f17 (patch) | |
| tree | 5b3a9df3cc709a4b370f6f03cf79c50483275344 /docs/en/admins | |
| parent | 769f34e958b50e748acf6a151805f4a255df2043 (diff) | |
Quick update the doc for master renaming to edge
Diffstat (limited to 'docs/en/admins')
| -rw-r--r-- | docs/en/admins/01_Index.md | 2 | ||||
| -rw-r--r-- | docs/en/admins/02_Prerequisites.md | 6 | ||||
| -rw-r--r-- | docs/en/admins/03_Installation.md | 4 | ||||
| -rw-r--r-- | docs/en/admins/05_Backup.md | 37 | ||||
| -rw-r--r-- | docs/en/admins/05_Configuring_email_validation.md | 2 | ||||
| -rw-r--r-- | docs/en/admins/06_LinuxInstall.md | 56 | ||||
| -rw-r--r-- | docs/en/admins/07_LinuxUpdate.md | 46 |
7 files changed, 98 insertions, 55 deletions
diff --git a/docs/en/admins/01_Index.md b/docs/en/admins/01_Index.md index 6798dc768..c4f3cee7f 100644 --- a/docs/en/admins/01_Index.md +++ b/docs/en/admins/01_Index.md @@ -15,6 +15,6 @@ Learn how to install, update, and backup FreshRSS, as well as how to use the com * [Setting Up Automatic Feed Updating](08_FeedUpdates.md) * [Access Control](09_AccessControl.md) * [Apache/Nginx configuration files](10_ServerConfig.md) -* [Using the command line interface (CLI)](https://github.com/FreshRSS/FreshRSS/tree/master/cli) +* [Using the command line interface (CLI)](https://github.com/FreshRSS/FreshRSS/tree/edge/cli) * [Configuring the email address validation](05_Configuring_email_validation.md) * [Frequently asked questions](04_Frequently_Asked_Questions.md) diff --git a/docs/en/admins/02_Prerequisites.md b/docs/en/admins/02_Prerequisites.md index 7828972dd..608940839 100644 --- a/docs/en/admins/02_Prerequisites.md +++ b/docs/en/admins/02_Prerequisites.md @@ -8,7 +8,7 @@ You need to verify that your server can run FreshRSS before installing it. If yo | ------------- | ----------------------- | ----------------------- | | Web server | **Apache 2** | Nginx, lighttpd | | PHP | **PHP 7+** | PHP 5.6+ | -| PHP modules | Required: libxml, cURL, JSON, PDO\_MySQL, PCRE and ctype. <br>Required (32-bit only): GMP <br> Recommanded: Zlib, mbstring, iconv, ZipArchive <br> *For the whole modules list see [Dockerfile](https://github.com/FreshRSS/FreshRSS/blob/master/Docker/Dockerfile-Alpine#L7-L9)* | | +| PHP modules | Required: libxml, cURL, JSON, PDO\_MySQL, PCRE and ctype. <br>Required (32-bit only): GMP <br> Recommanded: 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 IE11/Edge[^1] | @@ -29,11 +29,11 @@ It could happen that we make two releases in a short span of time if we have a r ## Development version -[Download](https://github.com/FreshRSS/FreshRSS/archive/master.zip) +[Download](https://github.com/FreshRSS/FreshRSS/archive/edge.zip) As its name suggests, the development version is the working codebase, intended for developers. **This release may be unstable!** -If you want to keep track of the most recent enhancements or help the developers with bug reports, this is the branch for you. If you use this version, please keep in mind that you need to follow the branch activity on Github (via [the branch RSS feed](https://github.com/FreshRSS/FreshRSS/commits/master.atom), for instance), and manually pull new commits. +If you want to keep track of the most recent enhancements or help the developers with bug reports, this is the branch for you. If you use this version, please keep in mind that you need to follow the branch activity on Github (via [the branch RSS feed](https://github.com/FreshRSS/FreshRSS/commits/edge.atom), for instance), and manually pull new commits. Some say that the main developers use this branch on a daily basis without problem. They may know what they are doing… diff --git a/docs/en/admins/03_Installation.md b/docs/en/admins/03_Installation.md index 6cbbae6ad..2a2a886aa 100644 --- a/docs/en/admins/03_Installation.md +++ b/docs/en/admins/03_Installation.md @@ -10,13 +10,13 @@ Before you begin, make sure that you've read the [prerequisites](02_Prerequisite 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/`. -4. Install needed PHP modules. A precise and up-to-date list can be found in [the Dockerfile](https://github.com/FreshRSS/FreshRSS/blob/master/Docker/Dockerfile#L11-L12). +4. Install needed PHP modules. A precise and up-to-date list can be found in [the Dockerfile](https://github.com/FreshRSS/FreshRSS/blob/edge/Docker/Dockerfile#L11-L12). 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] -7. You can then customize [the configuration of your instance](https://github.com/FreshRSS/FreshRSS/blob/master/config.default.php#L3-L4), [the default configuration for new users](https://github.com/FreshRSS/FreshRSS/blob/master/config-user.default.php#L3-L5) or [the default set of feeds for new users](https://github.com/FreshRSS/FreshRSS/blob/master/opml.default.xml#L2-L5). +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). --- diff --git a/docs/en/admins/05_Backup.md b/docs/en/admins/05_Backup.md index 03fb8a7d1..cf8516f29 100644 --- a/docs/en/admins/05_Backup.md +++ b/docs/en/admins/05_Backup.md @@ -9,12 +9,14 @@ 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 -``` + +```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. -``` + +```sh tar -czf FreshRSS-backup.tgz -C /usr/share/FreshRSS/ . ``` @@ -23,52 +25,63 @@ And you're done! ### Restoring from a Backup First, copy the backup previously made into your FreshRSS directory -``` + +```sh cp ~/FreshRSS-backup.tgz /usr/share/FreshRSS/ ``` Next, change to your FreshRSS directory -``` + +```sh cd /usr/share/FreshRSS/ ``` Extract the backup -``` + +```sh tar -xzf FreshRSS-backup.tgz ``` And optionally, as cleanup, remove the copy of your backup from the FreshRSS directory -``` + +```sh rm FreshRSS-backup.tgz ``` ## Backing up Feeds ### Feed list Export -You can export your feed list in OPML format either from the web interface, or from the [Command-Line Interface](https://github.com/FreshRSS/FreshRSS/blob/master/cli/README.md). + +You can export your feed list in OPML format either from the web interface, or from the [Command-Line Interface](https://github.com/FreshRSS/FreshRSS/blob/edge/cli/README.md). ### Saving Articles **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** -You can use the [Command-Line Interface](https://github.com/FreshRSS/FreshRSS/blob/master/cli/README.md) to export your database to a SQLite database file: -``` +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 ./cli/export-sqlite-for-user.php --user <username> --filename </path/to/db.sqlite> ``` + > Note that the database filename needs the `sqlite` extension in order to work properly. -You can use the [Command-Line Interface](https://github.com/FreshRSS/FreshRSS/blob/master/cli/README.md) again to import the SQLite database file into your database: -``` +You can use the [Command-Line Interface](https://github.com/FreshRSS/FreshRSS/blob/edge/cli/README.md) again to import the SQLite database file into your database: + +```sh ./cli/import-sqlite-for-user.php --user <username> --filename </path/to/db.sqlite> ``` + > Again, note that the database filename needs the `sqlite` extension in order to work properly. The SQLite process is useful when you need to: + - export a user fully, - backup your service, - migrate the service to another server, diff --git a/docs/en/admins/05_Configuring_email_validation.md b/docs/en/admins/05_Configuring_email_validation.md index 0379e4c1a..66b26bd3b 100644 --- a/docs/en/admins/05_Configuring_email_validation.md +++ b/docs/en/admins/05_Configuring_email_validation.md @@ -27,7 +27,7 @@ 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/master/config.default.php). +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 PHPMailer documentation](http://phpmailer.github.io/PHPMailer/classes/PHPMailer.PHPMailer.PHPMailer.html#properties) (which is used by FreshRSS under the hood). diff --git a/docs/en/admins/06_LinuxInstall.md b/docs/en/admins/06_LinuxInstall.md index d31758556..fa980a647 100644 --- a/docs/en/admins/06_LinuxInstall.md +++ b/docs/en/admins/06_LinuxInstall.md @@ -5,98 +5,115 @@ This tutorial will give you step-by-step commands to install the latest stable r 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. ## Part 1: Setting up and configuring the LAMP stack + Begin by installing Apache, and enable Apache modules needed for FreshRSS -``` + +```sh 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: -``` +```sh ln -s /etc/apache2/sites-available/freshrss.conf /etc/apache2/sites-enabled/freshrss.conf ``` Next, install PHP and the necessary modules -``` + +```sh apt install php php-curl php-gmp php-intl php-mbstring php-sqlite3 php-xml php-zip ``` Install the PHP module for Apache -``` + +```sh apt install libapache2-mod-php ``` Next, we'll need to install and configure MySQL. Install MySQL components like so: -``` + +```sh sudo apt install mysql-server mysql-client php-mysql ``` MySQL must now be started: -``` + +```sh 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 -``` + +```sh mysql_secure_installation ``` And restart it -``` + +```sh service mysql-server restart ``` Finally, restart MySQL and the web server -``` +```sh service apache2 restart ``` ## Part 2: Installing FreshRSS Begin by installing git, if you don't already have it installed. -``` + +```sh apt install git ``` Next, change to the install directory and download FreshRSS using git -``` + +```sh cd /usr/share/ git clone https://github.com/FreshRSS/FreshRSS.git ``` Change to the new FreshRSS directory, and set the permissions so that your Web server can access the files -``` + +```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/ ``` Optional: If you would like to allow updates from the Web interface, set write permissions -``` + +```sh chmod -R g+w . ``` Finally, symlink the public folder to the root of your web directory -``` + +```sh ln -s /usr/share/FreshRSS/p /var/www/html/ ``` ## Part 3: Creating a Database for FreshRSS Start a MySQL session. running this command will ask you for the MySQL password you set earler, and then put you into a prompt that should look like `MariaDB [(none)]>` -``` + +```sh mysql -u root -p ``` From the MySQL prompt (`MariaDB [(none)]>`), run the following commands, substituting `<username>`, `<password>`, and `<database_name>` for real values. -``` + +```sql CREATE USER '<username>'@'localhost' IDENTIFIED BY '<password>'; CREATE DATABASE `databaseName`; GRANT ALL privileges ON `databaseName`.* TO 'userName'@localhost; @@ -105,6 +122,7 @@ QUIT; ``` A brief explanation of the previous command block: + * You first create a database user for FreshRSS to use. * Then you create a database for FreshRSS to store data in. * You grant permissions for the user you created to read, write, and modify the database. @@ -112,5 +130,5 @@ A brief explanation of the previous command block: ## Part 4: Finishing the Installation -You can now finish the installation from a web browser by navigating to to `http://<your_server>/p` and following the graphical prompts. -Alternatively, you can finish the installation using [the cli](https://github.com/FreshRSS/FreshRSS/tree/master/cli) +You can now finish the installation from a web browser by navigating to to `http://<your_server>/` and following the graphical prompts. +Alternatively, you can finish the installation using [the cli](https://github.com/FreshRSS/FreshRSS/tree/edge/cli) diff --git a/docs/en/admins/07_LinuxUpdate.md b/docs/en/admins/07_LinuxUpdate.md index 40698ab81..6f39f5a45 100644 --- a/docs/en/admins/07_LinuxUpdate.md +++ b/docs/en/admins/07_LinuxUpdate.md @@ -27,17 +27,20 @@ You may wish to run the cron task or systemd unit (`freshrss.service`) immediate 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 cd /usr/share/FreshRSS/ ``` 2. Fetch the most recent code from GitHub -``` + +```sh git fetch --all ``` 3. Discard manual changes and delete manual additions -``` + +```sh git reset --hard git clean -f -d ``` @@ -45,8 +48,9 @@ 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). 4. Update FreshRSS -``` -git checkout master + +```sh +git checkout edge git pull git checkout $(git describe --tags --abbrev=0) ``` @@ -54,51 +58,59 @@ git checkout $(git describe --tags --abbrev=0) Note: If you want to use the rolling release, the last command is optional. 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 `master` 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. Delete the file that triggers the install wizard -``` + +```sh rm data/do-install.txt ``` 7. 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/ ``` ## 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 cd /usr/share/FreshRSS/ ``` -2. Get the link to the Zip archive for [the latest release](https://github.com/FreshRSS/FreshRSS/releases/latest). It should be something like `https://github.com/FreshRSS/FreshRSS/archive/1.15.3.zip` (the numbers can change). If you want to use the rolling release, the link is `https://github.com/FreshRSS/FreshRSS/archive/master.zip` +2. Get the link to the Zip archive for [the latest release](https://github.com/FreshRSS/FreshRSS/releases/latest): [`https://github.com/FreshRSS/FreshRSS/archive/latest.zip`](https://github.com/FreshRSS/FreshRSS/archive/latest.zip). If you want to use the rolling release, the link is [`https://github.com/FreshRSS/FreshRSS/archive/edge.zip`](https://github.com/FreshRSS/FreshRSS/archive/edge.zip). 3. Download and unzip the update file -``` -wget -O freshrss.zip https://github.com/FreshRSS/FreshRSS/archive/1.15.3.zip + +```sh +wget -O freshrss.zip https://github.com/FreshRSS/FreshRSS/archive/latest.zip unzip freshrss.zip ``` 3. Overwrite all your existing files with the new ones -``` + +```sh cp -R FreshRSS-*/* . ``` 4. Re-set permissions -``` + +```sh chown -R :www-data . && chmod -R g+r . && chmod -R g+w ./data/ ``` 5. Clean up the FreshRSS directory by deleting the downloaded zip, the file forcing the setup wizard and the temporary directory -``` + +```sh rm -f freshrss.zip rm -f data/do-install.txt rm -rf FreshRSS-*/ |
