Arnecc: formatting fix for note on password file

2026-07-13T15:23:08Z

formatting fix for note on password file

← Older revision		Revision as of 15:23, 13 July 2026
Line 64:		Line 64:
	}}		}}

	{{note\|code=This password is only used for initial user creation. After first login, you should change it through the FreshRSS web interface. If you wish to stick with a password file, [https://github.com/ryantm/agenix agenix] or [https://github.com/mic92/sops-nix sops] should be used instead.}}		{{note\|code=\|This password is only used for initial user creation. After first login, you should change it through the FreshRSS web interface. If you wish to stick with a password file, [https://github.com/ryantm/agenix agenix] or [https://github.com/mic92/sops-nix sops] should be used instead.}}

	=== Caddy ===		=== Caddy ===

Arnecc: created initial page

2026-07-13T14:20:28Z

created initial page

New page

'''[https://freshrss.org FreshRSS]''' is a self-hosted RSS and Atom feed aggregator. It is lightweight, multi-user, and supports custom tags, an API for mobile clients (Google Reader API and Fever API), WebSub push notifications, XPath-based web scraping (for generating feeds from websites that have no RSS/Atom feed published), OPML import/export, themes, and extensions.

== Installation ==

Enable the FreshRSS module in your configuration:

{{bc|1=
services.freshrss.enable = true;
}}

This creates a PHP-FPM pool and an nginx virtual host automatically.

== Configuration ==

=== Basic setup ===

{{bc|code=
services.freshrss = {
enable = true;
virtualHost = "freshrss.example.com";
baseUrl = "https://freshrss.example.com";
webserver = "nginx";
defaultUser = "desired-user-name";
passwordFile = "/etc/secrets/freshrss";
};
}}

Unlike some NixOS service modules, FreshRSS does not automatically create the database, so you must set it up yourself, e.g. using PostgreSQL:

{{bc|code=
services.postgresql = {
enable = true;
ensureDatabases = [ "freshrss" ];
ensureUsers = [
{
name = "freshrss";
ensureDBOwnership = true;
}
];
};
}}

The module sets up the {{ic|root}} and {{ic|locations}} for the virtual host automatically. You are responsible for adding TLS settings ({{ic|forceSSL}}, {{ic|enableACME}} or {{ic|useACMEHost}}) to the virtual host.

{{bc|code=
services.nginx.virtualHosts."freshrss.example.com" = {
forceSSL = true;
enableACME = true;
};
}}

=== Password file ===

The {{ic|passwordFile}} must contain the plaintext password and be readable by the {{ic|freshrss}} user:

{{file|/etc/secrets/freshrss|text|your-password}}

Create the file with correct permissions:

{{bc|code=
$ sudo echo "your-password" {{!}} sudo tee /etc/secrets/freshrss
$ sudo chown freshrss:freshrss /etc/secrets/freshrss
$ sudo chmod 400 /etc/secrets/freshrss
}}

{{note|code=This password is only used for initial user creation. After first login, you should change it through the FreshRSS web interface. If you wish to stick with a password file, [https://github.com/ryantm/agenix agenix] or [https://github.com/mic92/sops-nix sops] should be used instead.}}

=== Caddy ===

The module supports Caddy as an alternative to nginx via the {{nixos:option|services.freshrss.webserver}} option:

{{bc|code=
services.freshrss = {
webserver = "caddy";
};
}}

Caddy handles TLS automatically. Further customization can be done via {{nixos:option|services.caddy.virtualHosts}}.

=== Mobile API ===

To enable the Google Reader and Fever APIs for mobile clients:

{{bc|code=
services.freshrss.api.enable = true;
}}

Users must then set individual API passwords in their profile settings.

== See also ==

* [[Tt-rss]] — an alternative self-hosted RSS reader with a NixOS module
* [[RSSHub]] — an RSS feed generator for sites that do not natively provide feeds

== References ==

* [https://freshrss.org/ FreshRSS official website]
* [https://github.com/FreshRSS/FreshRSS FreshRSS on GitHub]

[[Category:Server]]

FreshRSS - Revision history

Arnecc: formatting fix for note on password file

Arnecc: created initial page