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/or 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, or 59 files.
  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, depending on the size of the data file) will slow down dictionary
  46 # attacks. Setting to 0 will disable encryption.
  47 #iterations=1
  48
  49 # After the set number of encryption or decryption iterations have been
  50 # processed, a status message with the keyword ENCRYPT or DECRYPT will be
  51 # sent to the client. Set to 0 to 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
  67 # Seconds until the pinentry dialog times out. Set to 0 to wait for input
  68 # forever.
  69 #pinentry_timeout=20
  70
  71 # The default compression level for data files from 1 to 9, 1 being the
  72 # fastest but least compression and 9 being the slowest but best compression.
  73 # To disable compression entirely, set to 0.
  74 #compression_level=6
  75
  76 # The input and output buffer size when compressing and decompressing. This
  77 # affects how often the COMPRESS and DECOMPRESS status messages are sent and
  78 # also affects compression quality. Set to a higher value for larger files.
  79 #zlib_bufsize=65536
  80
  81 # The maximum recursion depth when resolving elements that contain a "target"
  82 # attribute. When this value is exceeded an error will be returned.
  83 #recursion_depth=20
  84
  85 # Sends a KEEPALIVE status message every N seconds. Set to 0 to disable.
  86 #keepalive=30
  87
  88 # The priority or nice value of the server process. The default is inherited
  89 # from the parent process.
  90 #priority=10
  91
  92 # Whether to enable TCP server support. If enabled, both TCP and the local
  93 # unix domain socket will listen for connections.
  94 #enable_tcp=false
  95
  96 # If TCP is enabled, the port to listen on.
  97 #tcp_port=6466
  98
  99 # Only useful if running as root.
 100 #tcp_interface=eth0
 101
 102 # A comma separated list of client x509 certificate fingerprints in MD5 format
 103 # that will be allowed to open a file. If prefixed with !, access is denied
 104 # for the connected client. The access control is for filenames and this
 105 # option can be in either the global section or a defined filename section. If
 106 # not found in either then access will be granted. If defined but empty then
 107 # access will be denied.
 108 #tcp_access=
 109
 110 # Require the client to provide the key to open a file even if the file is
 111 # cached.
 112 #tcp_require_key=false
 113
 114 # The time in tenths of a second to wait for a new TCP connection.  Setting to
 115 # 0 will disable waiting.
 116 #tcp_wait=3
 117
 118 # END GLOBAL SETTINGS
 119
 120 # File specific settings are allowed by placing the filename in braces. Each
 121 # file can have it's own configuration settings from those listed below.
 122 #[somefile]
 123 #cache_timeout=300
 124 #iteration_progress=0
 125 #key=password
 126 #key_file=/path/to/file.key
 127 #compression_level=0
 128 #enable_pinentry=true
 129 #pinentry_timeout=20
 130 #backup=true
 131 #tcp_access=some_md5_hash