doc/config.example

   1 #
   2 # Example PWMD configuration file. Edit and save to ~/.pwmd/config or
   3 # specify with the -f command line option.
   4 #
   5 # The global section is for non-file related settings and file defaults.
   6 [global]
   7
   8 # Location of the listening socket.
   9 #socket_path=~/.pwmd/socket
  10
  11 # Socket permissions. This will override any umask setting.
  12 #socket_perms=0600
  13
  14 # Where data files will be read and stored.
  15 #data_directory=~/.pwmd/data
  16
  17 # If false, disable keeping backups for data files.
  18 #backup=true
  19
  20 # Log file location.
  21 #log_path=~/.pwmd/log
  22
  23 # Set to true to enable logging to log_path.
  24 #enable_logging=false
  25
  26 # Set to true to enable logging to syslog.
  27 #syslog=false
  28
  29 # File and key cache size. Must be in multiples of your systems PAGE_SIZE. The
  30 # default below on a x86 Linux system is one page.
  31 #cache_size=4096
  32
  33 # Set to false to call mlockall(2) after a client connects. Uses alot more
  34 # memory but is also more secure. Most will probably find it overkill since
  35 # the contents of all memory is cleared before being freed. Note that this
  36 # doesn't affect the file cache which is always stored in RAM (if possible).
  37 #disable_mlockall=true
  38
  39 # Disable the LIST and DUMP commands. When "true" and a client sends these
  40 # commands an error GPG_ERR_NOT_IMPLEMENTED will be returned.
  41 #disable_list_and_dump=false
  42
  43 # The number of encryption iterations for new files. This is the number of
  44 # times the data will be encrypted. Setting this to a high value (10000 or
  45 # more) will slow down dictionary attacks. Setting to -1 will disable
  46 # encryption.
  47 #iterations=0
  48
  49 # After the set number of encryption or decryption iterations, a status
  50 # message with the keyword ENCRYPT or DECRYPT will be sent. Set to 0 to
  51 # disable.
  52 #iteration_progress=0
  53
  54 # A list of filenames separated by commas to add to the file cache upon
  55 # startup. You will be prompted for the key for each file if required. The
  56 # files are looked for in data_directory.
  57 #cache_push=somefile, anotherfile
  58
  59 # The number of seconds to keep a file in the cache. If -1, the file will be
  60 # kept forever. If 0, then every OPEN and SAVE command will require a key.
  61 #cache_timeout=-1
  62
  63 # Set to false to disable use of pinentry to retrieve keys.
  64 #enable_pinentry=true
  65
  66 # The default compression level for data files from 1 to 9, 1 being the
  67 # fastest but least compression and 9 being the slowest but best compression.
  68 # To disable compression entirely, set to 0.
  69 #compression_level=6
  70
  71 # The input and output buffer size when compressing and decompressing. This
  72 # affects how often the COMPRESS and DECOMPRESS status messages are sent and
  73 # also affects compression quality. Set to a higher value for larger files.
  74 #zlib_bufsize=65536
  75
  76 # The maximum recursion depth when resolving elements that contain a "target"
  77 # attribute. When this value is exceeded an error will be returned.
  78 #recursion_depth=20
  79
  80 # Sends a KEEPALIVE status message every N seconds. Set to 0 to disable.
  81 #keepalive=30
  82
  83 # END GLOBAL SETTINGS
  84
  85 # File specific settings are allowed by placing the filename in braces. Each
  86 # file can have it's own configuration settings from those listed below.
  87 #[somefile]
  88 #cache_timeout=300
  89 #iteration_progress=0
  90 #key=password
  91 #key_file=/path/to/file.key
  92 #compression_level=0
  93 #enable_pinentry=true
  94 #backup=true