Useful volume settings#

Note

This new documentation page has not yet been fully reviewed and may be incomplete.

When deploying LinkAhead with docker compose, these mount targets are relevant. Where the mount type is volume, the default volume name is given as source. When the mount type is bind, the source is the name of the environment variable which can be used in the compose file templates.

Persistent data#

Local files

target: /opt/caosdb/mnt/caosroot
source: caosdb-caosroot
type: volume
enabled: true

Here LinkAhead stores those files which are uploaded directly (for example through the web interface or over the API).

Configuration#

LinkAhead server config

target: /opt/caosdb/git/caosdb-server/conf/ext
source: LINKAHEAD_SERVER_CONF
type: bind

Server configuration files. See Server configuration document for a detailed description.

LinkAhead web interface config

target: /opt/caosdb/git/caosdb-server/caosdb-webui/conf/ext
source: LINKAHEAD_WEBUI_CONF
type: bind

WebUI configuration files. See the configuration of property display in the WebUI for an example.

LinkAhead web interface build properties

target: /opt/caosdb/mnt/caosdb-server/caosdb-webui/build_properties.d
source: LINKAHEAD_WEBUI_BUILD_PROPERTIES
type: bind

Directory with WebUI build property files. See the WebUI installation guide for a detailed description.

SSL certificate

target: /opt/caosdb/cert
source: LINKAHEAD_SERVER_CERT
type: bind

SSL files for the LinkAhead server.

LinkAhead server side scripting binaries

target: /opt/caosdb/git/caosdb-server/scripting/bin
source: LINKAHEAD_SERVER_SCRIPTING_BIN
type: bind

Directory with server-side scripting binaries.

Mail server config

target: /opt/caosdb/mnt/other/mail.cf
source: LINKAHEAD_MAIL_CF
type: bind

Configuration of the postfix mail server.

LDAP configuration: nslcd

target: /opt/caosdb/mnt/other/nslcd.conf
source: LINKAHEAD_NSLCD_CONF
type: bind

LDAP configuration.

LDAP configuration: LinkAhead server

target: /opt/caosdb/git/caosdb-server/misc/pam_authentication/ldap.env
source: LINKAHEAD_SERVER_LDAP_ENV
type: bind

LDAP configuration for the LinkAhead server.

MariaDB backend server configuration

target: /etc/mysql/mariadb.conf.d
source: LINKAHEAD_MARIADB_CONF_D
type: bind
service: sqldb

Configuration directory for the MariaDB server. See the upstream documentation for a detailed description.

Customization#

LinkAhead web interface customization: sources

target: /opt/caosdb/git/caosdb-server/caosdb-webui/src/conf/ext
source: LINKAHEAD_WEBUI_SRC
type: bind

Custom source files for the WebUI.

LinkAhead web interface customization: public files

target: /opt/caosdb/git/caosdb-server/caosdb-webui/public/ext
source: LINKAHEAD_WEBUI_PUBLIC_CONF
type: bind

Customization of the WebUI public files.

LinkAhead web interface customization: test files

target: /opt/caosdb/git/caosdb-server/caosdb-webui/test/ext
source: LINKAHEAD_WEBUI_TEST
type: bind

Customization of the WebUI tests.

Other volumes#

Temporary files

target: /opt/caosdb/mnt/tmpfiles
source: caosdb-tmpfiles
type: volume
enabled: true

Temporary files created by the server.

LinkAhead server authentication tokens

target: /opt/caosdb/git/caosdb-server/authtoken
source: LINKAHEAD_SERVER_AUTHTOKEN
type: bind
mode: rw

Directory where the server may write authentication tokens.

LinkAhead server side scripting binaries, for debugging

target: /opt/caosdb/git/caosdb-server/scripting/bin-debug
source: LINKAHEAD_SERVER_SCRIPTING_BIN_DEBUG
type: bind

Directory with binaries, used for example by the Python integration tests.