Skip to content

Tt rss

services.tt-rss.auth.autoCreate

Allow authentication modules to auto-create users in tt-rss internal database when authenticated successfully.

Type: boolean

Default

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/web-apps/tt-rss.nix

services.tt-rss.auth.autoLogin

Automatically login user on remote or other kind of externally supplied authentication, otherwise redirect to login form as normal. If set to true, users won't be able to set application language and settings profile.

Type: boolean

Default

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/web-apps/tt-rss.nix

services.tt-rss.database.createLocally

Create the database and database user locally. Type: boolean

Default

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/web-apps/tt-rss.nix

services.tt-rss.database.host

Host of the database. Leave null to use Unix domain socket.

Type: null or string

Default

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/web-apps/tt-rss.nix

services.tt-rss.database.name

Name of the existing database.

Type: string

Default

"tt_rss"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/web-apps/tt-rss.nix

services.tt-rss.database.password

The database user's password.

Type: null or string

Default

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/web-apps/tt-rss.nix

services.tt-rss.database.passwordFile

The database user's password.

Type: null or string

Default

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/web-apps/tt-rss.nix

services.tt-rss.database.port

The database's port. If not set, the default ports will be provided (5432 and 3306 for pgsql and mysql respectively).

Type: null or 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/web-apps/tt-rss.nix

services.tt-rss.database.type

Database to store feeds. Supported are pgsql and mysql.

Type: one of "pgsql", "mysql"

Default

"pgsql"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/web-apps/tt-rss.nix

services.tt-rss.database.user

The database user. The user must exist and has access to the specified database.

Type: string

Default

"tt_rss"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/web-apps/tt-rss.nix

services.tt-rss.email.digestSubject

Subject line for email digests.

Type: string

Default

"[tt-rss] New headlines for last 24 hours"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/web-apps/tt-rss.nix

services.tt-rss.email.fromAddress

Address for sending outgoing mail. This applies to password reset notifications, digest emails and any other mail.

Type: string

Default

""

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/web-apps/tt-rss.nix

services.tt-rss.email.fromName

Name for sending outgoing mail. This applies to password reset notifications, digest emails and any other mail.

Type: string

Default

"Tiny Tiny RSS"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/web-apps/tt-rss.nix

services.tt-rss.email.login

SMTP authentication login used when sending outgoing mail.

Type: string

Default

""

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/web-apps/tt-rss.nix

services.tt-rss.email.password

SMTP authentication password used when sending outgoing mail.

Type: string

Default

""

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/web-apps/tt-rss.nix

services.tt-rss.email.security

Used to select a secure SMTP connection. Allowed values: ssl, tls, or empty.

Type: one of "", "ssl", "tls"

Default

""

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/web-apps/tt-rss.nix

services.tt-rss.email.server

Hostname:port combination to send outgoing mail. Blank - use system MTA.

Type: string

Default

""

Example

"localhost:25"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/web-apps/tt-rss.nix

services.tt-rss.enable

Whether to enable tt-rss. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/web-apps/tt-rss.nix

services.tt-rss.enableGZipOutput

Selectively gzip output to improve wire performance. This requires PHP Zlib extension on the server. Enabling this can break tt-rss in several httpd/php configurations, if you experience weird errors and tt-rss failing to start, blank pages after login, or content encoding errors, disable it.

Type: boolean

Default

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/web-apps/tt-rss.nix

services.tt-rss.extraConfig

Additional lines to append to config.php.

Type: strings concatenated with "\n"

Default

""

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/web-apps/tt-rss.nix

services.tt-rss.feedCryptKey

Key used for encryption of passwords for password-protected feeds in the database. A string of 24 random characters. If left blank, encryption is not used. Requires mcrypt functions. Warning: changing this key will make your stored feed passwords impossible to decrypt.

Type: string

Default

""

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/web-apps/tt-rss.nix

services.tt-rss.forceArticlePurge

When this option is not 0, users ability to control feed purging intervals is disabled and all articles (which are not starred) older than this amount of days are purged.

Type: signed integer

Default

0

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/web-apps/tt-rss.nix

services.tt-rss.logDestination

Log destination to use. Possible values: sql (uses internal logging you can read in Preferences -> System), syslog - logs to system log. Setting this to blank uses PHP logging (usually to http server error.log).

Type: one of "", "sql", "syslog"

Default

"sql"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/web-apps/tt-rss.nix

services.tt-rss.phpPackage

php package to use for php fpm and update daemon.

Type: package

Default

"pkgs.php"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/web-apps/tt-rss.nix

services.tt-rss.pluginPackages

List of plugins to install. The list elements are expected to be derivations. All elements in this derivation are automatically copied to the plugins.local directory.

Type: list of package

Default

[ ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/web-apps/tt-rss.nix

services.tt-rss.plugins

List of plugins to load automatically for all users. System plugins have to be specified here. Please enable at least one authentication plugin here (auth_*). Users may enable other user plugins from Preferences/Plugins but may not disable plugins specified in this list. Disabling auth_internal in this list would automatically disable reset password link on the login form.

Type: list of string

Default

["auth_internal""note"]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/web-apps/tt-rss.nix

services.tt-rss.pool

Name of existing phpfpm pool that is used to run web-application. If not specified a pool will be created automatically with default values.

Type: string

Default

"tt-rss"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/web-apps/tt-rss.nix

services.tt-rss.pubSubHubbub.enable

Enable client PubSubHubbub support in tt-rss. When disabled, tt-rss won't try to subscribe to PUSH feed updates.

Type: boolean

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/web-apps/tt-rss.nix

services.tt-rss.pubSubHubbub.hub

URL to a PubSubHubbub-compatible hub server. If defined, "Published articles" generated feed would automatically become PUSH-enabled.

Type: string

Default

""

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/web-apps/tt-rss.nix

services.tt-rss.registration.enable

Allow users to register themselves. Please be aware that allowing random people to access your tt-rss installation is a security risk and potentially might lead to data loss or server exploit. Disabled by default.

Type: boolean

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/web-apps/tt-rss.nix

services.tt-rss.registration.maxUsers

Maximum amount of users which will be allowed to register on this system. 0 - no limit.

Type: signed integer

Default

0

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/web-apps/tt-rss.nix

services.tt-rss.registration.notifyAddress

Email address to send new user notifications to.

Type: string

Default

""

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/web-apps/tt-rss.nix

services.tt-rss.root

Root of the application.

Type: path

Default

"/var/lib/tt-rss"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/web-apps/tt-rss.nix

services.tt-rss.selfUrlPath

Full URL of your tt-rss installation. This should be set to the location of tt-rss directory, e.g. http://example.org/tt-rss/ You need to set this option correctly otherwise several features including PUSH, bookmarklets and browser integration will not work properly.

Type: string

Example

"http://localhost"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/web-apps/tt-rss.nix

services.tt-rss.sessionCookieLifetime

Default lifetime of a session (e.g. login) cookie. In seconds, 0 means cookie will be deleted when browser closes.

Type: signed integer

Default

86400

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/web-apps/tt-rss.nix

services.tt-rss.simpleUpdateMode

Enables fallback update mode where tt-rss tries to update feeds in background while tt-rss is open in your browser. If you don't have a lot of feeds and don't want to or can't run background processes while not running tt-rss, this method is generally viable to keep your feeds up to date. Still, there are more robust (and recommended) updating methods available, you can read about them here: https://tt-rss.org/wiki/UpdatingFeeds

Type: boolean

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/web-apps/tt-rss.nix

services.tt-rss.singleUserMode

Operate in single user mode, disables all functionality related to multiple users and authentication. Enabling this assumes you have your tt-rss directory protected by other means (e.g. http auth).

Type: boolean

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/web-apps/tt-rss.nix

services.tt-rss.sphinx.index

Index names in Sphinx configuration. Example configuration files are available on tt-rss wiki.

Type: list of string

Default

["ttrss""delta"]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/web-apps/tt-rss.nix

services.tt-rss.sphinx.server

Hostname:port combination for the Sphinx server.

Type: string

Default

"localhost:9312"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/web-apps/tt-rss.nix

services.tt-rss.themePackages

List of themes to install. The list elements are expected to be derivations. All elements in this derivation are automatically copied to the themes.local directory.

Type: list of package

Default

[ ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/web-apps/tt-rss.nix

services.tt-rss.user

User account under which both the update daemon and the web-application run.

Type: string

Default

"tt_rss"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/web-apps/tt-rss.nix

services.tt-rss.virtualHost

Name of the nginx virtualhost to use and setup. If null, do not setup any virtualhost.

Type: null or string

Default

"tt-rss"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/web-apps/tt-rss.nix