doc/config.example

   1 # Example PWMD configuration file. Edit and save to ~/.pwmd/config or
   2 # specify with the -f command line option. See the pwmd(1) manual page for
   3 # complete details of the options.
   4 #
   5 # The global section is for non-file related settings and defaults for data
   6 # files without a file section.
   7 [global]
   8
   9 # Location of the listening socket.
  10 #socket_path=~/.pwmd/socket
  11
  12 # Socket permissions. This will override any umask setting.
  13 #socket_perms=0600
  14
  15 # Usernames or groups obtained via SO_PEERCRED which are allowed to
  16 # connect to the socket. Groups should be prefixed with a '@'. When not
  17 # specified only the invoking user is allowed.
  18 #allowed = username,another_user,@group
  19
  20 # Where data files will be read and stored.
  21 #data_directory=~/.pwmd/data
  22
  23 # When false, disable keeping backups for data files.
  24 #backup=true
  25
  26 # Log file location.
  27 #log_path=~/.pwmd/log
  28
  29 # Set to true to enable logging to log_path.
  30 #enable_logging=false
  31
  32 # Set to true to enable logging to syslog.
  33 #syslog=false
  34
  35 # The logging level: 0=connections and errors, 1=client commands, 2=client
  36 # commands with command arguments.
  37 #log_level=0
  38
  39 # When set, enable protocol debugging to the specified file. Note that this
  40 # logs all protocol IO so it may also log sensitive data.
  41 #debug_file=~/pwmd.log
  42
  43 # Set to false to call mlockall(2) after a client connects. Uses alot more
  44 # memory but is also more secure. Most will probably find it overkill since
  45 # the contents of all memory is cleared before being freed. Note that this
  46 # doesn't affect the file cache which is always stored in RAM (if possible).
  47 #disable_mlockall=true
  48
  49 # Disable the XPATH, LIST and DUMP commands. When "true" and a client sends
  50 # these commands the error GPG_ERR_NOT_IMPLEMENTED will be returned.
  51 #disable_list_and_dump=false
  52
  53 # The number of encryption iterations for new files. This is the number of
  54 # times the data will be encrypted. Setting this to a high value (10000 or
  55 # more, depending on the size of the data file) will slow down dictionary
  56 # attacks. Setting to 0 will disable encryption.
  57 #iterations=1
  58
  59 # After the set number of encryption or decryption iterations have been
  60 # processed, a status message with the keyword ENCRYPT or DECRYPT will be
  61 # sent to the client. Set to 0 to disable.
  62 #iteration_progress=0
  63
  64 # When sending data to the client an XFER status message will be sent after
  65 # N bytes. N is rounded to ASSUAN_LINELENGTH (1002) bytes.
  66 #xfer_progress=8196
  67
  68 # A list of filenames separated by commas to add to the file cache upon
  69 # startup. You will be prompted for the key for each file if required. The
  70 # files are looked for in data_directory.
  71 #cache_push=somefile,anotherfile
  72
  73 # The number of seconds to keep a file in the cache. If -1, the file will be
  74 # kept forever. If 0 then every OPEN and SAVE command will require a key.
  75 #cache_timeout=-1
  76
  77 # Set to false to disable use of pinentry to retrieve keys.
  78 #enable_pinentry=true
  79
  80 # The full path to the pinentry binary. The default is specified at compile
  81 # time.
  82 #pinentry_path=/usr/bin/pinentry
  83
  84 # Seconds until the pinentry dialog times out. Set to 0 to wait for input
  85 # forever.
  86 #pinentry_timeout=20
  87
  88 # The default compression level for data files from 1 to 9, 1 being the
  89 # fastest but least compression and 9 being the slowest but best compression.
  90 # To disable compression entirely, set to 0.
  91 #compression_level=6
  92
  93 # The input and output buffer size when compressing and decompressing. This
  94 # affects how often the COMPRESS and DECOMPRESS status messages are sent and
  95 # also affects compression quality. Set to a higher value for larger files.
  96 #zlib_bufsize=65536
  97
  98 # The maximum recursion depth when resolving elements that contain a "target"
  99 # attribute. When this value is exceeded an error will be returned.
 100 #recursion_depth=100
 101
 102 # The priority or nice value of the server process. The default is inherited
 103 # from the parent process.
 104 #priority=10
 105
 106 # The cipher to use for newly created files.
 107 #cipher=aes256
 108
 109 # END GLOBAL SETTINGS
 110
 111 # File specific settings are allowed by placing the filename in braces. Each
 112 # file can have it's own configuration settings from those listed below.
 113 #[somefile]
 114 #cache_timeout=300
 115 #iteration_progress=0
 116 #key=password
 117 #key_file=/path/to/file.key
 118 #compression_level=0
 119 #enable_pinentry=true
 120 #pinentry_timeout=20
 121 #backup=true