packages

A list of packages to expose inside the developer environment. Search available packages using devenv search NAME.

Type: list of package

Default: [ ]

Declared by: - https://github.com/imincik/geospatial-nix.env/blob/master/modules/top-level.nix

applications.grass.enable

Whether to enable GRASS application.

Type: boolean

Default: false

Example: true

Declared by: - https://github.com/imincik/geospatial-nix.env/blob/master/modules/applications/grass.nix

applications.grass.package

GRASS package to use.

Type: package

Default: pkgs.grass

Declared by: - https://github.com/imincik/geospatial-nix.env/blob/master/modules/applications/grass.nix

applications.grass.plugins

List of GRASS plugins (addons) to include.

Type: null or (function that evaluates to a(n) list of package)

Default: null

Example:

plugins: [
  pkgs.grassPlugins.r-hydrodem
  pkgs.grassPlugins.v-histogram
];

Declared by: - https://github.com/imincik/geospatial-nix.env/blob/master/modules/applications/grass.nix

applications.qgis.enable

Whether to enable QGIS application.

Type: boolean

Default: false

Example: true

Declared by: - https://github.com/imincik/geospatial-nix.env/blob/master/modules/applications/qgis.nix

applications.qgis.package

QGIS package to use.

Type: package

Default: pkgs.qgis

Declared by: - https://github.com/imincik/geospatial-nix.env/blob/master/modules/applications/qgis.nix

applications.qgis.plugins

List of QGIS plugins to include.

Type: null or (function that evaluates to a(n) list of package)

Default: null

Example:

plugins: [
  pkgs.qgisPlugins.qgis2web
  pkgs.qgisPlugins.QGIS-Cloud-Plugin
];

Declared by: - https://github.com/imincik/geospatial-nix.env/blob/master/modules/applications/qgis.nix

applications.qgis.pythonPackages

List of extra Python packages to include.

Type: null or (function that evaluates to a(n) list of package)

Default: null

Example:

packages: [
  pkgs.python3Packages.flask
  pkgs.python3Packages.fiona
];

Declared by: - https://github.com/imincik/geospatial-nix.env/blob/master/modules/applications/qgis.nix

applications.qgis.withGrass

Enable GRASS GIS support.

Type: boolean

Default: false

Declared by: - https://github.com/imincik/geospatial-nix.env/blob/master/modules/applications/qgis.nix

container.isBuilding

Set to true when the environment is building a container.

Type: boolean

Default: false

Declared by: - https://github.com/imincik/geospatial-nix.env/blob/master/modules/containers.nix

containers

Container specifications that can be built, copied and ran using devenv container.

Type: attribute set of (submodule)

Default: { }

Declared by: - https://github.com/imincik/geospatial-nix.env/blob/master/modules/containers.nix

containers.\.copyToRoot

Add a path to the container. Defaults to the whole git repo.

Type: null or path or list of path

Default: "self"

Declared by: - https://github.com/imincik/geospatial-nix.env/blob/master/modules/containers.nix

containers.\.defaultCopyArgs

Default arguments to pass to skopeo copy. You can override them by passing arguments to the script.

Type: list of string

Default: [ ]

Declared by: - https://github.com/imincik/geospatial-nix.env/blob/master/modules/containers.nix

containers.\.entrypoint

Entrypoint of the container.

Type: list of anything

Default: [ entrypoint ]

Declared by: - https://github.com/imincik/geospatial-nix.env/blob/master/modules/containers.nix

containers.\.isBuilding

Set to true when the environment is building this container.

Type: boolean

Default: false

Declared by: - https://github.com/imincik/geospatial-nix.env/blob/master/modules/containers.nix

containers.\.maxLayers

the maximum number of layers to create.

Type: signed integer

Default: 1

Declared by: - https://github.com/imincik/geospatial-nix.env/blob/master/modules/containers.nix

containers.\.name

Name of the container.

Type: null or string

Default: "my-container"

Declared by: - https://github.com/imincik/geospatial-nix.env/blob/master/modules/containers.nix

containers.\.registry

Registry to push the container to.

Type: null or string

Default: "docker://"

Declared by: - https://github.com/imincik/geospatial-nix.env/blob/master/modules/containers.nix

containers.\.startupCommand

Command to run in the container.

Type: null or string or package

Default: null

Declared by: - https://github.com/imincik/geospatial-nix.env/blob/master/modules/containers.nix

containers.\.version

Version/tag of the container.

Type: null or string

Default: "latest"

Declared by: - https://github.com/imincik/geospatial-nix.env/blob/master/modules/containers.nix

data.fromUrl.enable

Whether to enable fetching file datasets from URL.

Type: boolean

Default: false

Example: true

Declared by: - https://github.com/imincik/geospatial-nix.env/blob/master/modules/data/fromurl.nix

data.fromUrl.datasets

Fetch file datasets from URL. Downloaded data will be available in .devenv/state/data directory.

Type: list of (submodule)

Default: [ ]

Example:

[
  {
    name = "file1.zip";
    url = "https://example.com/data1.zip";
    curlOpts = [ "--basic" "--user" "user:password" ];
    hash = "sha256-+DpaRrk58wEVXaghk1Bp1m1AMmujN+vWZ5oKyH76Gy8=";
  }

  {
    name = "file2.zip";
    url = "https://example.com/data2.zip";
    curlOpts = [ "--basic" "--user" "user:password" ];
    hash = "sha256-2EfwIKA4d39C0DE9lxvjW0vPkj1C65CvG/yrtlDSl8w=";
  }
]

Declared by: - https://github.com/imincik/geospatial-nix.env/blob/master/modules/data/fromurl.nix

data.fromUrl.datasets.*.curlOpts

Additional curl options needed for the download to succeed.

Type: list of string

Default: [ ]

Declared by: - https://github.com/imincik/geospatial-nix.env/blob/master/modules/data/fromurl.nix

data.fromUrl.datasets.*.hash

Dataset file sha256 hash. If no hash is given, it will be computed and printed in the error message.

Type: string

Default: ""

Declared by: - https://github.com/imincik/geospatial-nix.env/blob/master/modules/data/fromurl.nix

data.fromUrl.datasets.*.name

The name of the output file. If no name is given, url basename is used.

Type: string

Default: ""

Declared by: - https://github.com/imincik/geospatial-nix.env/blob/master/modules/data/fromurl.nix

data.fromUrl.datasets.*.url

Dataset URL.

Type: string

Default: ""

Declared by: - https://github.com/imincik/geospatial-nix.env/blob/master/modules/data/fromurl.nix

data.fromUrl.usageHint

Whether to show usage hint.

Type: boolean

Default: true

Declared by: - https://github.com/imincik/geospatial-nix.env/blob/master/modules/data/fromurl.nix

devcontainer.enable

Whether to enable generation .devcontainer.json for devenv integration.

Type: boolean

Default: false

Example: true

Declared by: - https://github.com/imincik/geospatial-nix.env/blob/master/modules/integrations/devcontainer.nix

devcontainer.settings

Devcontainer settings.

Type: JSON value

Default: { }

Declared by: - https://github.com/imincik/geospatial-nix.env/blob/master/modules/integrations/devcontainer.nix

devcontainer.settings.customizations.vscode.extensions

List of preinstalled VSCode extensions.

Type: list of string

Default:

[
  "mkhl.direnv"
]

Declared by: - https://github.com/imincik/geospatial-nix.env/blob/master/modules/integrations/devcontainer.nix

devcontainer.settings.image

The name of an image in a container registry.

Type: string

Default: "ghcr.io/cachix/devenv:latest"

Declared by: - https://github.com/imincik/geospatial-nix.env/blob/master/modules/integrations/devcontainer.nix

devcontainer.settings.overrideCommand

Override the default command.

Type: anything

Default: false

Declared by: - https://github.com/imincik/geospatial-nix.env/blob/master/modules/integrations/devcontainer.nix

devcontainer.settings.updateContentCommand

Command to run after container creation.

Type: anything

Default: "devenv ci"

Declared by: - https://github.com/imincik/geospatial-nix.env/blob/master/modules/integrations/devcontainer.nix

devenv.debug

Whether to enable debug mode of devenv enterShell script.

Type: boolean

Default: false

Example: true

Declared by: - https://github.com/imincik/geospatial-nix.env/blob/master/modules/debug.nix

enterShell

Bash code to execute when entering the shell.

Type: strings concatenated with “\n”

Default: ""

Declared by: - https://github.com/imincik/geospatial-nix.env/blob/master/modules/top-level.nix

env

Environment variables to be exposed inside the developer environment.

Type: lazy attribute set of anything

Default: { }

Declared by: - https://github.com/imincik/geospatial-nix.env/blob/master/modules/top-level.nix

infoSections

Information about the environment

Type: attribute set of list of string

Default: { }

Declared by: - https://github.com/imincik/geospatial-nix.env/blob/master/modules/info.nix

languages.c.enable

Whether to enable tools for C development.

Type: boolean

Default: false

Example: true

Declared by: - https://github.com/imincik/geospatial-nix.env/blob/master/modules/languages/c.nix

languages.cplusplus.enable

Whether to enable tools for C++ development.

Type: boolean

Default: false

Example: true

Declared by: - https://github.com/imincik/geospatial-nix.env/blob/master/modules/languages/cplusplus.nix

languages.elm.enable

Whether to enable tools for Elm development.

Type: boolean

Default: false

Example: true

Declared by: - https://github.com/imincik/geospatial-nix.env/blob/master/modules/languages/elm.nix

languages.go.enable

Whether to enable tools for Go development.

Type: boolean

Default: false

Example: true

Declared by: - https://github.com/imincik/geospatial-nix.env/blob/master/modules/languages/go.nix

languages.go.package

The Go package to use.

Type: package

Default: pkgs.go

Declared by: - https://github.com/imincik/geospatial-nix.env/blob/master/modules/languages/go.nix

languages.julia.enable

Whether to enable tools for Julia development.

Type: boolean

Default: false

Example: true

Declared by: - https://github.com/imincik/geospatial-nix.env/blob/master/modules/languages/julia.nix

languages.julia.package

The Julia package to use.

Type: package

Default: pkgs.julia-bin

Declared by: - https://github.com/imincik/geospatial-nix.env/blob/master/modules/languages/julia.nix

languages.nix.enable

Whether to enable tools for Nix development.

Type: boolean

Default: false

Example: true

Declared by: - https://github.com/imincik/geospatial-nix.env/blob/master/modules/languages/nix.nix

languages.nix.lsp.package

The LSP package to use

Type: package

Default: pkgs.nil

Declared by: - https://github.com/imincik/geospatial-nix.env/blob/master/modules/languages/nix.nix

languages.python.enable

Whether to enable tools for Python development.

Type: boolean

Default: false

Example: true

Declared by: - https://github.com/imincik/geospatial-nix.env/blob/master/modules/languages/python.nix

languages.python.package

The Python package to use.

Type: package

Default: pkgs.python3

Declared by: - https://github.com/imincik/geospatial-nix.env/blob/master/modules/languages/python.nix

languages.python.poetry.enable

Whether to enable poetry.

Type: boolean

Default: false

Example: true

Declared by: - https://github.com/imincik/geospatial-nix.env/blob/master/modules/languages/python.nix

languages.python.poetry.package

The Poetry package to use.

Type: package

Default: pkgs.poetry

Declared by: - https://github.com/imincik/geospatial-nix.env/blob/master/modules/languages/python.nix

languages.python.poetry.activate.enable

Whether to enable activate the poetry virtual environment automatically.

Type: boolean

Default: false

Example: true

Declared by: - https://github.com/imincik/geospatial-nix.env/blob/master/modules/languages/python.nix

languages.python.poetry.install.enable

Whether to enable poetry install during devenv initialisation.

Type: boolean

Default: false

Example: true

Declared by: - https://github.com/imincik/geospatial-nix.env/blob/master/modules/languages/python.nix

languages.python.poetry.install.allExtras

Whether to install all extras. See --all-extras.

Type: boolean

Default: false

Declared by: - https://github.com/imincik/geospatial-nix.env/blob/master/modules/languages/python.nix

languages.python.poetry.install.extras

Which extras to install. See --extras.

Type: list of string

Default: [ ]

Declared by: - https://github.com/imincik/geospatial-nix.env/blob/master/modules/languages/python.nix

languages.python.poetry.install.groups

Which dependency-groups to install. See --with.

Type: list of string

Default: [ ]

Declared by: - https://github.com/imincik/geospatial-nix.env/blob/master/modules/languages/python.nix

languages.python.poetry.install.installRootPackage

Whether the root package (your project) should be installed. See --no-root

Type: boolean

Default: false

Declared by: - https://github.com/imincik/geospatial-nix.env/blob/master/modules/languages/python.nix

languages.python.poetry.install.quiet

Whether poetry install should avoid outputting messages during devenv initialisation.

Type: boolean

Default: false

Declared by: - https://github.com/imincik/geospatial-nix.env/blob/master/modules/languages/python.nix

languages.r.enable

Whether to enable tools for R development.

Type: boolean

Default: false

Example: true

Declared by: - https://github.com/imincik/geospatial-nix.env/blob/master/modules/languages/r.nix

languages.r.package

The R package to use.

Type: package

Default: pkgs.R

Declared by: - https://github.com/imincik/geospatial-nix.env/blob/master/modules/languages/r.nix

languages.rust.enable

Whether to enable tools for Rust development.

Type: boolean

Default: false

Example: true

Declared by: - https://github.com/imincik/geospatial-nix.env/blob/master/modules/languages/rust.nix

languages.rust.channel

The rustup toolchain to install.

Type: one of “nixpkgs”, “stable”, “beta”, “nightly”

Default: "nixpkgs"

Declared by: - https://github.com/imincik/geospatial-nix.env/blob/master/modules/languages/rust.nix

languages.rust.components

List of Rustup components to install. Defaults to those available in nixpkgs.

Type: list of string

Default: [ "rustc" "cargo" "clippy" "rustfmt" "rust-analyzer" ]

Declared by: - https://github.com/imincik/geospatial-nix.env/blob/master/modules/languages/rust.nix

languages.rust.toolchain

Rust component packages. May optionally define additional components, for example miri.

Type: attribute set of package

Default: nixpkgs

Declared by: - https://github.com/imincik/geospatial-nix.env/blob/master/modules/languages/rust.nix

languages.rust.toolchain.cargo

cargo package

Type: null or package

Default: pkgs.cargo

Declared by: - https://github.com/imincik/geospatial-nix.env/blob/master/modules/languages/rust.nix

languages.rust.toolchain.clippy

clippy package

Type: null or package

Default: pkgs.clippy

Declared by: - https://github.com/imincik/geospatial-nix.env/blob/master/modules/languages/rust.nix

languages.rust.toolchain.rust-analyzer

rust-analyzer package

Type: null or package

Default: pkgs.rust-analyzer

Declared by: - https://github.com/imincik/geospatial-nix.env/blob/master/modules/languages/rust.nix

languages.rust.toolchain.rustc

rustc package

Type: null or package

Default: pkgs.rustc

Declared by: - https://github.com/imincik/geospatial-nix.env/blob/master/modules/languages/rust.nix

languages.rust.toolchain.rustfmt

rustfmt package

Type: null or package

Default: pkgs.rustfmt

Declared by: - https://github.com/imincik/geospatial-nix.env/blob/master/modules/languages/rust.nix

languages.shell.enable

Whether to enable tools for shell development.

Type: boolean

Default: false

Example: true

Declared by: - https://github.com/imincik/geospatial-nix.env/blob/master/modules/languages/shell.nix

name

Name of the project.

Type: null or string

Default: "my-project"

Declared by: - https://github.com/imincik/geospatial-nix.env/blob/master/modules/top-level.nix

nixgl.enable

Whether to enable OpenGL support using NixGL wrapper.

Type: boolean

Default: false

Example: true

Declared by: - https://github.com/imincik/geospatial-nix.env/blob/master/modules/integrations/nixgl.nix

nixgl.package

nixGL package to use.

Type: package

Default: pkgs.nixGL

Declared by: - https://github.com/imincik/geospatial-nix.env/blob/master/modules/integrations/nixgl.nix

nixgl.usageHint

Whether to show nixGL usage hint.

Type: boolean

Default: true

Declared by: - https://github.com/imincik/geospatial-nix.env/blob/master/modules/integrations/nixgl.nix

process.after

Bash code to execute after stopping processes.

Type: strings concatenated with “\n”

Default: ""

Declared by: - https://github.com/imincik/geospatial-nix.env/blob/master/modules/processes.nix

process.before

Bash code to execute before starting processes.

Type: strings concatenated with “\n”

Default: ""

Declared by: - https://github.com/imincik/geospatial-nix.env/blob/master/modules/processes.nix

process.implementation

The implementation used when performing devenv up.

Type: one of “honcho”, “process-compose”

Default: "honcho"

Example: "overmind"

Declared by: - https://github.com/imincik/geospatial-nix.env/blob/master/modules/processes.nix

process.process-compose

Top-level process-compose.yaml options when that implementation is used.

Type: attribute set

Default:

{
  port = 9999;
  tui = true;
  version = "0.5";
}

Example:

{
  log_level = "fatal";
  log_location = "/path/to/combined/output/logfile.log";
  version = "0.5";
}

Declared by: - https://github.com/imincik/geospatial-nix.env/blob/master/modules/processes.nix

process-managers.honcho.enable

Whether to enable honcho as process-manager.

Type: boolean

Default: false

Example: true

Declared by: - https://github.com/imincik/geospatial-nix.env/blob/master/modules/process-managers/honcho.nix

process-managers.honcho.package

The honcho package to use.

Type: package

Default: pkgs.honcho

Declared by: - https://github.com/imincik/geospatial-nix.env/blob/master/modules/process-managers/honcho.nix

process-managers.process-compose.enable

Whether to enable process-compose as process-manager.

Type: boolean

Default: false

Example: true

Declared by: - https://github.com/imincik/geospatial-nix.env/blob/master/modules/process-managers/process-compose.nix

process-managers.process-compose.package

The process-compose package to use.

Type: package

Default: pkgs.process-compose

Declared by: - https://github.com/imincik/geospatial-nix.env/blob/master/modules/process-managers/process-compose.nix

process-managers.process-compose.settings

process-compose.yaml specific process attributes.

Example: https://github.com/F1bonacc1/process-compose/blob/main/process-compose.yaml`

Type: YAML value

Default: { }

Example:

{
  availability = {
    backoff_seconds = 2;
    max_restarts = 5;
    restart = "on_failure";
  };
  depends_on = {
    some-other-process = {
      condition = "process_completed_successfully";
    };
  };
  environment = [
    "ENVVAR_FOR_THIS_PROCESS_ONLY=foobar"
  ];
}

Declared by: - https://github.com/imincik/geospatial-nix.env/blob/master/modules/process-managers/process-compose.nix

processes

Processes can be started with devenv up and run in foreground mode.

Type: attribute set of (submodule)

Default: { }

Declared by: - https://github.com/imincik/geospatial-nix.env/blob/master/modules/processes.nix

processes.\.exec

Bash code to run the process.

Type: string

Declared by: - https://github.com/imincik/geospatial-nix.env/blob/master/modules/processes.nix

processes.\.process-compose

process-compose.yaml specific process attributes.

Example: https://github.com/F1bonacc1/process-compose/blob/main/process-compose.yaml`

Only used when using process.implementation = "process-compose";

Type: attribute set

Default: { }

Example:

{
  availability = {
    backoff_seconds = 2;
    max_restarts = 5;
    restart = "on_failure";
  };
  depends_on = {
    some-other-process = {
      condition = "process_completed_successfully";
    };
  };
  environment = [
    "ENVVAR_FOR_THIS_PROCESS_ONLY=foobar"
  ];
}

Declared by: - https://github.com/imincik/geospatial-nix.env/blob/master/modules/processes.nix

scripts

A set of scripts available when the environment is active.

Type: attribute set of (submodule)

Default: { }

Declared by: - https://github.com/imincik/geospatial-nix.env/blob/master/modules/scripts.nix

scripts.\.description

Description of the script.

Type: string

Default: ""

Declared by: - https://github.com/imincik/geospatial-nix.env/blob/master/modules/scripts.nix

scripts.\.exec

Bash code to execute when the script is run.

Type: string

Declared by: - https://github.com/imincik/geospatial-nix.env/blob/master/modules/scripts.nix

services.jupyter.enable

Whether to enable Jupyter server.

Type: boolean

Default: false

Example: true

Declared by: - https://github.com/imincik/geospatial-nix.env/blob/master/modules/services/jupyter.nix

services.jupyter.package

Which Jupyter package to use.

Type: package

Default: pkgs.python3Packages.jupyterlab;

Declared by: - https://github.com/imincik/geospatial-nix.env/blob/master/modules/services/jupyter.nix

services.jupyter.ip

IP address Jupyter will be listening on.

Type: string

Default: "localhost"

Declared by: - https://github.com/imincik/geospatial-nix.env/blob/master/modules/services/jupyter.nix

services.jupyter.kernels

Declarative kernel configurations.

Kernels can be declared in any language that supports and has the required dependencies to communicate with a Jupyter server. In python’s case, it means that ipykernel package must always be included in the list of packages of the targeted environment.

Type: null or (attribute set of (JSON value))

Default: null

Example:

{
  geospatial =
    let
      env = pkgs.python3.withPackages (p: with p; [
        ipykernel
        pkgs.python3Packages.gdal
        pkgs.python3Packages.geopandas
        pkgs.python3Packages.fiona
        pkgs.python3Packages.rasterio
      ]);
  in
  {
    displayName = "Geospatial Python kernel";
    language = "python";
    argv = [
      "${env.interpreter}"
      "-m"
      "ipykernel_launcher"
      "-f"
      "{connection_file}"
    ];
    logo32 = "${env}/${env.sitePackages}/ipykernel/resources/logo-32x32.png";
    logo64 = "${env}/${env.sitePackages}/ipykernel/resources/logo-64x64.png";
  };

  other =
    let
      env = pkgs.python3.withPackages (p: with p; [
        ipykernel
        pandas
      ]);
  in
  {
    displayName = "Other Python kernel";
    language = "python";
    argv = [
      "${env.interpreter}"
      "-m"
      "ipykernel_launcher"
      "-f"
      "{connection_file}"
    ];
    logo32 = "${env}/${env.sitePackages}/ipykernel/resources/logo-32x32.png";
    logo64 = "${env}/${env.sitePackages}/ipykernel/resources/logo-64x64.png";
  };
}

Declared by: - https://github.com/imincik/geospatial-nix.env/blob/master/modules/services/jupyter.nix

services.jupyter.kernels.\.argv

Command and arguments to start the kernel.

Type: list of string

Example:

[
  "{env.interpreter}"
  "-m"
  "ipykernel_launcher"
  "-f"
  "{connection_file}"
]

Declared by: - https://github.com/imincik/geospatial-nix.env/blob/master/modules/services/jupyter.nix

services.jupyter.kernels.\.displayName

Name that will be shown to the user.

Type: string

Default: ""

Example:

"Python 3 for Data Science"

Declared by: - https://github.com/imincik/geospatial-nix.env/blob/master/modules/services/jupyter.nix

services.jupyter.kernels.\.env

Environment variables to set for the kernel.

Type: attribute set of string

Default: { }

Example:

{
  OMP_NUM_THREADS = "1";
}

Declared by: - https://github.com/imincik/geospatial-nix.env/blob/master/modules/services/jupyter.nix

services.jupyter.kernels.\.extraPaths

Extra paths to link in kernel directory.

Type: attribute set of path

Default: { }

Example: "{ examples = ${env}/${env.sitePackages}/IRkernel/kernelspec/kernel.js"; }

Declared by: - https://github.com/imincik/geospatial-nix.env/blob/master/modules/services/jupyter.nix

services.jupyter.kernels.\.language

Language of the environment. Typically the name of the binary.

Type: string

Example: "python"

Declared by: - https://github.com/imincik/geospatial-nix.env/blob/master/modules/services/jupyter.nix

services.jupyter.kernels.\.logo32

Path to 32x32 logo png.

Type: null or path

Default: null

Example: "${env}/${env.sitePackages}/ipykernel/resources/logo-32x32.png"

Declared by: - https://github.com/imincik/geospatial-nix.env/blob/master/modules/services/jupyter.nix

services.jupyter.kernels.\.logo64

Path to 64x64 logo png.

Type: null or path

Default: null

Example: "${env}/${env.sitePackages}/ipykernel/resources/logo-64x64.png"

Declared by: - https://github.com/imincik/geospatial-nix.env/blob/master/modules/services/jupyter.nix

services.jupyter.port

Port number Jupyter will be listening on.

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

Default: 8888

Declared by: - https://github.com/imincik/geospatial-nix.env/blob/master/modules/services/jupyter.nix

services.jupyter.rawConfig

Raw Jupyter configuration.

Type: strings concatenated with “\n”

Default: ""

Example:

c.ServerApp.answer_yes = False
c.ServerApp.open_browser = False

Declared by: - https://github.com/imincik/geospatial-nix.env/blob/master/modules/services/jupyter.nix

services.pg_featureserv.enable

Whether to enable pg_featureserv service.

Type: boolean

Default: false

Example: true

Declared by: - https://github.com/imincik/geospatial-nix.env/blob/master/modules/services/pg_featureserv.nix

services.pg_featureserv.package

Which pg_featureserv package to use.

Type: package

Default: pkgs.pg_featureserv

Declared by: - https://github.com/imincik/geospatial-nix.env/blob/master/modules/services/pg_featureserv.nix

services.pg_featureserv.postgres.database

PostgreSQL database name.

Type: string

Default: "postgres"

Declared by: - https://github.com/imincik/geospatial-nix.env/blob/master/modules/services/pg_featureserv.nix

services.pg_featureserv.postgres.host

PostgreSQL database host.

Type: null or string

Default: null

Declared by: - https://github.com/imincik/geospatial-nix.env/blob/master/modules/services/pg_featureserv.nix

services.pg_featureserv.postgres.port

PostgreSQL database port.

Type: signed integer

Default: 5432

Declared by: - https://github.com/imincik/geospatial-nix.env/blob/master/modules/services/pg_featureserv.nix

services.pg_featureserv.settings

pg_featureserv configuration. Refer to https://github.com/CrunchyData/pg_featureserv/blob/master/config/pg_featureserv.toml.example for an example.

Type: attribute set

Default: { }

Example:

{
  Server.HttpPort = 9001;
  Paging.LimitMax = 1000;
}

Declared by: - https://github.com/imincik/geospatial-nix.env/blob/master/modules/services/pg_featureserv.nix

services.pg_tileserv.enable

Whether to enable pg_tileserv service.

Type: boolean

Default: false

Example: true

Declared by: - https://github.com/imincik/geospatial-nix.env/blob/master/modules/services/pg_tileserv.nix

services.pg_tileserv.package

Which pg_tileserv package to use.

Type: package

Default: pkgs.pg_tileserv

Declared by: - https://github.com/imincik/geospatial-nix.env/blob/master/modules/services/pg_tileserv.nix

services.pg_tileserv.postgres.database

PostgreSQL database name.

Type: string

Default: "postgres"

Declared by: - https://github.com/imincik/geospatial-nix.env/blob/master/modules/services/pg_tileserv.nix

services.pg_tileserv.postgres.host

PostgreSQL database host.

Type: null or string

Default: null

Declared by: - https://github.com/imincik/geospatial-nix.env/blob/master/modules/services/pg_tileserv.nix

services.pg_tileserv.postgres.port

PostgreSQL database port.

Type: signed integer

Default: 5432

Declared by: - https://github.com/imincik/geospatial-nix.env/blob/master/modules/services/pg_tileserv.nix

services.pg_tileserv.settings

pg_tileserv configuration. Refer to https://github.com/CrunchyData/pg_tileserv/blob/master/config/pg_tileserv.toml.example for an example.

Type: attribute set

Default: { }

Example:

{
  CoordinateSystem = {
    SRID = 3857;
    Xmin = "-20037508.3427892";
    Ymin = "-20037508.3427892";
    Xmax = "20037508.3427892";
    Ymax = "20037508.3427892";
  };
}

Declared by: - https://github.com/imincik/geospatial-nix.env/blob/master/modules/services/pg_tileserv.nix

services.postgres.enable

Whether to enable Add PostgreSQL process. .

Type: boolean

Default: false

Example: true

Declared by: - https://github.com/imincik/geospatial-nix.env/blob/master/modules/services/postgres.nix

services.postgres.package

The PostgreSQL package to use. Use this to override the default with a specific version.

Type: package

Default: pkgs.postgresql

Example:

pkgs.postgresql_15

Declared by: - https://github.com/imincik/geospatial-nix.env/blob/master/modules/services/postgres.nix

services.postgres.createDatabase

Create a database named like current user on startup. Only applies when initialDatabases is an empty list.

Type: boolean

Default: true

Declared by: - https://github.com/imincik/geospatial-nix.env/blob/master/modules/services/postgres.nix

services.postgres.extensions

Additional PostgreSQL extensions to install.

The available extensions are:

• age
• anonymizer
• apache_datasketches
• citus
• cstore_fdw
• h3-pg
• hypopg
• jsonb_deep_sum
• lantern
• periods
• pg_auto_failover
• pg_bigm
• pg_cron
• pg_ed25519
• pg_embedding
• pg_hint_plan
• pg_hll
• pg_ivm
• pg_libversion
• pg_net
• pg_partman
• pg_rational
• pg_relusage
• pg_repack
• pg_roaringbitmap
• pg_safeupdate
• pg_similarity
• pg_squeeze
• pg_topn
• pg_uuidv7
• pgaudit
• pgjwt
• pgroonga
• pgrouting
• pgsodium
• pgsql-http
• pgtap
• pgvecto-rs
• pgvector
• plpgsql_check
• plr
• plv8
• postgis
• promscale_extension
• repmgr
• rum
• smlar
• tds_fdw
• temporal_tables
• timescaledb
• timescaledb-apache
• timescaledb_toolkit
• tsearch_extras
• tsja
• wal2json

Type: null or (function that evaluates to a(n) list of package)

Default: null

Example:

extensions: [
  extensions.pg_cron
  extensions.postgis
  extensions.timescaledb
];

Declared by: - https://github.com/imincik/geospatial-nix.env/blob/master/modules/services/postgres.nix

services.postgres.initdbArgs

Additional arguments passed to initdb during data dir initialisation.

Type: list of strings concatenated with “\n”

Default:

[
  "--locale=C"
  "--encoding=UTF8"
]

Example:

[
  "--data-checksums"
  "--allow-group-access"
]

Declared by: - https://github.com/imincik/geospatial-nix.env/blob/master/modules/services/postgres.nix

services.postgres.initialDatabases

List of database names and their initial schemas that should be used to create databases on the first startup of Postgres. The schema attribute is optional: If not specified, an empty database is created.

Type: list of (submodule)

Default: [ ]

Example:

[
  {
    name = "foodatabase";
    schema = ./foodatabase.sql;
  }
  { name = "bardatabase"; }
]

Declared by: - https://github.com/imincik/geospatial-nix.env/blob/master/modules/services/postgres.nix

services.postgres.initialDatabases.*.name

The name of the database to create.

Type: string

Declared by: - https://github.com/imincik/geospatial-nix.env/blob/master/modules/services/postgres.nix

services.postgres.initialDatabases.*.schema

The initial schema of the database; if null (the default), an empty database is created.

Type: null or path

Default: null

Declared by: - https://github.com/imincik/geospatial-nix.env/blob/master/modules/services/postgres.nix

services.postgres.initialScript

Initial SQL commands to run during database initialization. This can be multiple SQL expressions separated by a semi-colon.

Type: null or string

Default: null

Example:

CREATE ROLE postgres SUPERUSER;
CREATE ROLE bar;

Declared by: - https://github.com/imincik/geospatial-nix.env/blob/master/modules/services/postgres.nix

services.postgres.listen_addresses

Listen address

Type: string

Default: ""

Example: "127.0.0.1"

Declared by: - https://github.com/imincik/geospatial-nix.env/blob/master/modules/services/postgres.nix

services.postgres.port

The TCP port to accept connections.

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

Default: 5432

Declared by: - https://github.com/imincik/geospatial-nix.env/blob/master/modules/services/postgres.nix

services.postgres.settings

PostgreSQL configuration. Refer to https://www.postgresql.org/docs/11/config-setting.html#CONFIG-SETTING-CONFIGURATION-FILE for an overview of postgresql.conf.

String values will automatically be enclosed in single quotes. Single quotes will be escaped with two single quotes as described by the upstream documentation linked above.

Type: attribute set of (boolean or floating point number or signed integer or string)

Default: { }

Example:

{
  log_connections = true;
  log_statement = "all";
  logging_collector = true;
  log_disconnections = true;
  log_destination = lib.mkForce "syslog";
}

Declared by: - https://github.com/imincik/geospatial-nix.env/blob/master/modules/services/postgres.nix

starship.enable

Whether to enable the Starship.rs command prompt.

Type: boolean

Default: false

Example: true

Declared by: - https://github.com/imincik/geospatial-nix.env/blob/master/modules/integrations/starship.nix

starship.package

The Starship package to use.

Type: package

Default: pkgs.starship

Declared by: - https://github.com/imincik/geospatial-nix.env/blob/master/modules/integrations/starship.nix

starship.config.enable

Whether to enable Starship config override.

Type: boolean

Default: false

Example: true

Declared by: - https://github.com/imincik/geospatial-nix.env/blob/master/modules/integrations/starship.nix

starship.config.path

The Starship configuration file to use.

Type: path

Default: ${config.env.DEVENV_ROOT}/starship.toml

Declared by: - https://github.com/imincik/geospatial-nix.env/blob/master/modules/integrations/starship.nix