Wydawca (split by section):   Section:   Chapter:FastBack: configuring   Up: Top   FastForward: invocation   Contents: Table of ContentsIndex: Concept Index

5 Wydawca configuration file.

This chapter summarizes the configuration statements. For each statement, a reference to its detailed description is provided.

# Enable daemon mode.
# See daemon.
daemon arg:boolean;

# Start in foreground even in daemon mode.
# See foreground.
foreground arg:boolean;

# Set pid file name.
# See pidfile.
pidfile file:string;

# Run with UID and GID of this user.
# See user privileges.
user name:string;

# Retain these supplementary groups:
# See user privileges.
group arg:list of string;

# Listen on this address.
# See listen.
listen socket:sock-addr;

# Maximum number of simultaneous upload notification connections.
# See max-connections.
max-connections n;

# Idle timeout for an upload notification connection.
# See idle-timeout.
idle-timeout time:interval;

# Configure TCP wrappers.
# See tcp-wrapper.
tcp-wrapper {
  # Enable TCP wrapper access control. Default is ‘yes.
  enable arg:boolean;

  # Set daemon name for TCP wrapper lookups. Default is program name.
  daemon name:string;

  # Use file for positive client address access control.
  # (default: /etc/hosts.allow).
  allow-table file:string;

  # Use file for negative client address access control.
  # (default: /etc/hosts.deny).
  deny-table file:string;

  # Log host allows at this syslog priority.
  allow-syslog-priority prio:string;

  # Log host denies at this syslog priority.
  deny-syslog-priority prio:string;
}

# Load module
# See modules.
module name:string file:string;

# Initialize the loaded module
# See module-init.
module-init name {
  # One or more module-specific statements
  ...
}  

# Load mailutils module
# See mod_mailutils.
module mailutils mod_mailutils.so;

# mod_mailutils initialization
module-init mailutils {
  # Set mailer URL.
  # See mailer.
  mailer url:string;

  # Set admin email address.
  # See admin-address.
  admin-address email:string;

  # Set sender email address.
  # See from-address.
  from-address email:string;

  # Send statistics report.
  # See statreports.
  mail-statistics {
    # Message text.
    message text:string;

    # Send mail if one or more of these items are set.
    statistics items:string;

    # Sign message with this key.
    gpg-sign key:string;
  }
}

# Configure notification.
# See notification.
notify-event {
  # Event on which to notify.
  event ev-id:string;

  # Name of the module to invoke on event
  module modname:string;
  
  # Module-specific configuration data
  module-config {
      ...
  }

  # Configuration for mod_mailutils
  # See mail-config.
  module-config {
    # Notify this recipient
    # See recipient.
    recipient who:string;

    # Sign message with this key
    # See gpg-sign.
    gpg-sign key:string;

    # Text of the notification or identifier of a defined message
    # template
    # See message.
    message text-or-id:string;
  }  
}

# Define file sweep time.
# See file-sweep-time.
file-sweep-time time:interval;

# Set tar invocation command line.
# See tar-program.
tar-program prog:string;

# Set umask.
# See umask.
umask mask:octal;

# Control implicit signature archivation.
# See archive-signatures.
archive-signatures arg:boolean;

# Schedule generation of statistic reports.
# See statistics.
stat-report-schedule time:crontab-time;

# Generate statistic reports if one or more of these items
# changed.  
# See statistics.
statistics items:string;

# Service names that request scanning all spools.
# See all-spools.
all-spools arg:list of string;

# GPG home directory.
# See gpg-homedir.
gpg-homedir arg:string;

# Define SQL database.
# See sql.
sql id:string {
  # Set the name of the configuration file to read.
  config-file name:string;
  # Set the name of the configuration file group to use.
  config-group name:string;
  
  # Set SQL server hostname or IP address.
  host host:string;

  # Set database name.
  database dbname:string;

  # Set SQL user name.
  user name:string;

  # Set SQL user password.
  password arg:string;

  # File name of the Certificate Authority (CA) certificate.
  ssl-ca file:string;
}

# Configure syslog logging.
# See syslog.
syslog {
  # Set syslog facility.
  facility name:string;

  # Tag syslog messages with this string.
  tag string:string;

  # Prefix each message with its priority.
  print-priority arg:boolean;
}

# Define message text.
# See templates.
define-message ident:string text:string;

# Create missing directories.
# See directory setup.
create-directories arg:boolean;

# Mode for created directories.
# See directory setup.
directory-mode mode:octal;

# Owner user and group for created directory.
# See directory setup.
directory-owner uid:string gid:string;

# Set up archivation.
# See archivation.
archive type:string {
  # Name of archive file or directory.
  name file-or-dir:string;

  # Define backup type.
  # See backup-methods.
  backup type:string;

  # Mode for the archive directory.
  # See directory-mode.
  directory-mode mode:octal;

  # Owner user and group for the archive directory.
  directory-owner uid:string gid:string;
}

# Define data dictionary.
# See dictionaries.
dictionary ident:string {
  # Dictionary type.
  type type:string;

  # Query template.
  query string:string;

  # Set dictionary parameters.
  params arg:list of string;
}

# Define distribution spool.
# See spool.
spool tag:string {
  # URL corresponding to this spool.
  url arg:string;

  # Aliases.
  alias arg:list of string;

  # Source directory.
  source dir:string;

  # Mode for the source directory.
  # See source-mode.
  # See directory setup.
  source-mode mode:octal;

  # Owner user and group for the source directory.
  # See source-owner.
  # See directory setup.
  source-owner uid:string gid:string;

  # Destination directory.
  destination dir:string;

  # Mode for the destination directory.
  # See destination-mode.
  # See directory setup.
  destination-mode mode:octal;

  # Owner user and group for the destination directory.
  # See destination-owner.
  # See directory setup.
  destination-owner uid:string gid:string;

  # Define file sweep time.
  file-sweep-time time:interval;

  # Define data dictionary.
  # See above.
  dictionary ident:string { … }
  
  # Set up archivation.
  archive type:string { … }

  # Configure notification.
  notify-event { … }
}

Wydawca (split by section):   Section:   Chapter:FastBack: configuring   Up: Top   FastForward: invocation   Contents: Table of ContentsIndex: Concept Index