diff options
Diffstat (limited to 'nixos/modules/services/development')
| -rw-r--r-- | nixos/modules/services/development/athens.nix | 194 | ||||
| -rw-r--r-- | nixos/modules/services/development/blackfire.nix | 8 | ||||
| -rw-r--r-- | nixos/modules/services/development/bloop.nix | 4 | ||||
| -rw-r--r-- | nixos/modules/services/development/distccd.nix | 22 | ||||
| -rw-r--r-- | nixos/modules/services/development/gemstash.nix | 14 | ||||
| -rw-r--r-- | nixos/modules/services/development/hoogle.nix | 14 | ||||
| -rw-r--r-- | nixos/modules/services/development/jupyter/default.nix | 20 | ||||
| -rw-r--r-- | nixos/modules/services/development/jupyter/kernel-options.nix | 14 | ||||
| -rw-r--r-- | nixos/modules/services/development/jupyterhub/default.nix | 20 | ||||
| -rw-r--r-- | nixos/modules/services/development/livebook.nix | 6 | ||||
| -rw-r--r-- | nixos/modules/services/development/lorri.nix | 4 | ||||
| -rw-r--r-- | nixos/modules/services/development/rstudio-server/default.nix | 10 | ||||
| -rw-r--r-- | nixos/modules/services/development/zammad.nix | 38 |
13 files changed, 184 insertions, 184 deletions
diff --git a/nixos/modules/services/development/athens.nix b/nixos/modules/services/development/athens.nix index 34f8964a3bd55..55ec065f16896 100644 --- a/nixos/modules/services/development/athens.nix +++ b/nixos/modules/services/development/athens.nix @@ -157,13 +157,13 @@ in }; options.services.athens = { - enable = mkEnableOption (lib.mdDoc "Go module datastore and proxy"); + enable = mkEnableOption "Go module datastore and proxy"; package = mkOption { default = pkgs.athens; defaultText = literalExpression "pkgs.athens"; example = "pkgs.athens"; - description = lib.mdDoc "Which athens derivation to use"; + description = "Which athens derivation to use"; type = types.package; }; @@ -172,7 +172,7 @@ in default = pkgs.go; defaultText = literalExpression "pkgs.go"; example = "pkgs.go_1_21"; - description = lib.mdDoc '' + description = '' The Go package used by Athens at runtime. Athens primarily runs two Go commands: @@ -183,14 +183,14 @@ in goEnv = mkOption { type = types.enum [ "development" "production" ]; - description = lib.mdDoc "Specifies the type of environment to run. One of 'development' or 'production'."; + description = "Specifies the type of environment to run. One of 'development' or 'production'."; default = "development"; example = "production"; }; goBinaryEnvVars = mkOption { type = types.attrs; - description = lib.mdDoc "Environment variables to pass to the Go binary."; + description = "Environment variables to pass to the Go binary."; example = '' { "GOPROXY" = "direct", "GODEBUG" = "true" } ''; @@ -199,14 +199,14 @@ in goGetWorkers = mkOption { type = types.int; - description = lib.mdDoc "Number of workers concurrently downloading modules."; + description = "Number of workers concurrently downloading modules."; default = 10; example = 32; }; goGetDir = mkOption { type = types.nullOr types.path; - description = lib.mdDoc '' + description = '' Temporary directory that Athens will use to fetch modules from VCS prior to persisting them to a storage backend. @@ -220,13 +220,13 @@ in protocolWorkers = mkOption { type = types.int; - description = lib.mdDoc "Number of workers concurrently serving protocol paths."; + description = "Number of workers concurrently serving protocol paths."; default = 30; }; logLevel = mkOption { type = types.nullOr (types.enum [ "panic" "fatal" "error" "warning" "info" "debug" "trace" ]); - description = lib.mdDoc '' + description = '' Log level for Athens. Supports all logrus log levels (https://github.com/Sirupsen/logrus#level-logging)". ''; @@ -236,7 +236,7 @@ in cloudRuntime = mkOption { type = types.enum [ "GCP" "none" ]; - description = lib.mdDoc '' + description = '' Specifies the Cloud Provider on which the Proxy/registry is running. ''; default = "none"; @@ -245,20 +245,20 @@ in enablePprof = mkOption { type = types.bool; - description = lib.mdDoc "Enable pprof endpoints."; + description = "Enable pprof endpoints."; default = false; }; pprofPort = mkOption { type = types.port; - description = lib.mdDoc "Port number for pprof endpoints."; + description = "Port number for pprof endpoints."; default = 3301; example = 443; }; filterFile = mkOption { type = types.nullOr types.path; - description = lib.mdDoc ''Filename for the include exclude filter.''; + description = ''Filename for the include exclude filter.''; default = null; example = literalExpression '' pkgs.writeText "filterFile" ''' @@ -271,34 +271,34 @@ in robotsFile = mkOption { type = types.nullOr types.path; - description = lib.mdDoc ''Provides /robots.txt for net crawlers.''; + description = ''Provides /robots.txt for net crawlers.''; default = null; example = literalExpression ''pkgs.writeText "robots.txt" "# my custom robots.txt ..."''; }; timeout = mkOption { type = types.int; - description = lib.mdDoc "Timeout for external network calls in seconds."; + description = "Timeout for external network calls in seconds."; default = 300; example = 3; }; storageType = mkOption { type = types.enum [ "memory" "disk" "mongo" "gcp" "minio" "s3" "azureblob" "external" ]; - description = lib.mdDoc "Specifies the type of storage backend to use."; + description = "Specifies the type of storage backend to use."; default = "disk"; }; tlsCertFile = mkOption { type = types.nullOr types.path; - description = lib.mdDoc "Path to the TLS certificate file."; + description = "Path to the TLS certificate file."; default = null; example = "/etc/ssl/certs/athens.crt"; }; tlsKeyFile = mkOption { type = types.nullOr types.path; - description = lib.mdDoc "Path to the TLS key file."; + description = "Path to the TLS key file."; default = null; example = "/etc/ssl/certs/athens.key"; }; @@ -306,7 +306,7 @@ in port = mkOption { type = types.port; default = 3000; - description = lib.mdDoc '' + description = '' Port number Athens listens on. ''; example = 443; @@ -314,7 +314,7 @@ in unixSocket = mkOption { type = types.nullOr types.path; - description = lib.mdDoc '' + description = '' Path to the unix socket file. If set, Athens will listen on the unix socket instead of TCP socket. ''; @@ -324,7 +324,7 @@ in globalEndpoint = mkOption { type = types.str; - description = lib.mdDoc '' + description = '' Endpoint for a package registry in case of a proxy cache miss. ''; default = ""; @@ -333,7 +333,7 @@ in basicAuthUser = mkOption { type = types.nullOr types.str; - description = lib.mdDoc '' + description = '' Username for basic auth. ''; default = null; @@ -342,7 +342,7 @@ in basicAuthPass = mkOption { type = types.nullOr types.str; - description = lib.mdDoc '' + description = '' Password for basic auth. Warning: this is stored in plain text in the config file. ''; default = null; @@ -351,7 +351,7 @@ in forceSSL = mkOption { type = types.bool; - description = lib.mdDoc '' + description = '' Force SSL redirects for incoming requests. ''; default = false; @@ -359,7 +359,7 @@ in validatorHook = mkOption { type = types.nullOr types.str; - description = lib.mdDoc '' + description = '' Endpoint to validate modules against. Not used if empty. @@ -370,7 +370,7 @@ in pathPrefix = mkOption { type = types.nullOr types.str; - description = lib.mdDoc '' + description = '' Sets basepath for all routes. ''; default = null; @@ -379,7 +379,7 @@ in netrcPath = mkOption { type = types.nullOr types.path; - description = lib.mdDoc '' + description = '' Path to the .netrc file. ''; default = null; @@ -388,7 +388,7 @@ in githubToken = mkOption { type = types.nullOr types.str; - description = lib.mdDoc '' + description = '' Creates .netrc file with the given token to be used for GitHub. Warning: this is stored in plain text in the config file. ''; @@ -398,7 +398,7 @@ in hgrcPath = mkOption { type = types.nullOr types.path; - description = lib.mdDoc '' + description = '' Path to the .hgrc file. ''; default = null; @@ -407,7 +407,7 @@ in traceExporter = mkOption { type = types.nullOr (types.enum [ "jaeger" "datadog" ]); - description = lib.mdDoc '' + description = '' Trace exporter to use. ''; default = null; @@ -415,7 +415,7 @@ in traceExporterURL = mkOption { type = types.nullOr types.str; - description = lib.mdDoc '' + description = '' URL endpoint that traces will be sent to. ''; default = null; @@ -424,13 +424,13 @@ in statsExporter = mkOption { type = types.nullOr (types.enum [ "prometheus" ]); - description = lib.mdDoc "Stats exporter to use."; + description = "Stats exporter to use."; default = null; }; sumDBs = mkOption { type = types.listOf types.str; - description = lib.mdDoc '' + description = '' List of fully qualified URLs that Athens will proxy that the go command can use a checksum verifier. ''; @@ -439,7 +439,7 @@ in noSumPatterns = mkOption { type = types.listOf types.str; - description = lib.mdDoc '' + description = '' List of patterns that Athens sum db proxy will return a 403 for. ''; default = [ ]; @@ -448,7 +448,7 @@ in downloadMode = mkOption { type = types.oneOf [ (types.enum [ "sync" "async" "redirect" "async_redirect" "none" ]) (types.strMatching "^file:.*$|^custom:.*$") ]; - description = lib.mdDoc '' + description = '' Defines how Athens behaves when a module@version is not found in storage. There are 7 options: 1. "sync": download the module synchronously and @@ -472,7 +472,7 @@ in networkMode = mkOption { type = types.enum [ "strict" "offline" "fallback" ]; - description = lib.mdDoc '' + description = '' Configures how Athens will return the results of the /list endpoint as it can be assembled from both its own storage and the upstream VCS. @@ -492,13 +492,13 @@ in downloadURL = mkOption { type = types.str; - description = lib.mdDoc "URL used if DownloadMode is set to redirect."; + description = "URL used if DownloadMode is set to redirect."; default = "https://proxy.golang.org"; }; singleFlightType = mkOption { type = types.enum [ "memory" "etcd" "redis" "redis-sentinel" "gcp" "azureblob" ]; - description = lib.mdDoc '' + description = '' Determines what mechanism Athens uses to manage concurrency flowing into the Athens backend. ''; default = "memory"; @@ -506,7 +506,7 @@ in indexType = mkOption { type = types.enum [ "none" "memory" "mysql" "postgres" ]; - description = lib.mdDoc '' + description = '' Type of index backend Athens will use. ''; default = "none"; @@ -514,7 +514,7 @@ in shutdownTimeout = mkOption { type = types.int; - description = lib.mdDoc '' + description = '' Number of seconds to wait for the server to shutdown gracefully. ''; default = 60; @@ -525,7 +525,7 @@ in etcd = { endpoints = mkOption { type = types.listOf types.str; - description = lib.mdDoc "URLs that determine all distributed etcd servers."; + description = "URLs that determine all distributed etcd servers."; default = [ ]; example = [ "localhost:2379" ]; }; @@ -533,13 +533,13 @@ in redis = { endpoint = mkOption { type = types.str; - description = lib.mdDoc "URL of the redis server."; + description = "URL of the redis server."; default = ""; example = "localhost:6379"; }; password = mkOption { type = types.str; - description = lib.mdDoc "Password for the redis server. Warning: this is stored in plain text in the config file."; + description = "Password for the redis server. Warning: this is stored in plain text in the config file."; default = ""; example = "swordfish"; }; @@ -547,19 +547,19 @@ in lockConfig = { ttl = mkOption { type = types.int; - description = lib.mdDoc "TTL for the lock in seconds."; + description = "TTL for the lock in seconds."; default = 900; example = 1; }; timeout = mkOption { type = types.int; - description = lib.mdDoc "Timeout for the lock in seconds."; + description = "Timeout for the lock in seconds."; default = 15; example = 1; }; maxRetries = mkOption { type = types.int; - description = lib.mdDoc "Maximum number of retries for the lock."; + description = "Maximum number of retries for the lock."; default = 10; example = 1; }; @@ -569,19 +569,19 @@ in redisSentinel = { endpoints = mkOption { type = types.listOf types.str; - description = lib.mdDoc "URLs that determine all distributed redis servers."; + description = "URLs that determine all distributed redis servers."; default = [ ]; example = [ "localhost:26379" ]; }; masterName = mkOption { type = types.str; - description = lib.mdDoc "Name of the sentinel master server."; + description = "Name of the sentinel master server."; default = ""; example = "redis-1"; }; sentinelPassword = mkOption { type = types.str; - description = lib.mdDoc "Password for the sentinel server. Warning: this is stored in plain text in the config file."; + description = "Password for the sentinel server. Warning: this is stored in plain text in the config file."; default = ""; example = "swordfish"; }; @@ -589,19 +589,19 @@ in lockConfig = { ttl = mkOption { type = types.int; - description = lib.mdDoc "TTL for the lock in seconds."; + description = "TTL for the lock in seconds."; default = 900; example = 1; }; timeout = mkOption { type = types.int; - description = lib.mdDoc "Timeout for the lock in seconds."; + description = "Timeout for the lock in seconds."; default = 15; example = 1; }; maxRetries = mkOption { type = types.int; - description = lib.mdDoc "Maximum number of retries for the lock."; + description = "Maximum number of retries for the lock."; default = 10; example = 1; }; @@ -613,7 +613,7 @@ in cdn = { endpoint = mkOption { type = types.nullOr types.str; - description = lib.mdDoc "hostname of the CDN server."; + description = "hostname of the CDN server."; example = "cdn.example.com"; default = null; }; @@ -622,7 +622,7 @@ in disk = { rootPath = mkOption { type = types.nullOr types.path; - description = lib.mdDoc "Athens disk root folder."; + description = "Athens disk root folder."; default = "/var/lib/athens"; }; }; @@ -630,19 +630,19 @@ in gcp = { projectID = mkOption { type = types.nullOr types.str; - description = lib.mdDoc "GCP project ID."; + description = "GCP project ID."; example = "my-project"; default = null; }; bucket = mkOption { type = types.nullOr types.str; - description = lib.mdDoc "GCP backend storage bucket."; + description = "GCP backend storage bucket."; example = "my-bucket"; default = null; }; jsonKey = mkOption { type = types.nullOr types.str; - description = lib.mdDoc "Base64 encoded GCP service account key. Warning: this is stored in plain text in the config file."; + description = "Base64 encoded GCP service account key. Warning: this is stored in plain text in the config file."; default = null; }; }; @@ -650,36 +650,36 @@ in minio = { endpoint = mkOption { type = types.nullOr types.str; - description = lib.mdDoc "Endpoint of the minio storage backend."; + description = "Endpoint of the minio storage backend."; example = "minio.example.com:9001"; default = null; }; key = mkOption { type = types.nullOr types.str; - description = lib.mdDoc "Access key id for the minio storage backend."; + description = "Access key id for the minio storage backend."; example = "minio"; default = null; }; secret = mkOption { type = types.nullOr types.str; - description = lib.mdDoc "Secret key for the minio storage backend. Warning: this is stored in plain text in the config file."; + description = "Secret key for the minio storage backend. Warning: this is stored in plain text in the config file."; example = "minio123"; default = null; }; enableSSL = mkOption { type = types.bool; - description = lib.mdDoc "Enable SSL for the minio storage backend."; + description = "Enable SSL for the minio storage backend."; default = false; }; bucket = mkOption { type = types.nullOr types.str; - description = lib.mdDoc "Bucket name for the minio storage backend."; + description = "Bucket name for the minio storage backend."; example = "gomods"; default = null; }; region = mkOption { type = types.nullOr types.str; - description = lib.mdDoc "Region for the minio storage backend."; + description = "Region for the minio storage backend."; example = "us-east-1"; default = null; }; @@ -688,25 +688,25 @@ in mongo = { url = mkOption { type = types.nullOr types.str; - description = lib.mdDoc "URL of the mongo database."; + description = "URL of the mongo database."; example = "mongodb://localhost:27017"; default = null; }; defaultDBName = mkOption { type = types.nullOr types.str; - description = lib.mdDoc "Name of the mongo database."; + description = "Name of the mongo database."; example = "athens"; default = null; }; certPath = mkOption { type = types.nullOr types.path; - description = lib.mdDoc "Path to the certificate file for the mongo database."; + description = "Path to the certificate file for the mongo database."; example = "/etc/ssl/mongo.pem"; default = null; }; insecure = mkOption { type = types.bool; - description = lib.mdDoc "Allow insecure connections to the mongo database."; + description = "Allow insecure connections to the mongo database."; default = false; }; }; @@ -714,55 +714,55 @@ in s3 = { region = mkOption { type = types.nullOr types.str; - description = lib.mdDoc "Region of the S3 storage backend."; + description = "Region of the S3 storage backend."; example = "eu-west-3"; default = null; }; key = mkOption { type = types.nullOr types.str; - description = lib.mdDoc "Access key id for the S3 storage backend."; + description = "Access key id for the S3 storage backend."; example = "minio"; default = null; }; secret = mkOption { type = types.str; - description = lib.mdDoc "Secret key for the S3 storage backend. Warning: this is stored in plain text in the config file."; + description = "Secret key for the S3 storage backend. Warning: this is stored in plain text in the config file."; default = ""; }; token = mkOption { type = types.nullOr types.str; - description = lib.mdDoc "Token for the S3 storage backend. Warning: this is stored in plain text in the config file."; + description = "Token for the S3 storage backend. Warning: this is stored in plain text in the config file."; default = null; }; bucket = mkOption { type = types.nullOr types.str; - description = lib.mdDoc "Bucket name for the S3 storage backend."; + description = "Bucket name for the S3 storage backend."; example = "gomods"; default = null; }; forcePathStyle = mkOption { type = types.bool; - description = lib.mdDoc "Force path style for the S3 storage backend."; + description = "Force path style for the S3 storage backend."; default = false; }; useDefaultConfiguration = mkOption { type = types.bool; - description = lib.mdDoc "Use default configuration for the S3 storage backend."; + description = "Use default configuration for the S3 storage backend."; default = false; }; credentialsEndpoint = mkOption { type = types.str; - description = lib.mdDoc "Credentials endpoint for the S3 storage backend."; + description = "Credentials endpoint for the S3 storage backend."; default = ""; }; awsContainerCredentialsRelativeURI = mkOption { type = types.nullOr types.str; - description = lib.mdDoc "Container relative url (used by fargate)."; + description = "Container relative url (used by fargate)."; default = null; }; endpoint = mkOption { type = types.nullOr types.str; - description = lib.mdDoc "Endpoint for the S3 storage backend."; + description = "Endpoint for the S3 storage backend."; default = null; }; }; @@ -770,17 +770,17 @@ in azureblob = { accountName = mkOption { type = types.nullOr types.str; - description = lib.mdDoc "Account name for the Azure Blob storage backend."; + description = "Account name for the Azure Blob storage backend."; default = null; }; accountKey = mkOption { type = types.nullOr types.str; - description = lib.mdDoc "Account key for the Azure Blob storage backend. Warning: this is stored in plain text in the config file."; + description = "Account key for the Azure Blob storage backend. Warning: this is stored in plain text in the config file."; default = null; }; containerName = mkOption { type = types.nullOr types.str; - description = lib.mdDoc "Container name for the Azure Blob storage backend."; + description = "Container name for the Azure Blob storage backend."; default = null; }; }; @@ -788,7 +788,7 @@ in external = { url = mkOption { type = types.nullOr types.str; - description = lib.mdDoc "URL of the backend storage layer."; + description = "URL of the backend storage layer."; example = "https://athens.example.com"; default = null; }; @@ -799,43 +799,43 @@ in mysql = { protocol = mkOption { type = types.str; - description = lib.mdDoc "Protocol for the MySQL database."; + description = "Protocol for the MySQL database."; default = "tcp"; }; host = mkOption { type = types.str; - description = lib.mdDoc "Host for the MySQL database."; + description = "Host for the MySQL database."; default = "localhost"; }; port = mkOption { type = types.int; - description = lib.mdDoc "Port for the MySQL database."; + description = "Port for the MySQL database."; default = 3306; }; user = mkOption { type = types.str; - description = lib.mdDoc "User for the MySQL database."; + description = "User for the MySQL database."; default = "root"; }; password = mkOption { type = types.nullOr types.str; - description = lib.mdDoc "Password for the MySQL database. Warning: this is stored in plain text in the config file."; + description = "Password for the MySQL database. Warning: this is stored in plain text in the config file."; default = null; }; database = mkOption { type = types.str; - description = lib.mdDoc "Database name for the MySQL database."; + description = "Database name for the MySQL database."; default = "athens"; }; params = { parseTime = mkOption { type = types.nullOr types.str; - description = lib.mdDoc "Parse time for the MySQL database."; + description = "Parse time for the MySQL database."; default = "true"; }; timeout = mkOption { type = types.nullOr types.str; - description = lib.mdDoc "Timeout for the MySQL database."; + description = "Timeout for the MySQL database."; default = "30s"; }; }; @@ -844,38 +844,38 @@ in postgres = { host = mkOption { type = types.str; - description = lib.mdDoc "Host for the Postgres database."; + description = "Host for the Postgres database."; default = "localhost"; }; port = mkOption { type = types.int; - description = lib.mdDoc "Port for the Postgres database."; + description = "Port for the Postgres database."; default = 5432; }; user = mkOption { type = types.str; - description = lib.mdDoc "User for the Postgres database."; + description = "User for the Postgres database."; default = "postgres"; }; password = mkOption { type = types.nullOr types.str; - description = lib.mdDoc "Password for the Postgres database. Warning: this is stored in plain text in the config file."; + description = "Password for the Postgres database. Warning: this is stored in plain text in the config file."; default = null; }; database = mkOption { type = types.str; - description = lib.mdDoc "Database name for the Postgres database."; + description = "Database name for the Postgres database."; default = "athens"; }; params = { connect_timeout = mkOption { type = types.nullOr types.str; - description = lib.mdDoc "Connect timeout for the Postgres database."; + description = "Connect timeout for the Postgres database."; default = "30s"; }; sslmode = mkOption { type = types.nullOr types.str; - description = lib.mdDoc "SSL mode for the Postgres database."; + description = "SSL mode for the Postgres database."; default = "disable"; }; }; @@ -884,7 +884,7 @@ in extraConfig = mkOption { type = types.attrs; - description = lib.mdDoc '' + description = '' Extra configuration options for the athens config file. ''; default = { }; diff --git a/nixos/modules/services/development/blackfire.nix b/nixos/modules/services/development/blackfire.nix index 3c98d7a281c63..9b76cfbca0788 100644 --- a/nixos/modules/services/development/blackfire.nix +++ b/nixos/modules/services/development/blackfire.nix @@ -16,9 +16,9 @@ in { options = { services.blackfire-agent = { - enable = lib.mkEnableOption (lib.mdDoc "Blackfire profiler agent"); + enable = lib.mkEnableOption "Blackfire profiler agent"; settings = lib.mkOption { - description = lib.mdDoc '' + description = '' See https://blackfire.io/docs/up-and-running/configuration/agent ''; type = lib.types.submodule { @@ -27,7 +27,7 @@ in { options = { server-id = lib.mkOption { type = lib.types.str; - description = lib.mdDoc '' + description = '' Sets the server id used to authenticate with Blackfire You can find your personal server-id at https://blackfire.io/my/settings/credentials @@ -36,7 +36,7 @@ in { server-token = lib.mkOption { type = lib.types.str; - description = lib.mdDoc '' + description = '' Sets the server token used to authenticate with Blackfire You can find your personal server-token at https://blackfire.io/my/settings/credentials diff --git a/nixos/modules/services/development/bloop.nix b/nixos/modules/services/development/bloop.nix index 27da76a744320..c1180a8bbdd46 100644 --- a/nixos/modules/services/development/bloop.nix +++ b/nixos/modules/services/development/bloop.nix @@ -17,7 +17,7 @@ in { "-J-XX:MaxInlineLevel=20" "-J-XX:+UseParallelGC" ]; - description = lib.mdDoc '' + description = '' Specifies additional command line argument to pass to bloop java process. ''; @@ -26,7 +26,7 @@ in { install = mkOption { type = types.bool; default = false; - description = lib.mdDoc '' + description = '' Whether to install a user service for the Bloop server. The service must be manually started for each user with diff --git a/nixos/modules/services/development/distccd.nix b/nixos/modules/services/development/distccd.nix index af59e1febd86b..916c0905034c8 100644 --- a/nixos/modules/services/development/distccd.nix +++ b/nixos/modules/services/development/distccd.nix @@ -8,13 +8,13 @@ in { options = { services.distccd = { - enable = mkEnableOption (lib.mdDoc "distccd, a distributed C/C++ compiler"); + enable = mkEnableOption "distccd, a distributed C/C++ compiler"; allowedClients = mkOption { type = types.listOf types.str; default = [ "127.0.0.1" ]; example = [ "127.0.0.1" "192.168.0.0/24" "10.0.0.0/24" ]; - description = lib.mdDoc '' + description = '' Client IPs which are allowed to connect to distccd in CIDR notation. Anyone who can connect to the distccd server can run arbitrary @@ -26,7 +26,7 @@ in jobTimeout = mkOption { type = types.nullOr types.int; default = null; - description = lib.mdDoc '' + description = '' Maximum duration, in seconds, of a single compilation request. ''; }; @@ -34,7 +34,7 @@ in logLevel = mkOption { type = types.nullOr (types.enum [ "critical" "error" "warning" "notice" "info" "debug" ]); default = "warning"; - description = lib.mdDoc '' + description = '' Set the minimum severity of error that will be included in the log file. Useful if you only want to see error messages rather than an entry for each connection. @@ -44,7 +44,7 @@ in maxJobs = mkOption { type = types.nullOr types.int; default = null; - description = lib.mdDoc '' + description = '' Maximum number of tasks distccd should execute at any time. ''; }; @@ -53,7 +53,7 @@ in nice = mkOption { type = types.nullOr types.int; default = null; - description = lib.mdDoc '' + description = '' Niceness of the compilation tasks. ''; }; @@ -61,7 +61,7 @@ in openFirewall = mkOption { type = types.bool; default = false; - description = lib.mdDoc '' + description = '' Opens the specified TCP port for distcc. ''; }; @@ -71,17 +71,17 @@ in port = mkOption { type = types.port; default = 3632; - description = lib.mdDoc '' + description = '' The TCP port which distccd will listen on. ''; }; stats = { - enable = mkEnableOption (lib.mdDoc "statistics reporting via HTTP server"); + enable = mkEnableOption "statistics reporting via HTTP server"; port = mkOption { type = types.port; default = 3633; - description = lib.mdDoc '' + description = '' The TCP port which the distccd statistics HTTP server will listen on. ''; @@ -91,7 +91,7 @@ in zeroconf = mkOption { type = types.bool; default = false; - description = lib.mdDoc '' + description = '' Whether to register via mDNS/DNS-SD ''; }; diff --git a/nixos/modules/services/development/gemstash.nix b/nixos/modules/services/development/gemstash.nix index 650c6680ee693..367930dadfb8d 100644 --- a/nixos/modules/services/development/gemstash.nix +++ b/nixos/modules/services/development/gemstash.nix @@ -24,19 +24,19 @@ let in { options.services.gemstash = { - enable = mkEnableOption (lib.mdDoc "gemstash, a cache for rubygems.org and a private gem server"); + enable = mkEnableOption "gemstash, a cache for rubygems.org and a private gem server"; openFirewall = mkOption { type = types.bool; default = false; - description = lib.mdDoc '' + description = '' Whether to open the firewall for the port in {option}`services.gemstash.bind`. ''; }; settings = mkOption { default = {}; - description = lib.mdDoc '' + description = '' Configuration for Gemstash. The details can be found at in [gemstash documentation](https://github.com/rubygems/gemstash/blob/master/man/gemstash-configuration.5.md). Each key set here is automatically prefixed with ":" to match the gemstash expectations. @@ -47,22 +47,22 @@ in base_path = mkOption { type = types.path; default = "/var/lib/gemstash"; - description = lib.mdDoc "Path to store the gem files and the sqlite database. If left unchanged, the directory will be created."; + description = "Path to store the gem files and the sqlite database. If left unchanged, the directory will be created."; }; bind = mkOption { type = types.str; default = "tcp://0.0.0.0:9292"; - description = lib.mdDoc "Host and port combination for the server to listen on."; + description = "Host and port combination for the server to listen on."; }; db_adapter = mkOption { type = types.nullOr (types.enum [ "sqlite3" "postgres" "mysql" "mysql2" ]); default = null; - description = lib.mdDoc "Which database type to use. For choices other than sqlite3, the dbUrl has to be specified as well."; + description = "Which database type to use. For choices other than sqlite3, the dbUrl has to be specified as well."; }; db_url = mkOption { type = types.nullOr types.str; default = null; - description = lib.mdDoc "The database to connect to when using postgres, mysql, or mysql2."; + description = "The database to connect to when using postgres, mysql, or mysql2."; }; }; }; diff --git a/nixos/modules/services/development/hoogle.nix b/nixos/modules/services/development/hoogle.nix index c90bb7f019021..1747ef3912903 100644 --- a/nixos/modules/services/development/hoogle.nix +++ b/nixos/modules/services/development/hoogle.nix @@ -14,12 +14,12 @@ let in { options.services.hoogle = { - enable = mkEnableOption (lib.mdDoc "Haskell documentation server"); + enable = mkEnableOption "Haskell documentation server"; port = mkOption { type = types.port; default = 8080; - description = lib.mdDoc '' + description = '' Port number Hoogle will be listening to. ''; }; @@ -29,7 +29,7 @@ in { default = hp: []; defaultText = literalExpression "hp: []"; example = literalExpression "hp: with hp; [ text lens ]"; - description = lib.mdDoc '' + description = '' The Haskell packages to generate documentation for. The option value is a function that takes the package set specified in @@ -39,7 +39,7 @@ in { }; haskellPackages = mkOption { - description = lib.mdDoc "Which haskell package set to use."; + description = "Which haskell package set to use."; type = types.attrs; default = pkgs.haskellPackages; defaultText = literalExpression "pkgs.haskellPackages"; @@ -47,13 +47,13 @@ in { home = mkOption { type = types.str; - description = lib.mdDoc "Url for hoogle logo"; + description = "Url for hoogle logo"; default = "https://hoogle.haskell.org"; }; host = mkOption { type = types.str; - description = lib.mdDoc "Set the host to bind on."; + description = "Set the host to bind on."; default = "127.0.0.1"; }; @@ -61,7 +61,7 @@ in { type = types.listOf types.str; default = []; example = [ "--no-security-headers" ]; - description = lib.mdDoc '' + description = '' Additional command-line arguments to pass to {command}`hoogle server` ''; diff --git a/nixos/modules/services/development/jupyter/default.nix b/nixos/modules/services/development/jupyter/default.nix index da8c7547fdd79..561ea86ea18bb 100644 --- a/nixos/modules/services/development/jupyter/default.nix +++ b/nixos/modules/services/development/jupyter/default.nix @@ -24,12 +24,12 @@ in { meta.maintainers = with maintainers; [ aborsu ]; options.services.jupyter = { - enable = mkEnableOption (lib.mdDoc "Jupyter development server"); + enable = mkEnableOption "Jupyter development server"; ip = mkOption { type = types.str; default = "localhost"; - description = lib.mdDoc '' + description = '' IP address Jupyter will be listening on. ''; }; @@ -43,7 +43,7 @@ in { type = types.str; default = "jupyter-notebook"; example = "jupyter-lab"; - description = lib.mdDoc '' + description = '' Which command the service runs. Note that not all jupyter packages have all commands, e.g. jupyter-lab isn't present in the default package. ''; @@ -52,7 +52,7 @@ in { port = mkOption { type = types.port; default = 8888; - description = lib.mdDoc '' + description = '' Port number Jupyter will be listening on. ''; }; @@ -60,7 +60,7 @@ in { notebookDir = mkOption { type = types.str; default = "~/"; - description = lib.mdDoc '' + description = '' Root directory for notebooks. ''; }; @@ -68,7 +68,7 @@ in { user = mkOption { type = types.str; default = "jupyter"; - description = lib.mdDoc '' + description = '' Name of the user used to run the jupyter service. For security reason, jupyter should really not be run as root. If not set (jupyter), the service will create a jupyter user with appropriate settings. @@ -79,7 +79,7 @@ in { group = mkOption { type = types.str; default = "jupyter"; - description = lib.mdDoc '' + description = '' Name of the group used to run the jupyter service. Use this if you want to create a group of users that are able to view the notebook directory's content. ''; @@ -88,7 +88,7 @@ in { password = mkOption { type = types.str; - description = lib.mdDoc '' + description = '' Password to use with notebook. Can be generated using: In [1]: from notebook.auth import passwd @@ -105,7 +105,7 @@ in { notebookConfig = mkOption { type = types.lines; default = ""; - description = lib.mdDoc '' + description = '' Raw jupyter config. ''; }; @@ -142,7 +142,7 @@ in { }; } ''; - description = lib.mdDoc '' + description = '' Declarative kernel config. Kernels can be declared in any language that supports and has the required diff --git a/nixos/modules/services/development/jupyter/kernel-options.nix b/nixos/modules/services/development/jupyter/kernel-options.nix index 6e406152de472..8a91125e6cce0 100644 --- a/nixos/modules/services/development/jupyter/kernel-options.nix +++ b/nixos/modules/services/development/jupyter/kernel-options.nix @@ -15,7 +15,7 @@ with lib; "Python 3" "Python 3 for Data Science" ''; - description = lib.mdDoc '' + description = '' Name that will be shown to the user. ''; }; @@ -29,7 +29,7 @@ with lib; "-f" "{connection_file}" ]; - description = lib.mdDoc '' + description = '' Command and arguments to start the kernel. ''; }; @@ -37,7 +37,7 @@ with lib; language = mkOption { type = types.str; example = "python"; - description = lib.mdDoc '' + description = '' Language of the environment. Typically the name of the binary. ''; }; @@ -46,7 +46,7 @@ with lib; type = types.attrsOf types.str; default = { }; example = { OMP_NUM_THREADS = "1"; }; - description = lib.mdDoc '' + description = '' Environment variables to set for the kernel. ''; }; @@ -55,7 +55,7 @@ with lib; type = types.nullOr types.path; default = null; example = literalExpression ''"''${env.sitePackages}/ipykernel/resources/logo-32x32.png"''; - description = lib.mdDoc '' + description = '' Path to 32x32 logo png. ''; }; @@ -63,7 +63,7 @@ with lib; type = types.nullOr types.path; default = null; example = literalExpression ''"''${env.sitePackages}/ipykernel/resources/logo-64x64.png"''; - description = lib.mdDoc '' + description = '' Path to 64x64 logo png. ''; }; @@ -72,7 +72,7 @@ with lib; type = types.attrsOf types.path; default = { }; example = literalExpression ''"{ examples = ''${env.sitePack}/IRkernel/kernelspec/kernel.js"; }''; - description = lib.mdDoc '' + description = '' Extra paths to link in kernel directory ''; }; diff --git a/nixos/modules/services/development/jupyterhub/default.nix b/nixos/modules/services/development/jupyterhub/default.nix index cebc35a504760..d9a37ad915d43 100644 --- a/nixos/modules/services/development/jupyterhub/default.nix +++ b/nixos/modules/services/development/jupyterhub/default.nix @@ -30,12 +30,12 @@ in { meta.maintainers = with maintainers; [ costrouc ]; options.services.jupyterhub = { - enable = mkEnableOption (lib.mdDoc "Jupyterhub development server"); + enable = mkEnableOption "Jupyterhub development server"; authentication = mkOption { type = types.str; default = "jupyterhub.auth.PAMAuthenticator"; - description = lib.mdDoc '' + description = '' Jupyterhub authentication to use There are many authenticators available including: oauth, pam, @@ -46,7 +46,7 @@ in { spawner = mkOption { type = types.str; default = "systemdspawner.SystemdSpawner"; - description = lib.mdDoc '' + description = '' Jupyterhub spawner to use There are many spawners available including: local process, @@ -57,7 +57,7 @@ in { extraConfig = mkOption { type = types.lines; default = ""; - description = lib.mdDoc '' + description = '' Extra contents appended to the jupyterhub configuration Jupyterhub configuration is a normal python file using @@ -84,7 +84,7 @@ in { jupyterhub-systemdspawner ]) ''; - description = lib.mdDoc '' + description = '' Python environment to run jupyterhub Customizing will affect the packages available in the hub and @@ -106,7 +106,7 @@ in { jupyterlab ]) ''; - description = lib.mdDoc '' + description = '' Python environment to run jupyterlab Customizing will affect the packages available in the @@ -146,7 +146,7 @@ in { }; } ''; - description = lib.mdDoc '' + description = '' Declarative kernel config Kernels can be declared in any language that supports and has @@ -159,7 +159,7 @@ in { port = mkOption { type = types.port; default = 8000; - description = lib.mdDoc '' + description = '' Port number Jupyterhub will be listening on ''; }; @@ -167,7 +167,7 @@ in { host = mkOption { type = types.str; default = "0.0.0.0"; - description = lib.mdDoc '' + description = '' Bind IP JupyterHub will be listening on ''; }; @@ -175,7 +175,7 @@ in { stateDirectory = mkOption { type = types.str; default = "jupyterhub"; - description = lib.mdDoc '' + description = '' Directory for jupyterhub state (token + database) ''; }; diff --git a/nixos/modules/services/development/livebook.nix b/nixos/modules/services/development/livebook.nix index df0e6e01e97c7..c7a6e35375791 100644 --- a/nixos/modules/services/development/livebook.nix +++ b/nixos/modules/services/development/livebook.nix @@ -17,7 +17,7 @@ in environment = mkOption { type = with types; attrsOf (nullOr (oneOf [ bool int str ])); default = { }; - description = lib.mdDoc '' + description = '' Environment variables to set. Livebook is configured through the use of environment variables. The @@ -47,7 +47,7 @@ in environmentFile = mkOption { type = with types; nullOr types.path; default = null; - description = lib.mdDoc '' + description = '' Additional dnvironment file as defined in {manpage}`systemd.exec(5)`. Secrets like {env}`LIVEBOOK_PASSWORD` (which is used to specify the @@ -75,7 +75,7 @@ in extraPackages = mkOption { type = with types; listOf package; default = [ ]; - description = lib.mdDoc '' + description = '' Extra packages to make available to the Livebook service. ''; example = literalExpression "with pkgs; [ gcc gnumake ]"; diff --git a/nixos/modules/services/development/lorri.nix b/nixos/modules/services/development/lorri.nix index df3d814d74441..4aba3836e3233 100644 --- a/nixos/modules/services/development/lorri.nix +++ b/nixos/modules/services/development/lorri.nix @@ -9,7 +9,7 @@ in { enable = lib.mkOption { default = false; type = lib.types.bool; - description = lib.mdDoc '' + description = '' Enables the daemon for `lorri`, a nix-shell replacement for project development. The socket-activated daemon starts on the first request issued by the `lorri` command. @@ -18,7 +18,7 @@ in { package = lib.mkOption { default = pkgs.lorri; type = lib.types.package; - description = lib.mdDoc '' + description = '' The lorri package to use. ''; defaultText = lib.literalExpression "pkgs.lorri"; diff --git a/nixos/modules/services/development/rstudio-server/default.nix b/nixos/modules/services/development/rstudio-server/default.nix index fc3756edf0abc..0126e105b3d38 100644 --- a/nixos/modules/services/development/rstudio-server/default.nix +++ b/nixos/modules/services/development/rstudio-server/default.nix @@ -21,12 +21,12 @@ in meta.maintainers = with maintainers; [ jbedo cfhammill ]; options.services.rstudio-server = { - enable = mkEnableOption (lib.mdDoc "RStudio server"); + enable = mkEnableOption "RStudio server"; serverWorkingDir = mkOption { type = types.str; default = "/var/lib/rstudio-server"; - description = lib.mdDoc '' + description = '' Default working directory for server (server-working-dir in rserver.conf). ''; }; @@ -34,7 +34,7 @@ in listenAddr = mkOption { type = types.str; default = "127.0.0.1"; - description = lib.mdDoc '' + description = '' Address to listen on (www-address in rserver.conf). ''; }; @@ -46,7 +46,7 @@ in rserverExtraConfig = mkOption { type = types.str; default = ""; - description = lib.mdDoc '' + description = '' Extra contents for rserver.conf. ''; }; @@ -54,7 +54,7 @@ in rsessionExtraConfig = mkOption { type = types.str; default = ""; - description = lib.mdDoc '' + description = '' Extra contents for resssion.conf. ''; }; diff --git a/nixos/modules/services/development/zammad.nix b/nixos/modules/services/development/zammad.nix index c084d6541ad38..0659c48e815e2 100644 --- a/nixos/modules/services/development/zammad.nix +++ b/nixos/modules/services/development/zammad.nix @@ -29,14 +29,14 @@ in options = { services.zammad = { - enable = mkEnableOption (lib.mdDoc "Zammad, a web-based, open source user support/ticketing solution"); + enable = mkEnableOption "Zammad, a web-based, open source user support/ticketing solution"; package = mkPackageOption pkgs "zammad" { }; dataDir = mkOption { type = types.path; default = "/var/lib/zammad"; - description = lib.mdDoc '' + description = '' Path to a folder that will contain Zammad working directory. ''; }; @@ -45,38 +45,38 @@ in type = types.str; default = "127.0.0.1"; example = "192.168.23.42"; - description = lib.mdDoc "Host address."; + description = "Host address."; }; openPorts = mkOption { type = types.bool; default = false; - description = lib.mdDoc "Whether to open firewall ports for Zammad"; + description = "Whether to open firewall ports for Zammad"; }; port = mkOption { type = types.port; default = 3000; - description = lib.mdDoc "Web service port."; + description = "Web service port."; }; websocketPort = mkOption { type = types.port; default = 6042; - description = lib.mdDoc "Websocket service port."; + description = "Websocket service port."; }; redis = { createLocally = mkOption { type = types.bool; default = true; - description = lib.mdDoc "Whether to create a local redis automatically."; + description = "Whether to create a local redis automatically."; }; name = mkOption { type = types.str; default = "zammad"; - description = lib.mdDoc '' + description = '' Name of the redis server. Only used if `createLocally` is set to true. ''; }; @@ -84,7 +84,7 @@ in host = mkOption { type = types.str; default = "localhost"; - description = lib.mdDoc '' + description = '' Redis server address. ''; }; @@ -92,7 +92,7 @@ in port = mkOption { type = types.port; default = 6379; - description = lib.mdDoc "Port of the redis server."; + description = "Port of the redis server."; }; }; @@ -101,7 +101,7 @@ in type = types.enum [ "PostgreSQL" "MySQL" ]; default = "PostgreSQL"; example = "MySQL"; - description = lib.mdDoc "Database engine to use."; + description = "Database engine to use."; }; host = mkOption { @@ -116,7 +116,7 @@ in MySQL = "localhost"; }.''${config.services.zammad.database.type}; ''; - description = lib.mdDoc '' + description = '' Database host address. ''; }; @@ -124,13 +124,13 @@ in port = mkOption { type = types.nullOr types.port; default = null; - description = lib.mdDoc "Database port. Use `null` for default port."; + description = "Database port. Use `null` for default port."; }; name = mkOption { type = types.str; default = "zammad"; - description = lib.mdDoc '' + description = '' Database name. ''; }; @@ -138,14 +138,14 @@ in user = mkOption { type = types.nullOr types.str; default = "zammad"; - description = lib.mdDoc "Database user."; + description = "Database user."; }; passwordFile = mkOption { type = types.nullOr types.path; default = null; example = "/run/keys/zammad-dbpassword"; - description = lib.mdDoc '' + description = '' A file containing the password for {option}`services.zammad.database.user`. ''; }; @@ -153,7 +153,7 @@ in createLocally = mkOption { type = types.bool; default = true; - description = lib.mdDoc "Whether to create a local database automatically."; + description = "Whether to create a local database automatically."; }; settings = mkOption { @@ -163,7 +163,7 @@ in { } ''; - description = lib.mdDoc '' + description = '' The {file}`database.yml` configuration file as key value set. See \<TODO\> for list of configuration parameters. @@ -175,7 +175,7 @@ in type = types.nullOr types.path; default = null; example = "/run/keys/secret_key_base"; - description = lib.mdDoc '' + description = '' The path to a file containing the `secret_key_base` secret. |