doc/sysdbd-store-network.5.txt

   1 sysdbd-store-network(5)
   2 =======================
   3 :doctype: manpage
   4
   5 NAME
   6 ----
   7 sysdbd-store-network - store::network plugin sending to remote instances
   8
   9 SYNOPSIS
  10 --------
  11   LoadPlugin "store::network"
  12
  13   <Plugin "store::network">
  14       <Server "some.host.name:12345">
  15           Username "my.host.name"
  16           SSLCertificate "/etc/sysdb/ssl/cert.pem"
  17           SSLCertificateKey "/etc/sysdb/ssl/key.pem"
  18           SSLCACertificates "/etc/ssl/certs/ca-certificates.crt"
  19       </Server>
  20   </Plugin>
  21
  22 DESCRIPTION
  23 -----------
  24 *store::network* is a plugin which connects to a remote SysDB instance and
  25 sends all locally collected stored objects to that instance. It uses the
  26 low-level binary protocol to efficiently transmit the data.
  27
  28 CONFIGURATION
  29 -------------
  30 *store::network* accepts the following configuration options:
  31
  32 *Server* '<address>'::
  33         A server block specifies the connection settings. Multiple servers may be
  34         specified to send all data to multiple instances. The specified
  35         '<address>' may be a local path-name of a UNIX domain socket, a hostname,
  36         an IPv4 address, or and IPv6 address along with the remote port, separated
  37         by a colon (":").
  38         +
  39         All TCP connections are encrypted with SSL/TLS. See the *SSL*
  40         configuration options for details about how to configure this.
  41         +
  42         All clients need to authenticate against the remote SysDB instance. See
  43         the section *AUTHENTICATION* for details.
  44         +
  45         A server block accepts the following configuration options:
  46
  47         *Username* '<name>';;
  48                 The username used for authentication against the remote instance.
  49
  50         *SSLCertificate* '<filename>';;
  51                 The SSL certificate file to use for SSL connections and
  52                 authentication.
  53
  54         *SSLCertificateKey* '<filename>';;
  55                 The SSL private key file to use for SSL connections and
  56                 authentication.
  57
  58         *SSLCACertificates* '<filename>';;
  59                 The certificate authority (CA) certificates file for server
  60                 certificate verification to use for SSL connection.
  61
  62 AUTHENTICATION
  63 --------------
  64
  65 include::sysdb-auth.txt[]
  66
  67 SEE ALSO
  68 --------
  69 manpage:sysdbd[1], manpage:sysdbd.conf[5]
  70
  71 The SysDB homepage: https://sysdb.io/
  72
  73 AUTHOR
  74 ------
  75 SysDB was written by Sebastian "tokkee" Harl <sh@tokkee.org>.
  76
  77 COPYRIGHT
  78 ---------
  79 Copyright (C) 2012-2015 Sebastian "tokkee" Harl <sh@tokkee.org>
  80
  81 This is free software under the terms of the BSD license, see the source for
  82 copying conditions. There is NO WARRANTY; not even for MERCHANTABILITY or
  83 FITNESS FOR A PARTICULAR PURPOSE.
  84
  85 // vim: set tw=78 sw=4 ts=4 noexpandtab spell spelllang=en_us :
  86