summaryrefslogtreecommitdiff
path: root/docs/en/users
diff options
context:
space:
mode:
authorGravatar Kevin Papst <kevinpapst@users.noreply.github.com> 2017-12-02 13:43:28 +0100
committerGravatar Alexandre Alapetite <alexandre@alapetite.fr> 2017-12-02 13:43:28 +0100
commitb5626391553b57d85cca87869c27ffdbdb9a0b04 (patch)
treecd749bce826f886e7e7e7be2d02e29b177ff0d76 /docs/en/users
parent6c6d9bdfdcfb0155e8adfaaae679512ec819c0f9 (diff)
Documentation updates (#1697)
* added documentation about updating FreshRSS moved Installation to admin directory linked some already existing documentation files
Diffstat (limited to 'docs/en/users')
-rw-r--r--docs/en/users/01_Installation.md144
-rw-r--r--docs/en/users/02_First_steps.md4
-rw-r--r--docs/en/users/06_Mobile_access.md4
3 files changed, 5 insertions, 147 deletions
diff --git a/docs/en/users/01_Installation.md b/docs/en/users/01_Installation.md
deleted file mode 100644
index 9d012f2b1..000000000
--- a/docs/en/users/01_Installation.md
+++ /dev/null
@@ -1,144 +0,0 @@
-# Server requirements
-
-FreshRSS is a web application. This means you’ll need a web server to run it. FreshRSS requirements are really low, so it could run on most shared host servers.
-
-You need to verify that your server can run FreshRSS before installing it. If your server has the proper requirements and FreshRSS does not work, please contact us to find a solution.
-
-| Software | Recommended | Works also with |
-| ----------- | ---------------- | ----------------------------- |
-| Web server | **Apache 2** | Nginx |
-| PHP | **PHP 5.5+** | PHP 5.3.8+ |
-| PHP modules | Required: libxml, cURL, PDO_MySQL, PCRE and ctype. \\ Required (32-bit only): GMP \\Recommanded: JSON, Zlib, mbstring, iconv, ZipArchive | |
-| Database | **MySQL 5.0.3+** | SQLite 3.7.4+ |
-| Browser | **Firefox** | Chrome, Opera, Safari, or IE11+ |
-
-## Important notice
-
-FreshRSS **CAN** work with PHP 5.3.8+. To do so, we are using specific functions available in the [''password_compat'' library](https://github.com/ircmaxell/password_compat#requirements) for the form authentication.
-
-
-# Getting the appropriate version of FreshRSS
-
-FreshRSS has three different releases or branches. Each branch has its own release frequency. So it is better if you spend some time to understand the purpose of each release.
-
-## Stable release
-
-[Download](https://github.com/FreshRSS/FreshRSS/archive/master.zip)
-
-This release is done when we consider that our goal concerning the new features and the stability is reached. It could happen that we make two releases in a really short time if we have a really good coding pace. In reality, we are all working on our spare time, so we release every few months. But this version is really stable, tested thoroughly and you should not face any major bugs.
-
-## Development release
-
-[Download](https://github.com/FreshRSS/FreshRSS/archive/dev.zip)
-
-As its name suggests, it is the working release for developers. **This release is unstable!** If you want to keep track of enhancements on a daily basis, you can use it. But keep in mind that you need to follow the branch activity on Github (via [the branch RSS feed](https://github.com/FreshRSS/FreshRSS/commits/dev.atom) for instance). Some say that the main developers use it on a daily basis without problem. They may know what they are doing…
-
-# Apache installation
-
-This is an example Apache virtual hosts configuration file. It covers HTTP and HTTPS configuration.
-
-```
-<VirtualHost *:80>
- DocumentRoot /var/www/html/
-
- #Default site...
-
- ErrorLog ${APACHE_LOG_DIR}/error.default.log
- CustomLog ${APACHE_LOG_DIR}/access.default.log vhost_combined
-</VirtualHost>
-
-<VirtualHost *:80>
- ServerName rss.example.net
- DocumentRoot /path/to/FreshRSS/p/
-
- <Directory /path/to/FreshRSS/p>
- AllowOverride AuthConfig FileInfo Indexes Limit
- Require all granted
- </Directory>
-
- ErrorLog ${APACHE_LOG_DIR}/freshrss_error.log
- CustomLog ${APACHE_LOG_DIR}/freshrss_access.log combined
-
- AllowEncodedSlashes On
-</VirtualHost>
-
-<IfModule mod_ssl.c>
- <VirtualHost *:443>
- ServerName rss.example.net
- DocumentRoot /path/to/FreshRSS/p/
-
- <Directory /path/to/FreshRSS/p>
- AllowOverride AuthConfig FileInfo Indexes Limit
- Require all granted
- </Directory>
-
- ErrorLog ${APACHE_LOG_DIR}/freshrss_error.log
- CustomLog ${APACHE_LOG_DIR}/freshrss_access.log combined
-
- <IfModule mod_http2.c>
- Protocols h2 http/1.1
- </IfModule>
-
- # For the API
- AllowEncodedSlashes On
-
- SSLEngine on
- SSLCompression off
- SSLCertificateFile /path/to/server.crt
- SSLCertificateKeyFile /path/to/server.key
- # Additional SSL configuration, e.g. with LetsEncrypt
- </VirtualHost>
-</IfModule>
-```
-
-# Nginx installation
-
-This is an example nginx configuration file. It covers HTTP, HTTP, and php-fpm configuration.
-
-_You can find simpler config file but they may be incompatible with FreshRSS API._
-
-```
-server {
- listen 80;
- listen 443 ssl;
-
- # HTTPS configuration
- ssl on;
- ssl_certificate /etc/nginx/server.crt;
- ssl_certificate_key /etc/nginx/server.key;
-
- # your server’s URL(s)
- server_name rss.example.net;
-
- # the folder p of your FreshRSS installation
- root /srv/FreshRSS/p/;
-
- index index.php index.html index.htm;
-
- # nginx log files
- access_log /var/log/nginx/rss.access.log;
- error_log /var/log/nginx/rss.error.log;
-
- # php files handling
- # this regex is mandatory because of the API
- location ~ ^.+?\.php(/.*)?$ {
- fastcgi_pass unix:/var/run/php5-fpm.sock;
- fastcgi_split_path_info ^(.+\.php)(/.*)$;
- # By default, the variable PATH_INFO is not set under PHP-FPM
- # But FreshRSS API greader.php need it. If you have a “Bad Request” error, double check this var!
- fastcgi_param PATH_INFO $fastcgi_path_info;
- include fastcgi_params;
- fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;
- }
-
- location / {
- try_files $uri $uri/ index.php;
- }
-}
-```
-
-A step-by-step tutorial is available [in French](http://www.pihomeserver.fr/2013/05/08/raspberry-pi-home-server-installer-un-agregateur-de-flux-rss-pour-remplacer-google-reader/).
-
-# Security
-
-**TODO**
diff --git a/docs/en/users/02_First_steps.md b/docs/en/users/02_First_steps.md
index 96ee264a6..2fb1b7256 100644
--- a/docs/en/users/02_First_steps.md
+++ b/docs/en/users/02_First_steps.md
@@ -2,7 +2,7 @@ Learning how to handle a new application is not always easy. We build FreshRSS t
This section guides you to the pages you need as a new comer.
-[After you installed the application](01_Installation.md), the first step is to add one or more feeds. You have few options:
+[After installing the application](../admins/02_Installation.md), the first step is to add some feeds. You have a few options:
1. [Add a feed manually](04_Subscriptions.md#adding-a-feed)
2. [Import an OPML or JSON file](04_Subscriptions.md#import-and-export)
@@ -24,3 +24,5 @@ Now that you know the basic usages, it is time to configure FreshRSS to improve
* [Filter articles](03_Main_view.md#filtering-articles) for a fast access to a selection
* [Search an article](03_Main_view.md#searching-articles) published some time ago
* [Access your feeds on a mobile device](06_Mobile_access.md)
+* [Add some extensions](https://github.com/FreshRSS/Extensions)
+* [Frequently asked questions](07_Frequently_Asked_Questions.md)
diff --git a/docs/en/users/06_Mobile_access.md b/docs/en/users/06_Mobile_access.md
index d935411eb..3472172b0 100644
--- a/docs/en/users/06_Mobile_access.md
+++ b/docs/en/users/06_Mobile_access.md
@@ -1,4 +1,4 @@
-This page assumes you have completed the [server setup](01_Installation.md).
+This page assumes you have completed the [server setup](../admins/02_Installation.md).
# Enable the API in FreshRSS
@@ -27,7 +27,7 @@ This page assumes you have completed the [server setup](01_Installation.md).
* With __Apache__:
* If you get *FAIL getallheaders!*, the combination of your PHP version and your Web server does not provide access to [`getallheaders`](http://php.net/getallheaders)
* Update to PHP 5.4+, or use PHP as module instead of CGI. Otherwise turn on Apache `mod_rewrite`:
- * Allow [`FileInfo` in `.htaccess`](http://httpd.apache.org/docs/trunk/mod/core.html#allowoverride): see the [server setup](01_Installation.md) again.
+ * Allow [`FileInfo` in `.htaccess`](http://httpd.apache.org/docs/trunk/mod/core.html#allowoverride): see the [server setup](../admins/02_Installation.md) again.
* Enable [`mod_rewrite`](http://httpd.apache.org/docs/trunk/mod/mod_rewrite.html):
* With Debian / Ubuntu: `sudo a2enmod rewrite`
* With __nginx__: