Skip to content

Commit

Permalink
Changelog references to clients and deployments
Browse files Browse the repository at this point in the history
  • Loading branch information
Alkarex committed Oct 5, 2016
1 parent c845e4f commit 1eaeaac
Show file tree
Hide file tree
Showing 3 changed files with 33 additions and 6 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
* Support for editing feeds and categories from client applications [#1254](https://github.com/FreshRSS/FreshRSS/issues/1254)
* Compatibility:
* Experimental support for PostgreSQL [#1195](https://github.com/FreshRSS/FreshRSS/pull/1195)
* New client supporting FreshRSS on Linux: FeedReader [#1252](https://github.com/FreshRSS/FreshRSS/issues/1252)
* Features
* Better control of number of entries per page or RSS feed [#1249](https://github.com/FreshRSS/FreshRSS/issues/1249)
* Since X hours: `https://freshrss.example/i/?a=rss&hours=3`
Expand Down
19 changes: 16 additions & 3 deletions README.fr.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,8 @@ Nous sommes une communauté amicale.
6. Des paramètres de configuration avancée peuvent être accédés depuis [config.php](./data/config.default.php).

## Installation automatisée
[![DP deploy](https://raw.githubusercontent.com/DFabric/DPlatform-ShellCore/gh-pages/img/deploy.png)](https://dfabric.github.io/DPlatform-ShellCore)
* [![DP deploy](https://raw.githubusercontent.com/DFabric/DPlatform-ShellCore/gh-pages/img/deploy.png)](https://dfabric.github.io/DPlatform-ShellCore)
* [YunoHost](https://github.com/YunoHost-Apps/freshrss_ynh)

## Exemple d’installation complète sur Linux Debian/Ubuntu
```sh
Expand All @@ -70,7 +71,7 @@ sudo apt install libapache2-mod-php #Pour Apache
sudo apt install mysql-server mysql-client php-mysql #Base de données MySQL optionnelle
sudo apt install postgresql php-pgsql #Base de données PostgreSQL optionnelle

# Redémarrage du serveur Web
## Redémarrage du serveur Web
sudo service apache2 restart

# Pour FreshRSS lui-même (git est optionnel si vous déployez manuellement les fichiers d’installation)
Expand All @@ -94,7 +95,7 @@ sudo chown -R :www-data .
sudo chmod -R g+w ./data/
```

# Contrôle d’accès
## Contrôle d’accès
Il est requis pour le mode multi-utilisateur, et recommandé dans tous les cas, de limiter l’accès à votre FreshRSS. Au choix :
* En utilisant l’identification par formulaire (requiert JavaScript, et PHP 5.3.7+ recommandé – fonctionne avec certaines versions de PHP 5.3.3+)
* En utilisant un contrôle d’accès HTTP défini par votre serveur Web
Expand All @@ -111,12 +112,14 @@ Par exemple, pour exécuter le script toutes les heures :
7 * * * * php /votre-chemin/FreshRSS/app/actualize_script.php > /tmp/FreshRSS.log 2>&1
```


# Conseils
* Pour une meilleure sécurité, faites en sorte que seul le répertoire `./p/` soit accessible depuis le Web, par exemple en faisant pointer un sous-domaine sur le répertoire `./p/`.
* En particulier, les données personnelles se trouvent dans le répertoire `./data/`.
* Le fichier `./constants.php` définit les chemins d’accès aux répertoires clés de l’application. Si vous les bougez, tout se passe ici.
* En cas de problème, les logs peuvent être utile à lire, soit depuis l’interface de FreshRSS, soit manuellement depuis `./data/log/*.log`.


# Sauvegarde
* Il faut conserver vos fichiers `./data/config.php` ainsi que `./data/*_user.php`
* Vous pouvez exporter votre liste de flux depuis FreshRSS au format OPML
Expand Down Expand Up @@ -145,3 +148,13 @@ mysqldump -u utilisateur -p --databases freshrss > freshrss.sql
## Si les fonctions natives ne sont pas disponibles
* [Services_JSON](http://pear.php.net/pepr/pepr-proposal-show.php?id=198)
* [password_compat](https://github.com/ircmaxell/password_compat)


# Clients compatibles
Tout client supportant une API de type Google Reader. Sélection :

* Android
* (Propriétaire) [News+](https://play.google.com/store/apps/details?id=com.noinnion.android.newsplus) + [News+ Google Reader extension](https://play.google.com/store/apps/details?id=com.noinnion.android.newsplus.extension.google_reader)
* (Libre, F-Droid) [EasyRSS](https://github.com/Alkarex/EasyRSS)
* Linux
* (Libre) [FeedReader](https://jangernert.github.io/FeedReader/)
19 changes: 16 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,8 @@ We are a friendly community.
6. Advanced configuration settings can be seen in [config.php](./data/config.default.php).

## Automated install
[![DP deploy](https://raw.githubusercontent.com/DFabric/DPlatform-ShellCore/gh-pages/img/deploy.png)](https://dfabric.github.io/DPlatform-ShellCore)
* [![DP deploy](https://raw.githubusercontent.com/DFabric/DPlatform-ShellCore/gh-pages/img/deploy.png)](https://dfabric.github.io/DPlatform-ShellCore)
* [YunoHost](https://github.com/YunoHost-Apps/freshrss_ynh)

## Example of full installation on Linux Debian/Ubuntu
```sh
Expand Down Expand Up @@ -94,14 +95,14 @@ sudo chown -R :www-data .
sudo chmod -R g+w ./data/
```

# Access control
## Access control
It is needed for the multi-user mode to limit access to FreshRSS. You can:
* use form authentication (need JavaScript and PHP 5.3.7+, works with some PHP 5.3.3+)
* use HTTP authentication supported by your web server
* See [Apache documentation](http://httpd.apache.org/docs/trunk/howto/auth.html)
* In that case, create a `./p/i/.htaccess` file with a matching `.htpasswd` file.

# Automatic feed update
## Automatic feed update
* You can add a Cron job to launch the update script.
Check the Cron documentation related to your distribution ([Debian/Ubuntu](https://help.ubuntu.com/community/CronHowto), [Red Hat/Fedora](https://fedoraproject.org/wiki/Administration_Guide_Draft/Cron), [Slackware](http://docs.slackware.com/fr:slackbook:process_control?#cron), [Gentoo](https://wiki.gentoo.org/wiki/Cron), [Arch Linux](https://wiki.archlinux.org/index.php/Cron)…).
It’s a good idea to use the Web server user.
Expand All @@ -111,12 +112,14 @@ For example, if you want to run the script every hour:
7 * * * * php /your-path/FreshRSS/app/actualize_script.php > /tmp/FreshRSS.log 2>&1
```


# Advices
* For a better security, expose only the `./p/` folder on the web.
* Be aware that the `./data/` folder contains all personal data, so it is a bad idea to expose it.
* The `./constants.php` file defines access to application folder. If you want to customize your installation, every thing happens here.
* If you encounter any problem, logs are accessible from the interface or manually in `./data/log/*.log` files.


# Backup
* You need to keep `./data/config.php`, and `./data/*_user.php` files
* You can export your feed list in OPML format from FreshRSS
Expand Down Expand Up @@ -145,3 +148,13 @@ mysqldump -u user -p --databases freshrss > freshrss.sql
## If native functions are not available
* [Services_JSON](http://pear.php.net/pepr/pepr-proposal-show.php?id=198)
* [password_compat](https://github.com/ircmaxell/password_compat)


# Compatible clients
Any client supporting a Google Reader-like API. Selection:

* Android
* (Closed source) [News+](https://play.google.com/store/apps/details?id=com.noinnion.android.newsplus) + [News+ Google Reader extension](https://play.google.com/store/apps/details?id=com.noinnion.android.newsplus.extension.google_reader)
* (Open source, F-Droid) [EasyRSS](https://github.com/Alkarex/EasyRSS)
* Linux
* (Open source) [FeedReader](https://jangernert.github.io/FeedReader/)

0 comments on commit 1eaeaac

Please sign in to comment.