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. Specially, if you are using NGINX, please keep in mind that FreshRSS needs some specified variables to run properly. So make sure you’ve checked our configuration file. 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.¹

3. Give ownership of the FreshRSS folder to your web server user (often www-data). Give group read permissions to all files in .², and group write permissions to ./data/.

4. Install needed PHP modules. A precise and up-to-date list can be found in the Dockerfile.

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.³

7. In configuration files, you can customize advanced settings:

   • the configuration of your instance in ./data/config.custom.php before the install process, or in ./data/config.php after the install process;
   • the default configuration for new users in ./data/config-user.custom.php, or in ./data/users/*/config.php for existing users;
   • the default set of feeds for new users in ./data/opml.xml.