b08c4ef243
Apply sentence case to all H1s in docs/en/ and remove redundant "FreshRSS" from titles where the docs site context already implies it. Align the three section index titles to "Administrator/Developer/User manual", matching the existing root H1 "FreshRSS manual (English)". Add missing H1s to two pages that were silently dropped from the sidebar: the user FAQ and the Caddy reverse proxy page. The sidebar template uses page.title (derived from H1 by jekyll-titles-from-headings), so pages without an H1 had title=nil and were skipped. Update sidebar parent labels in docs_nav.html and the chapter list in en/index.md to use the new "* manual" naming. Update link text in section indexes that referenced the old H1s. Bundle two grammar fixes encountered along the way: "an User Interface" -> "a user interface", and drop the awkward "the" in "Configuring the email address validation". EN only. No filenames, URLs, or anchor targets changed (anchors come from H2 and below, which are untouched). FR is generated from EN via po4a and will be regenerated separately. Co-authored-by: Bjørn A. Andersen <polybjorn@users.noreply.github.com>
2.8 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.
-
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.
-
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 -
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/. -
Install needed PHP modules. A precise and up-to-date list can be found in the Dockerfile.
-
Create a database for FreshRSS to use. Note the username and password for this database, as it will be needed during installation!
-
Using your supported web browser of choice, navigate to the address you’ve installed your server to complete the installation from the GUI.3
-
In configuration files, you can customize advanced settings:
- the configuration of your instance in
./data/config.custom.phpbefore the install process, or in./data/config.phpafter the install process; - the default configuration for new users in
./data/config-user.custom.php, or in./data/users/*/config.phpfor existing users; - the default set of feeds for new users in
./data/opml.xml.
- the configuration of your instance in
-
Make sure to expose only the
./p/folder to the Web, as the other directories contain personal and sensitive data. ↩︎ -
If you wish to allow updates from the web interface, also give group write permissions to this folder. ↩︎
-
Assuming your server is
http://example.net, this address could behttp://example.net/p/if you didn’t follow our previous advice about not exposing the./p/folder. ↩︎