Skip to content

Couchdb

services.couchdb.adminPass

Couchdb (i.e. fauxton) account with permission for all dbs and tasks.

Type: null or string

Default

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/databases/couchdb.nix

services.couchdb.adminUser

Couchdb (i.e. fauxton) account with permission for all dbs and tasks.

Type: string

Default

"admin"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/databases/couchdb.nix

services.couchdb.argsFile

vm.args configuration. Overrides Couchdb's Erlang VM parameters file.

Type: path

Default

"config.services.couchdb.package/etc/vm.args"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/databases/couchdb.nix

services.couchdb.bindAddress

Defines the IP address by which CouchDB will be accessible.

Type: string

Default

"127.0.0.1"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/databases/couchdb.nix

services.couchdb.configFile

Configuration file for persisting runtime changes. File needs to be readable and writable from couchdb user/group.

Type: path

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/databases/couchdb.nix

services.couchdb.databaseDir

Specifies location of CouchDB database files (*.couch named). This location should be writable and readable for the user the CouchDB service runs as (couchdb by default).

Type: path

Default

"/var/lib/couchdb"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/databases/couchdb.nix

services.couchdb.enable

Whether to enable CouchDB Server. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/databases/couchdb.nix

services.couchdb.extraConfig

Extra configuration. Overrides any other configuration.

Type: strings concatenated with "\n"

Default

""

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/databases/couchdb.nix

services.couchdb.group

Group account under which couchdb runs.

Type: string

Default

"couchdb"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/databases/couchdb.nix

services.couchdb.logFile

Specifies the location of file for logging output.

Type: path

Default

"/var/log/couchdb.log"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/databases/couchdb.nix

services.couchdb.package

The couchdb3 package to use. Type: package

Default

pkgs.couchdb3

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/databases/couchdb.nix

services.couchdb.port

Defined the port number to listen.

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

Default

5984

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/databases/couchdb.nix

services.couchdb.uriFile

This file contains the full URI that can be used to access this instance of CouchDB. It is used to help discover the port CouchDB is running on (if it was set to 0 (e.g. automatically assigned any free one). This file should be writable and readable for the user that runs the CouchDB service (couchdb by default).

Type: path

Default

"/run/couchdb/couchdb.uri"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/databases/couchdb.nix

services.couchdb.user

User account under which couchdb runs.

Type: string

Default

"couchdb"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/databases/couchdb.nix

services.couchdb.viewIndexDir

Specifies location of CouchDB view index files. This location should be writable and readable for the user that runs the CouchDB service (couchdb by default).

Type: path

Default

"/var/lib/couchdb"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/databases/couchdb.nix