NAME

~/.config/littlejet/config.conf — Configuration parameters for LittleJet

DESCRIPTION

The littlejet(1) utility uses some defaults that are safe for most environments, but you can change any parameters described below to adapt it to your needs. ~/.config/littlejet/config.conf is a file that contains the parameters that control the operation of littlejet(1). Note that this file is an sh(1) script.

PATH PARAMETERS

PREFIX: Root prefix used by other directories.
Default: /usr/local

SYSTEM DIRECTORIES PARAMETERS

SHAREDIR

Location of shared files.

FILESDIR

Location of files used by LittleJet.

Default: ${SHAREDIR}/files

DATADIR

Location of files generated by LittleJet.

This is currently not used except as a shortcut for other parameters. See LITTLEJETDIR which does perform this function.

Default: ${PREFIX}/littlejet

LIB_SUBR

Subroutines primarily used by RunScripts.

Default: ${FILESDIR}/lib.subr

USER DIRECTORIES PARAMETERS

LITTLEJETDIR

Location of files generated by LittleJet.

Default: ${HOMEDIR}/.littlejet

PROJECTSDIR

Location of projects.

Default: ${LITTLEJETDIR}/projects

RUNSCRIPTS

Space-separated list of directories where RunScripts are located.

Note that this works similarly to the PATH environment variable, where the first match wins. This is very useful when you want to use your own RunScript that has the same name as the one shipped by LittleJet. Of course, this is a double-edged sword: if you have scripts that depend on specific parameters or some specific behavior that your RunScript doesn't provide, those scripts can and probably will fail.

Default: ${LITTLEJETDIR}/runscripts ${SHAREDIR}/runscripts

SOCKETSDIR

Location of SSH sockets when multiplexing.

Default: ${LITTLEJETDIR}/sockets

NODESDIR

Location of nodes.

Default: ${LITTLEJETDIR}/nodes

SSH-RELATED PARAMETERS

CONTROLPATH: See ControlPath in ssh_config(5).
Default: %r.%h.%p
CONTROLPERSIST: See ControlPersist in ssh_config(5).
Default: 8m
CPIGNORE: Exclusion file used by cpdup(1).
Default: ${FILESDIR}/cpignore

LOGGING PARAMETERS

DEBUG: Enable debug level.
Default: NO
SSH_LOGLEVEL: See LogLevel in ssh_config(5).
Default: ERROR

REMOTE PARAMETERS

REMOTE_DATADIR: Location of files generated by LittleJet on the remote system.
Default: ${DATADIR}
REMOTE_PROJECTSDIR: Location of projects that are uploaded by LittleJet to the remote system.
Default: ${REMOTE_DATADIR}/projects

MULTI-PROCESSING PARAMETERS

NCPU: Maximum number of jobs running at the same time.

INTERFACE PARAMETERS

SHOW_HEALTHCHECKERS: Displays the healthcheckers when the jail has one or more defined.
Default: 0
SHOW_LIMITS: Displays the limits when the jail has one or more defined.
Default: 0
SHOW_STATS: Displays the stats of each jail when the system has rctl(8) enabled.
Default: 0

AUTHORS

Jesús Daniel Colmenares Oviedo <DtxdF@disroot.org>