Files
FreshRSS/docs/en/admins/03_Installation.md
T
Patrick d7f8883926 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 <patrick@crandol.com>

* Update README.md

Co-Authored-By: pattems <patrick@crandol.com>

* Update README.md

Co-Authored-By: pattems <patrick@crandol.com>

* Update README.md

Co-Authored-By: pattems <patrick@crandol.com>

* 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 <patrick@crandol.com>

* 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
2019-10-22 11:17:12 +02:00

1.9 KiB

General Installation Instructions

These instructions are intended as general guidelines for installing FreshRSS. You may wish to consult the Step-by-step Tutorial for installing FreshRSS on Debian 9/Ubuntu 16.04 if you don't currently have a web server and don't have experience setting one up.

Before you begin, make sure that you've read the prerequisites for running FreshRSS. As shorthand, . refers to the directory to which your FreshRSS installation lives.

  1. If the computer you're running on is not currently running a web server, you'll first need to install and configure a web server, a version of PHP, and an appropriate database, as listed in the prerequisites. Example Apache and Nginx configuration files can be found here.

  2. Download your chosen version of FreshRSS, or fetch it via git. It's advisable that you put FreshRSS in /usr/share/, and symlink the ./p/ folder to the root of your web server.1

  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.

  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


  1. Make sure to expose only the ./p/ folder to the Web, as the other directories contain personal and sensitive data. ↩︎

  2. If you wish to allow updates from the web interface, also give group write permissions to this folder. ↩︎

  3. Assuming your server is http://example.net, this address could be http://example.net/p/ if you didn't follow our previous advice about not exposing the ./p/ folder. ↩︎