diff options
Diffstat (limited to 'nixos/modules/services/web-apps/nextcloud.nix')
| -rw-r--r-- | nixos/modules/services/web-apps/nextcloud.nix | 118 |
1 files changed, 59 insertions, 59 deletions
diff --git a/nixos/modules/services/web-apps/nextcloud.nix b/nixos/modules/services/web-apps/nextcloud.nix index 7f998207c434a..f179a9854eb91 100644 --- a/nixos/modules/services/web-apps/nextcloud.nix +++ b/nixos/modules/services/web-apps/nextcloud.nix @@ -223,22 +223,22 @@ in { ]; options.services.nextcloud = { - enable = mkEnableOption (lib.mdDoc "nextcloud"); + enable = mkEnableOption "nextcloud"; hostName = mkOption { type = types.str; - description = lib.mdDoc "FQDN for the nextcloud instance."; + description = "FQDN for the nextcloud instance."; }; home = mkOption { type = types.str; default = "/var/lib/nextcloud"; - description = lib.mdDoc "Storage path of nextcloud."; + description = "Storage path of nextcloud."; }; datadir = mkOption { type = types.str; default = config.services.nextcloud.home; defaultText = literalExpression "config.services.nextcloud.home"; - description = lib.mdDoc '' + description = '' Nextcloud's data storage path. Will be [](#opt-services.nextcloud.home) by default. This folder will be populated with a config.php file and a data folder which contains the state of the instance (excluding the database)."; ''; @@ -247,7 +247,7 @@ in { extraApps = mkOption { type = types.attrsOf types.package; default = { }; - description = lib.mdDoc '' + description = '' Extra apps to install. Should be an attrSet of appid to packages generated by fetchNextcloudApp. The appid must be identical to the "id" value in the apps appinfo/info.xml. Using this will disable the appstore to prevent Nextcloud from updating these apps (see [](#opt-services.nextcloud.appstoreEnable)). @@ -267,7 +267,7 @@ in { extraAppsEnable = mkOption { type = types.bool; default = true; - description = lib.mdDoc '' + description = '' Automatically enable the apps in [](#opt-services.nextcloud.extraApps) every time Nextcloud starts. If set to false, apps need to be enabled in the Nextcloud web user interface or with `nextcloud-occ app:enable`. ''; @@ -276,7 +276,7 @@ in { type = types.nullOr types.bool; default = null; example = true; - description = lib.mdDoc '' + description = '' Allow the installation and updating of apps from the Nextcloud appstore. Enabled by default unless there are packages in [](#opt-services.nextcloud.extraApps). Set this to true to force enable the store even if [](#opt-services.nextcloud.extraApps) is used. @@ -286,11 +286,11 @@ in { https = mkOption { type = types.bool; default = false; - description = lib.mdDoc "Use HTTPS for generated links."; + description = "Use HTTPS for generated links."; }; package = mkOption { type = types.package; - description = lib.mdDoc "Which package to use for the Nextcloud instance."; + description = "Which package to use for the Nextcloud instance."; relatedPackages = [ "nextcloud26" "nextcloud27" "nextcloud28" ]; }; phpPackage = mkPackageOption pkgs "php" { @@ -300,7 +300,7 @@ in { maxUploadSize = mkOption { default = "512M"; type = types.str; - description = lib.mdDoc '' + description = '' The upload limit for files. This changes the relevant options in php.ini and nginx if enabled. ''; @@ -309,7 +309,7 @@ in { webfinger = mkOption { type = types.bool; default = false; - description = lib.mdDoc '' + description = '' Enable this option if you plan on using the webfinger plugin. The appropriate nginx rewrite rules will be added to your configuration. ''; @@ -319,7 +319,7 @@ in { type = with types; functionTo (listOf package); default = all: []; defaultText = literalExpression "all: []"; - description = lib.mdDoc '' + description = '' Additional PHP extensions to use for Nextcloud. By default, only extensions necessary for a vanilla Nextcloud installation are enabled, but you may choose from the list of available extensions and add further ones. @@ -333,7 +333,7 @@ in { phpOptions = mkOption { type = with types; attrsOf (oneOf [ str int ]); defaultText = literalExpression (generators.toPretty { } defaultPHPSettings); - description = lib.mdDoc '' + description = '' Options for PHP's php.ini file for nextcloud. Please note that this option is _additive_ on purpose while the @@ -372,7 +372,7 @@ in { "pm.max_spare_servers" = "4"; "pm.max_requests" = "500"; }; - description = lib.mdDoc '' + description = '' Options for nextcloud's PHP pool. See the documentation on `php-fpm.conf` for details on configuration directives. ''; }; @@ -380,7 +380,7 @@ in { poolConfig = mkOption { type = types.nullOr types.lines; default = null; - description = lib.mdDoc '' + description = '' Options for Nextcloud's PHP pool. See the documentation on `php-fpm.conf` for details on configuration directives. ''; }; @@ -388,7 +388,7 @@ in { fastcgiTimeout = mkOption { type = types.int; default = 120; - description = lib.mdDoc '' + description = '' FastCGI timeout for database connection in seconds. ''; }; @@ -398,7 +398,7 @@ in { createLocally = mkOption { type = types.bool; default = false; - description = lib.mdDoc '' + description = '' Whether to create the database and database user locally. ''; }; @@ -409,22 +409,22 @@ in { dbtype = mkOption { type = types.enum [ "sqlite" "pgsql" "mysql" ]; default = "sqlite"; - description = lib.mdDoc "Database type."; + description = "Database type."; }; dbname = mkOption { type = types.nullOr types.str; default = "nextcloud"; - description = lib.mdDoc "Database name."; + description = "Database name."; }; dbuser = mkOption { type = types.nullOr types.str; default = "nextcloud"; - description = lib.mdDoc "Database user."; + description = "Database user."; }; dbpassFile = mkOption { type = types.nullOr types.str; default = null; - description = lib.mdDoc '' + description = '' The full path to a file that contains the database password. ''; }; @@ -436,7 +436,7 @@ in { else "localhost"; defaultText = "localhost"; example = "localhost:5000"; - description = lib.mdDoc '' + description = '' Database host (+port) or socket path. If [](#opt-services.nextcloud.database.createLocally) is true and [](#opt-services.nextcloud.config.dbtype) is either `pgsql` or `mysql`, @@ -446,12 +446,12 @@ in { dbtableprefix = mkOption { type = types.nullOr types.str; default = null; - description = lib.mdDoc "Table prefix in Nextcloud's database."; + description = "Table prefix in Nextcloud's database."; }; adminuser = mkOption { type = types.str; default = "root"; - description = lib.mdDoc '' + description = '' Username for the admin account. The username is only set during the initial setup of Nextcloud! Since the username also acts as unique ID internally, it cannot be changed later! @@ -459,7 +459,7 @@ in { }; adminpassFile = mkOption { type = types.str; - description = lib.mdDoc '' + description = '' The full path to a file that contains the admin's password. Must be readable by user `nextcloud`. The password is set only in the initial setup of Nextcloud by the systemd service `nextcloud-setup.service`. @@ -467,7 +467,7 @@ in { }; objectstore = { s3 = { - enable = mkEnableOption (lib.mdDoc '' + enable = mkEnableOption '' S3 object storage as primary storage. This mounts a bucket on an Amazon S3 object storage or compatible @@ -475,31 +475,31 @@ in { Further details about this feature can be found in the [upstream documentation](https://docs.nextcloud.com/server/22/admin_manual/configuration_files/primary_storage.html). - ''); + ''; bucket = mkOption { type = types.str; example = "nextcloud"; - description = lib.mdDoc '' + description = '' The name of the S3 bucket. ''; }; autocreate = mkOption { type = types.bool; - description = lib.mdDoc '' + description = '' Create the objectstore if it does not exist. ''; }; key = mkOption { type = types.str; example = "EJ39ITYZEUH5BGWDRUFY"; - description = lib.mdDoc '' + description = '' The access key for the S3 bucket. ''; }; secretFile = mkOption { type = types.str; example = "/var/nextcloud-objectstore-s3-secret"; - description = lib.mdDoc '' + description = '' The full path to a file that contains the access secret. Must be readable by user `nextcloud`. ''; @@ -508,21 +508,21 @@ in { type = types.nullOr types.str; default = null; example = "example.com"; - description = lib.mdDoc '' + description = '' Required for some non-Amazon implementations. ''; }; port = mkOption { type = types.nullOr types.port; default = null; - description = lib.mdDoc '' + description = '' Required for some non-Amazon implementations. ''; }; useSsl = mkOption { type = types.bool; default = true; - description = lib.mdDoc '' + description = '' Use SSL for objectstore access. ''; }; @@ -530,14 +530,14 @@ in { type = types.nullOr types.str; default = null; example = "REGION"; - description = lib.mdDoc '' + description = '' Required for some non-Amazon implementations. ''; }; usePathStyle = mkOption { type = types.bool; default = false; - description = lib.mdDoc '' + description = '' Required for some non-Amazon S3 implementations. Ordinarily, requests will be made with @@ -550,7 +550,7 @@ in { type = types.nullOr types.path; default = null; example = "/var/nextcloud-objectstore-s3-sse-c-key"; - description = lib.mdDoc '' + description = '' If provided this is the full path to a file that contains the key to enable [server-side encryption with customer-provided keys][1] (SSE-C). @@ -571,13 +571,13 @@ in { }; }; - enableImagemagick = mkEnableOption (lib.mdDoc '' + enableImagemagick = mkEnableOption '' the ImageMagick module for PHP. This is used by the theming app and for generating previews of certain images (e.g. SVG and HEIF). You may want to disable it for increased security. In that case, previews will still be available for some images (e.g. JPEG and PNG). See <https://github.com/nextcloud/server/issues/13099>. - '') // { + '' // { default = true; }; @@ -585,7 +585,7 @@ in { type = lib.types.bool; default = config.services.nextcloud.notify_push.enable; defaultText = literalExpression "config.services.nextcloud.notify_push.enable"; - description = lib.mdDoc '' + description = '' Whether to configure Nextcloud to use the recommended Redis settings for small instances. ::: {.note} @@ -598,14 +598,14 @@ in { apcu = mkOption { type = types.bool; default = true; - description = lib.mdDoc '' + description = '' Whether to load the APCu module into PHP. ''; }; redis = mkOption { type = types.bool; default = false; - description = lib.mdDoc '' + description = '' Whether to load the Redis module into PHP. You still need to enable Redis in your config.php. See https://docs.nextcloud.com/server/14/admin_manual/configuration_server/caching_configuration.html @@ -614,7 +614,7 @@ in { memcached = mkOption { type = types.bool; default = false; - description = lib.mdDoc '' + description = '' Whether to load the Memcached module into PHP. You still need to enable Memcached in your config.php. See https://docs.nextcloud.com/server/14/admin_manual/configuration_server/caching_configuration.html @@ -625,7 +625,7 @@ in { enable = mkOption { type = types.bool; default = false; - description = lib.mdDoc '' + description = '' Run a regular auto-update of all apps installed from the Nextcloud app store. ''; }; @@ -633,7 +633,7 @@ in { type = with types; either str (listOf str); default = "05:00:00"; example = "Sun 14:00:00"; - description = lib.mdDoc '' + description = '' When to run the update. See `systemd.services.<name>.startAt`. ''; }; @@ -643,7 +643,7 @@ in { default = occ; defaultText = literalMD "generated script"; internal = true; - description = lib.mdDoc '' + description = '' The nextcloud-occ program preconfigured to target this Nextcloud instance. ''; }; @@ -656,7 +656,7 @@ in { loglevel = mkOption { type = types.ints.between 0 4; default = 2; - description = lib.mdDoc '' + description = '' Log level value between 0 (DEBUG) and 4 (FATAL). - 0 (debug): Log all activity. @@ -673,7 +673,7 @@ in { log_type = mkOption { type = types.enum [ "errorlog" "file" "syslog" "systemd" ]; default = "syslog"; - description = lib.mdDoc '' + description = '' Logging backend to use. systemd requires the php-systemd package to be added to services.nextcloud.phpExtraExtensions. See the [nextcloud documentation](https://docs.nextcloud.com/server/latest/admin_manual/configuration_server/logging_configuration.html) for details. @@ -682,7 +682,7 @@ in { skeletondirectory = mkOption { default = ""; type = types.str; - description = lib.mdDoc '' + description = '' The directory where the skeleton files are located. These files will be copied to the data directory of new users. Leave empty to not copy any skeleton files. @@ -691,7 +691,7 @@ in { trusted_domains = mkOption { type = types.listOf types.str; default = []; - description = lib.mdDoc '' + description = '' Trusted domains, from which the nextcloud installation will be accessible. You don't need to add `services.nextcloud.hostname` here. @@ -700,7 +700,7 @@ in { trusted_proxies = mkOption { type = types.listOf types.str; default = []; - description = lib.mdDoc '' + description = '' Trusted proxies, to provide if the nextcloud installation is being proxied to secure against e.g. spoofing. ''; @@ -709,7 +709,7 @@ in { type = types.enum [ "" "http" "https" ]; default = ""; example = "https"; - description = lib.mdDoc '' + description = '' Force Nextcloud to always use HTTP or HTTPS i.e. for link generation. Nextcloud uses the currently used protocol by default, but when behind a reverse-proxy, it may use `http` for everything although @@ -720,7 +720,7 @@ in { default = ""; type = types.str; example = "DE"; - description = lib.mdDoc '' + description = '' An [ISO 3166-1](https://www.iso.org/iso-3166-country-codes.html) country code which replaces automatic phone-number detection without a country code. @@ -729,8 +729,8 @@ in { the `+49` prefix can be omitted for phone numbers. ''; }; - "profile.enabled" = mkEnableOption (lib.mdDoc "global profiles") // { - description = lib.mdDoc '' + "profile.enabled" = mkEnableOption "global profiles" // { + description = '' Makes user-profiles globally available under `nextcloud.tld/u/user.name`. Even though it's enabled by default in Nextcloud, it must be explicitly enabled here because it has the side-effect that personal information is even accessible to @@ -751,7 +751,7 @@ in { }; }; default = {}; - description = lib.mdDoc '' + description = '' Extra options which should be appended to Nextcloud's config.php file. ''; example = literalExpression '' { @@ -768,7 +768,7 @@ in { secretFile = mkOption { type = types.nullOr types.str; default = null; - description = lib.mdDoc '' + description = '' Secret options which will be appended to Nextcloud's config.php file (written as JSON, in the same form as the [](#opt-services.nextcloud.settings) option), for example `{"redis":{"password":"secret"}}`. @@ -779,12 +779,12 @@ in { recommendedHttpHeaders = mkOption { type = types.bool; default = true; - description = lib.mdDoc "Enable additional recommended HTTP response headers"; + description = "Enable additional recommended HTTP response headers"; }; hstsMaxAge = mkOption { type = types.ints.positive; default = 15552000; - description = lib.mdDoc '' + description = '' Value for the `max-age` directive of the HTTP `Strict-Transport-Security` header. |