Managing SSH chroots to backup a lot of machines
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

68 lines
1.6 KiB

  1. .Dd December 28, 2018
  2. .Dt BKCTLD.CONF 5
  3. .Os
  4. .Sh NAME
  5. .Nm bkctld.conf
  6. .Nd configuration file for
  7. .Xr bkctld 8
  8. .Sh SYNOPSIS
  9. .D1 name=[value]
  10. .Sh DESCRIPTION
  11. The
  12. .Nm
  13. file contains variables that override the behavior of the
  14. .Xr bkctld 8
  15. script.
  16. By default, it is located at
  17. .Pa /etc/default/bkctld .
  18. .Pp
  19. Each line must be a valid
  20. .Xr bash 1
  21. variable definition.
  22. Lines beginning with the
  23. .Sq #
  24. character are comments and are ignored.
  25. The order of the definitions does not matter.
  26. .Pp
  27. The following variables may be defined:
  28. .Bl -tag -width Ds
  29. .It Va CONFDIR
  30. Directory where
  31. .Xr evobackup-incl 5
  32. files are kept.
  33. It's default value is
  34. .Pa /etc/evobackup/ .
  35. .It Va JAILDIR
  36. Directory where the jails are stored,
  37. it is recommended that this be inside a BTRFS file system.
  38. It's default value is
  39. .Pa /backup/jails/ .
  40. .It Va INCDIR
  41. Directory where incremental backups are stored,
  42. it is recommended that this be inside a BTRFS file system.
  43. It's default value is
  44. .Pa /backup/incs/ .
  45. .It Va TPLDIR
  46. Directory where the default configuration files are stored.
  47. It's default value is
  48. .Pa /usr/share/bkctld/ .
  49. .It Va LOCALTPLDIR
  50. Directory where custom configuration files are stored.
  51. It's default is
  52. .Pa /usr/local/share/bkctld/ .
  53. .It Va LOGLEVEL
  54. Defines the amount of information to log, follows the same scale as in
  55. .In syslog.h
  56. and defaults to 6.
  57. .It Va FIREWALL_RULES
  58. Configuration file containing the firewall rules that govern jail access.
  59. This file must be sourced by your firewall.
  60. It does not have a default value and, if unset,
  61. .Xr bkctld 8
  62. will not automatically update the firewall.
  63. .El
  64. .Sh SEE ALSO
  65. .Xr bash 1 ,
  66. .Xr evobackup-incl 5 ,
  67. .Xr bkctld 8