From d7f888392678d711478ed64f4a52f43021d143af Mon Sep 17 00:00:00 2001 From: Patrick Date: Tue, 22 Oct 2019 05:17:12 -0400 Subject: Docs update (#2164) * Update Readme.conf Add information in Readme.conf to hopefully stop bug reports about intended behavior. * Update README.md Co-Authored-By: pattems * Update README.md Co-Authored-By: pattems * Update README.md Co-Authored-By: pattems * Update README.md Co-Authored-By: pattems * Update Readme * Update Documentation Section * Add main Documentation link near top of Document * Make Documentation header a link * Fix spelling mistake I didn't catch * Apply suggestions from code review Co-Authored-By: pattems * Changes per Frenzie comments * Move non-disclaiming disclaimer * English Admin Documentation Update * Add Backup section * Update wording in Index * Move Footnotes to End * Move Footnote * Add content for todos * Fix typos * Fix a bunch of typos * Remove a duplicated file (forgotten during dev merge) * Improve the documentation a bit --- README.md | 77 --------------------------------------------------------------- 1 file changed, 77 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index cf3fbdddb..c41dce4f1 100644 --- a/README.md +++ b/README.md @@ -76,73 +76,6 @@ See the [list of releases](../../releases). More detailed information about installation and server configuration can be found in [our documentation](https://freshrss.github.io/FreshRSS/en/admins/02_Installation.html). -### 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 #Apache modules - -# Example for Ubuntu >= 16.04, Debian >= 9 Stretch -sudo apt install php php-curl php-gmp php-intl php-mbstring php-sqlite3 php-xml php-zip -sudo apt install libapache2-mod-php #For Apache -sudo apt install mysql-server mysql-client php-mysql #Optional MySQL database -sudo apt install postgresql php-pgsql #Optional PostgreSQL database - -# Restart Web server -sudo service apache2 restart - -# For FreshRSS itself (git is optional if you manually download the installation files) -cd /usr/share/ -sudo apt-get install git -sudo git clone https://github.com/FreshRSS/FreshRSS.git -cd FreshRSS - -# If you want to use the development version of FreshRSS -sudo git checkout -b dev origin/dev - -# Set the rights so that your Web server can access the files -sudo chown -R :www-data . && sudo chmod -R g+r . && sudo chmod -R g+w ./data/ -# If you would like to allow updates from the Web interface -sudo chmod -R g+w . - -# 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) -# or use the Command-Line Interface - -# Update to a newer version of FreshRSS with git -cd /usr/share/FreshRSS -sudo git pull -sudo chown -R :www-data . && sudo chmod -R g+r . && sudo chmod -R g+w ./data/ -``` - -See more commands and git commands in the [Command-Line Interface documentation](cli/README.md). - -## Access control -This is needed if you will be using the multi-user mode, to limit access to FreshRSS. Options Available: -* form authentication (needs JavaScript) -* HTTP authentication supported by your web server - * See [Apache documentation](https://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 -* 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](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)…). -It is a good idea to run the cron job as the webserver user (often “www-data”). -For instance, if you want to run the script every hour: - -``` -9 * * * * php /usr/share/FreshRSS/app/actualize_script.php > /tmp/FreshRSS.log 2>&1 -``` - -### Example on Debian / Ubuntu -Create `/etc/cron.d/FreshRSS` with: - -``` -6,36 * * * * www-data php -f /usr/share/FreshRSS/app/actualize_script.php > /tmp/FreshRSS.log 2>&1 -``` - ## Advice * For better security, expose only the `./p/` folder to the Web. * Be aware that the `./data/` folder contains all personal data, so it is a bad idea to expose it. @@ -156,16 +89,6 @@ Create `/etc/cron.d/FreshRSS` with: * In particular, when importing a new feed, all of its articles will appear at the top of the feed list regardless of their declared date. -# Backup -* You need to keep `./data/config.php`, and `./data/users/*/config.php` files -* You can export your feed list in OPML format either from the Web interface, or from the [Command-Line Interface](cli/README.md) -* To save articles, you can use [phpMyAdmin](https://www.phpmyadmin.net) or MySQL tools: - -```bash -mysqldump --skip-comments --disable-keys --user= --password --host --result-file=freshrss.dump.sql --databases -``` - - # Extensions FreshRSS supports further customizations by adding extensions on top of its core functionality. See the [repository dedicated to those extensions](https://github.com/FreshRSS/Extensions). -- cgit v1.2.3