//Cloudogu EcoSystem Docs

Dogu Configuration

Custom configuration settings are stored in the registry (etcd) of the Cloudogu EcoSystem. There are two keys that are relevant for a dogu:

  • /config/nameOfDogu (dogu specific settings)
  • /config/_global (global settings)


A dogu is able to retrieve this settings with the doguctl command line util e.g.:

# read setting test from /config/conf-dogu/title
doguctl config title

# read encrypted setting secret from /config/conf-dogu/secret
doguctl config -e secret

# read global setting admin_group from /config/_global/admin_group
doguctl config -g admin_group


Starting with version 0.14, the cesapp is able to validate those settings, if the dogu defines a configuration section in the dogu.json e.g.:

  "Name": "sample/conf-dogu",
  "Version": "0.1.0",
  "DisplayName": "Conf Dogu",
  "Description": "Dogu with configuration",
  "Image": "registry.cloudogu.com/sample/conf-dogu",
  "URL": "https://cloudogu.com",
  "Configuration": [{
    "Name": "title",
    "Description": "Title of index page"
  }, {
    "Name": "secret",
    "Description": "Encrypted secret",
    "Encrypted": true
  }, {
    "Name": "body",
    "Description": "Body of the index page",
    "Optional": true

The cesapp will throw an error, if a required settings is missing in the registry. Required settings are all settings, that are not explicitly marked as optional (like title and secret in the example above).


The settings of a dogu can be changed or created with the edit-config sub comand of the cesapp. The command can be used with either

  • a path to a dogu.json
  • the name of a installed dogu
  • a remote name


# edit settings of a local dogu.json which is located in /vagrant/containers/conf-dogu
cesapp edit-config /vagrant/containers/conf-dogu

# edit settings of local /vagrant/containers/conf-dogu/dogu.json
cesapp edit-config /vagrant/containers/conf-dogu/dogu.json

# edit settings of a remote json
cesapp edit-config sample/conf-dogu

# edit settings of a installed dogu
cesapp edit-config conf-dogu

Removing a setting

By default, settings can only be changed but cannot be removed. In case you want to explicitly remove a setting from the registry, the edit-config sub command, must be used with the delete-on-empty and an empty value.

cesapp edit-config --delete-on-empty conf-dogu

Now, if the configuration value being entered is empty, the setting will be removed from the registry.