codchi.enableRecommendedConfig
Whether to enable recommended NixOS options.
Type: boolean
Default:true
Example:true
Declared by:
codchi.docker.enable
Whether to enable the docker daemon. This also adds the codchi user to the docker group and installs docker-compose.
Type: boolean
Default:false
Declared by:
codchi.docker.enableNvidia
Whether to install nvidia-container-toolkit to enable GPU usage inside docker containers.
This requires setting codchi.gpu.enable = true and nixpkgs.config.allowUnfree = true.
Type: boolean
Default:false
Declared by:
codchi.gpu.enable
Whether to enable OpenGL / GPU driver from the host.
Type: boolean
Default:true
Example:true
Declared by:
codchi.initScript
A bash script which will run once on machine creation (init or clone) as the default codchi user. Afterwards it can be run manually via codchi-init.
To override the default welcome message use lib.mkForce.
Type: null or strings concatenated with “\n”
Default:
''
echo -e "❄️ Welcome to your new code machine $CODCHI_MACHINE_NAME! ❄️"
echo
echo -e "To get started with \e[1;36mCodchi\e[0m, read the docs at <https://codchi.dev/>."
echo -e "If you encounter problems please open an issue at <https://github.com/aformatik/codchi/issues>."
echo
''
Example:
''
cd $HOME
git clone https://github.com/my/cool-repo
''
Declared by:
codchi.keyring.enable
Whether to enable a keyring for applications like IntelliJ.
Type: boolean
Default:false
Example:true
Declared by:
codchi.secrets.env
Secrets / variables which must be set by each Codchi user. They will be
available in each shell session, prefixed by CODCHI_, inside this code
machine, so don’t use this for super sensitive secrets.
Possible use cases:
- GitHub / GitLab tokens for automatic git setup / repo cloning
Type: attribute set of (submodule)
Default:{ }
Example:
{
# Will be available as $CODCHI_GITLAB_TOKEN
GITLAB_TOKEN = {
description = ''
Access token with read_api, read_repository & write_repository scopes.
Can be created here: <https://gitlab.example.com/-/user_settings/personal_access_tokens>.
Syntax: `oauth2:glpat-XXXXXXXXXXXXXXXXXXXX`.
'';
};
}
Declared by:
codchi.secrets.env.<name>.description
A short text describing what this secret is used for and how it should be obtained.
This will be shown to the user during codchi rebuild.
Type: strings concatenated with “\n”
Declared by:
codchi.secrets.env.<name>.name
Name of this environment variable. Will be prefixed by CODCHI_.
Type: string matching the pattern ^[a-zA-Z0-9:_\.-]*$
Default:"‹name›"
Declared by:
programs.java.packages
List of JDKs which should be symlinked to ~/.jdks (for IDEs lik IntelliJ).
Type: attribute set of package
Default:{ }
Example:
{
openjdk19 = pkgs.jdk19;
}
Declared by: