From 2f1419cf64cc3bfdbbeaa5bdd204925998c9f74a Mon Sep 17 00:00:00 2001 From: Alexandre Alapetite Date: Sat, 30 May 2015 19:45:31 +0200 Subject: Link to releases --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 830dcc01b..0d27e7d1b 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,10 @@ It is a multi-user application with an anonymous reading mode. ![FreshRSS logo](http://marienfressinaud.fr/data/images/freshrss/freshrss_title.png) -# Note on branches +# Releases +See the [list of releases](../../releases). + +## Note on branches **This application is under continuous development!** Please use the branch that suits your needs: * Use [the master branch](https://github.com/FreshRSS/FreshRSS/tree/master/) if you need a stable version. @@ -23,6 +26,7 @@ It is a multi-user application with an anonymous reading mode. # Disclaimer This application was developed to fulfil personal needs primarily, and comes with absolutely no warranty. Feature requests, bug reports, and other contributions are welcome. The best way is to [open issues on GitHub](https://github.com/FreshRSS/FreshRSS/issues). +We are a friendly community. # Requirements * Light server running Linux or Windows -- cgit v1.2.3 From af600b8ad3e03226a946d9fec80f06cb6ebd2f3d Mon Sep 17 00:00:00 2001 From: Alexandre Alapetite Date: Sun, 31 May 2015 18:55:58 +0200 Subject: Read-me: info for git install/update https://github.com/FreshRSS/FreshRSS/issues/861 https://github.com/FreshRSS/FreshRSS/issues/845 --- README.md | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index 0d27e7d1b..50d2ee011 100644 --- a/README.md +++ b/README.md @@ -49,6 +49,37 @@ We are a friendly community. 5. Everything should be working :) If you encounter any problem, feel free to contact me. 6. Advanced configuration settings can be seen in [config.php](./data/config.default.php). +## Example of full installation on Linux Debian/Ubuntu +```sh +# If you use an Apache Web server (otherwise you need another Web server) +sudo apt-get install apache2 +sudo a2enmod headers expires rewrite ssl +# (Optional) If you want a MySQL database server +sudo apt-get install mysql-server mysql-client php5-mysql +# Main components (git is optional if you manually download the installation files) +sudo apt-get install git php5 php5-curl php5-gd php5-intl php5-json php5-gmp php5-sqlite +# Restart Web server +sudo service apache2 restart +# For FreshRSS itself +cd /usr/share/ +sudo git clone https://github.com/FreshRSS/FreshRSS.git +# Set the rights so that your Web browser can access the files +cd FreshRSS +sudo chown -R :www-data . +sudo chmod -R g+w ./data/ +# Publish FreshRSS in your public HTML directory +sudo ln -s /usr/share/FreshRSS/p /var/www/html/FreshRSS +# Navigate to http://example.net/FreshRSS to complete the installation. +# (If you do it from localhost, you may have to adjust the setting of your public address later) + +# Update to a newer version of FreshRSS +cd /usr/share/FreshRSS +sudo git reset --hard +sudo git pull +sudo chown -R :www-data . +sudo chmod -R g+w ./data/ +``` + # 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+) -- cgit v1.2.3 From 20924a4705067145521538bb8254741a8387e2dc Mon Sep 17 00:00:00 2001 From: Alexandre Alapetite Date: Sun, 31 May 2015 18:57:21 +0200 Subject: Readme white line --- README.md | 1 + 1 file changed, 1 insertion(+) (limited to 'README.md') diff --git a/README.md b/README.md index 50d2ee011..e0996508c 100644 --- a/README.md +++ b/README.md @@ -60,6 +60,7 @@ sudo apt-get install mysql-server mysql-client php5-mysql sudo apt-get install git php5 php5-curl php5-gd php5-intl php5-json php5-gmp php5-sqlite # Restart Web server sudo service apache2 restart + # For FreshRSS itself cd /usr/share/ sudo git clone https://github.com/FreshRSS/FreshRSS.git -- cgit v1.2.3