Jenkins

`services.jenkins.enable`

Whether to enable the jenkins continuous integration server.

Type: boolean

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/continuous-integration/jenkins/default.nix

`services.jenkins.environment`

Additional environment variables to be passed to the jenkins process. As a base environment, jenkins receives NIX_PATH from {option}environment.sessionVariables, NIX_REMOTE is set to "daemon" and JENKINS_HOME is set to the value of {option}services.jenkins.home. This option has precedence and can be used to override those mentioned variables.

Type: attribute set of string

Default

{ }

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/continuous-integration/jenkins/default.nix

`services.jenkins.extraGroups`

List of extra groups that the "jenkins" user should be a part of.

Type: list of string

Default

[ ]

Example

["wheel""dialout"]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/continuous-integration/jenkins/default.nix

`services.jenkins.extraJavaOptions`

Additional command line arguments to pass to the Java run time (as opposed to Jenkins).

Type: list of string

Default

[ ]

Example

["-Xmx80m"]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/continuous-integration/jenkins/default.nix

`services.jenkins.extraOptions`

Additional command line arguments to pass to Jenkins.

Type: list of string

Default

[ ]

Example

["--debug=9"]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/continuous-integration/jenkins/default.nix

`services.jenkins.group`

If the default user "jenkins" is configured then this is the primary group of that user.

Type: string

Default

"jenkins"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/continuous-integration/jenkins/default.nix

`services.jenkins.home`

The path to use as JENKINS_HOME. If the default user "jenkins" is configured then this is the home of the "jenkins" user.

Type: path

Default

"/var/lib/jenkins"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/continuous-integration/jenkins/default.nix

`services.jenkins.jobBuilder.accessToken`

User token in Jenkins used to reload config. WARNING: This token will be world readable in the Nix store. To keep it secret, use the {option}accessTokenFile option instead.

Type: string

Default

""

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/continuous-integration/jenkins/job-builder.nix

`services.jenkins.jobBuilder.accessTokenFile`

File containing the API token for the {option}accessUser user.

Type: string

Default

"${config.services.jenkins.home}/secrets/initialAdminPassword"

Example

"/run/keys/jenkins-job-builder-access-token"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/continuous-integration/jenkins/job-builder.nix

`services.jenkins.jobBuilder.accessUser`

User id in Jenkins used to reload config.

Type: string

Default

"admin"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/continuous-integration/jenkins/job-builder.nix

`services.jenkins.jobBuilder.enable`

Whether to enable the Jenkins Job Builder (JJB) service. It allows defining jobs for Jenkins in a declarative manner.

Jobs managed through the Jenkins WebUI (or by other means) are left unchanged.

Note that it really is declarative configuration; if you remove a previously defined job, the corresponding job directory will be deleted.

Please see the Jenkins Job Builder documentation for more info: https://jenkins-job-builder.readthedocs.io/ . Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/continuous-integration/jenkins/job-builder.nix

`services.jenkins.jobBuilder.jsonJobs`

Job descriptions for Jenkins Job Builder in JSON format.

Type: list of string

Default

[ ]

Example

['' [ { "job": { "name": "jenkins-job-test-2", "builders": [ "shell": "echo 'Hello world!'" ] } } ] '']

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/continuous-integration/jenkins/job-builder.nix

`services.jenkins.jobBuilder.nixJobs`

Job descriptions for Jenkins Job Builder in Nix format.

This is a trivial wrapper around jsonJobs, using builtins.toJSON behind the scene.

Type: list of (attribute set)

Default

[ ]

Example

[ { job ={ name = "jenkins-job-test-3";builders = [{ shell = "echo 'Hello world!'"; }];};}]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/continuous-integration/jenkins/job-builder.nix

`services.jenkins.jobBuilder.yamlJobs`

Job descriptions for Jenkins Job Builder in YAML format.

Type: strings concatenated with "\n"

Default

""

Example

'' - job: name: jenkins-job-test-1 builders: - shell: echo 'Hello world!'''

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/continuous-integration/jenkins/job-builder.nix

`services.jenkins.listenAddress`

Specifies the bind address on which the jenkins HTTP interface listens. The default is the wildcard address.

Type: string

Default

"0.0.0.0"

Example

"localhost"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/continuous-integration/jenkins/default.nix

`services.jenkins.package`

The jenkins package to use. Type: package

Default

pkgs.jenkins

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/continuous-integration/jenkins/default.nix

`services.jenkins.packages`

Packages to add to PATH for the jenkins process.

Type: list of package

Default

[ pkgs.stdenv pkgs.git pkgs.jdk17 config.programs.ssh.package pkgs.nix ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/continuous-integration/jenkins/default.nix

`services.jenkins.plugins`

A set of plugins to activate. Note that this will completely remove and replace any previously installed plugins. If you have manually-installed plugins that you want to keep while using this module, set this option to null. You can generate this set with a tool such as jenkinsPlugins2nix.

Type: null or (attribute set of package)