Config

Config

Configuration file for puddle :smile:.

Source:

Members

databaseDir :string

Directory where puddles database will be stored.

This should be a path to an empty directory for when puddle is first started.

Source:
Type:
  • string

secret :string

Used for signing encrypted transactions by the server. Should ideally be a suitably long string of random alphanumeric characters.

For unix users, you can generate such a string by using the following shell snippet:

cat /dev/random | tr -C -d '[:alnum:]' | head -c 256 | clip
Source:
Type:
  • string

serverHost :string

The host address on which puddles server should be bound.

Source:
Type:
  • string

serverPort :number

The port on which puddles server should be bound.

Source:
Type:
  • number

sessionPath :string

Directory where user session data will be stored. Should ideally be relative to the root of the users directory.

Source:
Type:
  • string

theme :Theme

Look and feel configuration for puddle. This value assigns the colors used by puddles frontend client.

Source:
Type:
  • Theme