1. Introduction

1.1. What is Proxmox Mail Gateway?

E-mail security begins at the gateway by controlling all incoming and outgoing e-mail messages. Proxmox Mail Gateway addresses the full spectrum of unwanted e-mail traffic, focusing spam and virus detection. Proxmox Mail Gateway provides a powerful and affordable server solution to eliminate spam, viruses and blocking undesirable content from your e-mail system. All products are self-installing and can be used without deep knowledge of Linux.

images/Proxmox-Mailprocessing.png

1.2. Your benefit with Proxmox Mail Gateway

  • Open source software

  • No vendor lock-in

  • Linux kernel

  • Fast installation and easy-to-use

  • Web-based management interface

  • REST API

  • Huge active community

  • Low administration costs and simple deployment

1.3. Getting Help

1.3.1. Community Support Forum

Proxmox Mail Gateway itself is fully open source, so we always encourage our users to discuss and share their knowledge using the Proxmox VE Community Forum. The forum is fully moderated by the Proxmox support team, and has a quite large user base around the whole world. Needless to say that such a large forum is a great place to get information.

1.3.2. Commercial Support

Proxmox Server Solutions Gmbh also offers commercial Proxmox Mail Gateway Subscription Service Plans. System Administrators with a standard subscription plan can access a dedicated support portal with guaranteed reponse time, where Proxmox Mail Gateway developers help them should an issue appear. Please contact the Proxmox sales team for more information or volume discounts.

1.3.3. Bug Tracker

We also run a public a public bug tracker at https://bugzilla.proxmox.com. If you ever detect a bug, you can file an bug entry there. This makes it easy to track the bug status, and you will get notified as soon as the bug is fixed.

2. Quick Start Guide

Experienced users can use this guide for a quick installation. For detailed instructions please read the whole documentation.

  1. Download ISO from Download http://www.proxmox.com

    Note There is one ISO image for download covering all versions and features.
  2. Burn the downloaded ISO image to a CD or create a bootable USB stick.

  3. Boot from this CD/USB stick on your dedicated hardware - see System requirements.

  4. Follow the instructions on the graphical screen.

    Caution All existing data on your hard disk will be lost!
  5. After reboot, go to your desktop PC and point your browser to the given IP address.

  6. Login and upload subscription key.

  7. Check the IP configuration and hostname.

  8. Check and save the Time Zone.

  9. Check your Firewall settings.

  10. Configure Proxmox Mail Gateway to forward the incoming SMTP traffic to your Mail server (Configuration/Mail Proxy/Default Relay) - Default Relay is your e-mail server.

  11. Configure your e-mail server to send all outgoing messages through your Proxmox Mail Gateway (Smart Host, port 26 by default) - see Filtering outgoing e-mails.

For detailed deployment scenarios see the "Proxmox Mail Gateway Deployment Guide".

If the installation succeeds you have to route all your incoming and outgoing e-mail traffic to the Mail Gateway. For incoming traffic you have to configure your firewall and/or DNS settings. For outgoing traffic you need to change the existing e-mail server configuration.

3. Planning for Deployment

3.1. Easy integration into existing e-mail server architecture

In this sample configuration, your e-mail traffic (SMTP) arrives on the firewall and will be directly forwarded to your e-mail server.

images/infrasturcture_without_proxmox_big.jpg

By using the Proxmox Mail Gateway, all your e-mail traffic is forwarded to the Proxmox Mail Gateway, which filters the whole e-mail traffic and removes unwanted e-mails. You can manage incoming and outgoing mail traffic.

images/infrasturcture_with_proxmox_big.jpg

3.2. Filtering outgoing e-mails

Many e-mail filter solutions do not scan outgoing mails. Opposed to that Proxmox Mail Gateway is designed to scan both incoming and outgoing e-mails. This has two major advantages:

  1. Proxmox Mail Gateway is able to detect viruses sent from an internal host. In many countries you are liable for not sending viruses to other people. Proxmox Mail Gateway outgoing e-mail scanning feature is an additional protection to avoid that.

  2. Proxmox Mail Gateway can gather statistics about outgoing e-mails too. Statistics about incoming e-mails looks nice, but they are quite useless. Consider two users, user-1 receives 10 e-mails from news portals and wrote 1 e-mail to a person you never heard from. While user-2 receives 5 e-mails from a customer and sent 5 e-mails back. Which user do you consider more active? I am sure its user-2, because he communicates with your customers. Proxmox Mail Gateway advanced address statistics can show you this important information. Solution which does not scan outgoing e-mail cannot do that.

To enable outgoing e-mail filtering you just need to send all outgoing "smarthost" on your e-mail server - see Example mail server configuration.

3.3. Firewall settings

In order to pass e-mail traffic to the Proxmox Mail Gateway you need to allow traffic on the SMTP the port. Our servers use the Network Time Protocol (NTP) for time synchronization, RAZOR, DNS, SSH, HTTP and port 8006 for the web based management interface.

Service Port Protocol From To

SMTP

25

TCP

Proxmox

Internet

SMTP

25

TCP

Internet

Proxmox

SMTP

26

TCP

Mailserver

Proxmox

NTP

123

TCP/UDP

Proxmox

Internet

RAZOR

2703

TCP

Proxmox

Internet

DNS

53

TCP/UDP

Proxmox

DNS Server

HTTP

80

TCP

Proxmox

Internet

GUI/API

8006

TCP

Intranet

Proxmox

Caution It is advisable to restrict access to the GUI/API port as far as possible.

The outgoing HTTP connection is mainly used by virus pattern updates, and can be configured to use a proxy instead of a direct internet connection.

You can use the nmap utility to test your firewall settings (see section port scans).

3.4. System Requirements

Proxmox Mail Gateway needs dedicated server hardware but can also run inside a virtual machine on any of the following plattforms:

  • Proxmox VE (KVM)

  • VMWare vSphere™ (open-vm tools are integrated in the ISO)

  • Hyper-V™ (Hyper-V Linux integration tools are integrated in the ISO)

  • KVM (virtio drivers are integrated, great performance)

  • Virtual box™

  • Citrix XenServer™

Please see http://www.proxmox.com for details.

In order to get a benchmark from your hardware, just run pmgperf after installation.

3.4.1. Minimum System Requirements

  • CPU: 64bit (Intel EMT64 or AMD64)

  • 1 GB RAM

  • bootable CD-ROM-drive or USB boot support

  • 1024x768 capable VGA/Monitor for Installer

  • Hard disk 8 GB - ATA/SATA/SCSI/NVME

  • Ethernet Network interface card

  • Multicore CPU: 64bit (Intel EMT64 or AMD64)

  • 4 GB RAM

  • bootable CD-ROM-drive or USB boot support

  • 1024x768 capable VGA/Monitor for Installer

  • 1 GBps Ethernet Network interface card

  • Hardware RAID1 or RAID10, Raid Controllers need write cache with batteries backup module for best performance

  • Enterprise class SSD with power loss protection (e.g. Intel SSD DC 35xx/36xx/37xx)

4. Configuration Management Toolkit

Toolkit to simplify common configuration tasks.

5. TODO

nmap

create_bootable_usb

mail_server_config

fitering_outgoing_mail

6. Important Service Daemons

6.1. pmgdaemon - Proxmox Mail Gateway API Daemon

This daemon exposes the whole Proxmox Mail Gateway API on 127.0.0.1:85. It runs as root and has permission to do all privileged operations.

Note The daemon listens to a local address only, so you cannot access it from outside. The pmgproxy daemon exposes the API to the outside world.

6.2. pmgproxy - Proxmox Mail Gateway API Proxy Daemon

This daemon exposes the whole Proxmox Mail Gateway API on TCP port 8006 using HTTPS. It runs as user www-data and has very limited permissions. Operation requiring more permissions are forwarded to the local pmgdaemon.

Requests targeted for other nodes are automatically forwarded to those nodes. This means that you can manage your whole cluster by connecting to a single Proxmox Mail Gateway node.

6.2.1. Alternative HTTPS certificate

By default, pmgproxy uses the certificate /etc/pmg/pmg-api.pem for HTTPS connections. This certificate is a self signed certificate, and therefor not trusted by browsers and operating systems by default. You can simply replace this certificate with your own (please include the key inside the .pem file).

6.3. pmg-smtp-filter - Proxmox SMTP Filter Daemon

This is the Proxmox SMTP filter daemon, which does the actual SPAM filtering using the SpamAssassin and the rule database. It listens on 127.0.0.1:10023 and 127.0.0.1:10024. The daemon listens to a local address only, so you cannot access it from outside.

With our postfix configuration, incoming mails are sent to 127.0.0.1:10024. Outgoing (trusted) mails are sent to 127.0.0.1:10023. After filtering, mails are reinjected into postfix at 127.0.0.1:10025.

6.4. pmgpolicy - Proxmox Mail Gateway Policy Daemon

This daemon implements the Postfix SMTP access policy delegation protocol on 127.0.0.1:10022. The daemon listens to a local address only, so you cannot access it from outside. We configure Postfix to use this service for greylisting and as SPF policy server.

6.5. pmgtunnel - Cluster Tunnel Daemon

This daemon creates a ssh tunnel to the postgres database in other cluster nodes (port 5432). The tunnel is used to synchronize the database using an application specific asynchronous replication algorythm.

6.6. pmgmirror - Database Mirror Daemon

Proxmox Mail Gateway use an application specific asynchronous replication algorythm to replicate the database to all cluster nodes.

The daemon uses the ssh tunnel provided by pmgtunnel to access the database on remote nodes.

7. Useful Command Line Tools

7.1. Database Management Toolkit

Toolkit to simplify common database management tasks.

7.2. API Shell

Toolkit to access the Proxmox Mail Gateway API via the command line.

7.2.1. Examples

List entries:

# pmgsh ls /

Call method GET on an specific API path:

# pmgsh get /version

View current mail configuration:

# pmgsh get /config/mail

Get help for a specific path:

# pmgsh help /config/mail  -v

Disable option spf in /config/mail

# pmgsh set /config/mail  -spf 0

Delete spf setting from /config/mail

# pmgsh set /config/mail  -delete spf

7.3. Proxmox Mail Gateway Version Info

Print version information for Proxmox Mail Gateway packages.

7.3.1. Examples

Print Proxmox Mail Gateway version:

# pmgversion

List version details for important packages:

# pmgversion -v

Please use the Debian package management for details about other packages

# dpkg -l

7.4. pmgsubscription - Subscription Management

This tool is used to handle Proxmox Mail Gateway subscriptions.

7.5. Proxmox Simple Performance Benchmark

This tool tries to gather some CPU/Hardisk performance data on the hardisk (mounted at path).

  • CPU BOGOMIPS: bogomips sum of all CPUs

  • REGEX/SECOND: regular expressions per second (perl performance test), should be above 300000

  • HD SIZE: harddisk size

  • BUFFERED READS: simple HD read test. Modern HDs should reach at least 40 MB/sec

  • AVERAGE SEEK TIME: tests average seek time. Fast SCSI HDs reach values < 8 milliseconds. Common IDE/SATA disks get values from 15 to 20 ms. SSD seek times should be below 1ms.

  • FSYNCS/SECOND: value should be greater than 200 (you should enable write back cache mode on you RAID controller - needs a battery backed cache (BBWC)).

  • DNS EXT: average time to resolve an external DNS name

  • DNS INT: average time to resolve a local DNS name

7.6. Quarantine Management Toolkit

Toolkit to manage spam an virus quarantine, and send spam report mails.

7.7. Send daily system report email

This binary generates and send daily system report email.

7.8. Upgrade Proxmox Mail Gateway

This is a small wrapper around apt-get dist-upgrade. We use this to print additional information (kernel restart required?), and optionally run an interactive shell after the update. This binary is invoked when starting an upgrade using the web GUI.

If you are already logged in on the console, it is peferable to invoke apt-get directly.

# apt-get dist-upgrade

8. Appendix A: Command Line Interface

8.1. pmgsh - API Shell

Interactive session:

pmgsh

Directly call API functions:

pmgsh (get|set|create|help) <path> [OPTIONS]

8.2. pmgperf - Proxmox Simple Performance Benchmark

pmgperf help

pmgperf [<path>]

Proxmox benchmark.

<path>: <string> (default = /)

File system location to test.

8.3. pmgconfig - Configuration Management Toolkit

pmgconfig <COMMAND> [ARGS] [OPTIONS]

pmgconfig apicert [OPTIONS]

Generate /etc/pmg/pmg-api.pem (self signed certificate for GUI and REST API).

--force <boolean> (default = 0)

Overwrite existing certificate.

pmgconfig dump

Print configuration setting which can be used in templates.

pmgconfig help [<cmd>] [OPTIONS]

Get help about specified command.

<cmd>: <string>

Command name

--verbose <boolean>

Verbose output format.

pmgconfig init

Generate required files in /etc/pmg/

pmgconfig ldapsync

Syncronize the LDAP database.

pmgconfig sync [OPTIONS]

Syncronize Proxmox Mail Gateway configurations with system configuration.

--restart <boolean> (default = 0)

Restart services if necessary.

pmgconfig tlscert [OPTIONS]

Generate /etc/pmg/pmg-tls.pem (self signed certificate for encrypted SMTP traffic).

--force <boolean> (default = 0)

Overwrite existing certificate.

8.4. pmgdb - Database Management Toolkit

pmgdb <COMMAND> [ARGS] [OPTIONS]

pmgdb delete

Delete PMG rule database.

pmgdb dump

Print the PMG rule database.

pmgdb help [<cmd>] [OPTIONS]

Get help about specified command.

<cmd>: <string>

Command name

--verbose <boolean>

Verbose output format.

pmgdb init [OPTIONS]

Initialize/Upgrade the PMG rule database.

--force <boolean> (default = 0)

Delete existing database.

--statistics <boolean> (default = 0)

Reset and update statistic database.

pmgdb reset

Reset PMG rule database back to factory defaults.

pmgdb update

Update the PMG statistic database.

9. Appendix B: Service Daemons

9.1. pmgdaemon - Proxmox Mail Gateway API Daemon

pmgdaemon <COMMAND> [ARGS] [OPTIONS]

pmgdaemon help [<cmd>] [OPTIONS]

Get help about specified command.

<cmd>: <string>

Command name

--verbose <boolean>

Verbose output format.

pmgdaemon restart

Restart the daemon (or start if not running).

pmgdaemon start [OPTIONS]

Start the daemon.

--debug <boolean> (default = 0)

Debug mode - stay in foreground

pmgdaemon status

Get daemon status.

pmgdaemon stop

Stop the daemon.

9.2. pmgproxy - Proxmox Mail Gateway API Proxy Daemon

pmgproxy <COMMAND> [ARGS] [OPTIONS]

pmgproxy help [<cmd>] [OPTIONS]

Get help about specified command.

<cmd>: <string>

Command name

--verbose <boolean>

Verbose output format.

pmgproxy restart

Restart the daemon (or start if not running).

pmgproxy start [OPTIONS]

Start the daemon.

--debug <boolean> (default = 0)

Debug mode - stay in foreground

pmgproxy status

Get daemon status.

pmgproxy stop

Stop the daemon.

9.3. pmg-smtp-filter - Proxmox SMTP Filter Daemon

Please use systemd tools to manage this service.

systemctl (start|stop|restart|reload|status) pmg-smtp-filter

9.4. pmgpolicy - Proxmox Mail Gateway Policy Daemon

Please use systemd tools to manage this service.

systemctl (start|stop|restart|reload|status) pmgpolicy

9.5. pmgtunnel - Cluster Tunnel Daemon

pmgtunnel <COMMAND> [ARGS] [OPTIONS]

pmgtunnel help [<cmd>] [OPTIONS]

Get help about specified command.

<cmd>: <string>

Command name

--verbose <boolean>

Verbose output format.

pmgtunnel restart

Restart the Cluster Tunnel Daemon

pmgtunnel start [OPTIONS]

Start the Cluster Tunnel Daemon

--debug <boolean> (default = 0)

Debug mode - stay in foreground

pmgtunnel status

Print cluster tunnel status.

pmgtunnel stop

Stop the Cluster Tunnel Daemon

9.6. pmgmirror - Database Mirror Daemon

pmgmirror <COMMAND> [ARGS] [OPTIONS]

pmgmirror help [<cmd>] [OPTIONS]

Get help about specified command.

<cmd>: <string>

Command name

--verbose <boolean>

Verbose output format.

pmgmirror restart

Restart the Database Mirror Daemon

pmgmirror start [OPTIONS]

Start the Database Mirror Daemon

--debug <boolean> (default = 0)

Debug mode - stay in foreground

pmgmirror stop

Stop the Database Mirror Daemon

10. Appendix C: Available Macros for the Rule System

It is possible to use macros inside most fields of action objects. That way it is possible to access and include data contained in the original mail, get envelope sender and receivers addresses or include additional information about Viruses and Spam. Currently the following macros are defined:

Macro Comment
__SENDER__          

(envelope) sender mail address

__RECEIVERS__       

(envelope) receiver mail address list

__ADMIN__           

Email address of the administrator

__TARGETS__         

Subset of receivers matched by the rule

__SUBJECT__         

Subject of the message

__MSGID__           

The message ID

__RULE__            

Name of the matching rule

__RULE_INFO__       

Additional information about the matching rule

__VIRUS_INFO__      

Additional information about detected viruses

__SPAMLEVEL__       

Computed spam level

__SPAM_INFO__       

Additional information why message is spam

__SENDER_IP__       

IP address of sending host

__VERSION__         

The current software version (proxmox mail gateway)

__FILENAME__        

Attachment file name

__SPAMSTARS__       

A series of "*" charactes where each one represents a full score (SPAMLEVEL) point

11. Appendix D: Configuration Files

11.1. Proxmox Mail Gateway Main Configuration

The file /etc/pmg/pmg.conf is the main configuration.

11.1.1. File Format

The file is divided into several section. Each section has the following format:

section: NAME
         OPTION value
         ...

Blank lines in the file separates sections, and lines starting with a # character are treated as comments and are also ignored.

11.1.2. Options

Section admin
advfilter: <boolean> (default = 1)

Use advanced filters for statistic.

dailyreport: <boolean> (default = 1)

Send daily reports.

delete: <string>

A list of settings you want to delete.

demo: <boolean> (default = 0)

Demo mode - do not start SMTP filter.

digest: <string>

Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.

email: <string> (default = admin@domain.tld)

Administrator E-Mail address.

http_proxy: http://.*

Specify external http proxy which is used for downloads (example: http://username:password@host:port/)

statlifetime: <integer> (1 - N) (default = 7)

User Statistics Lifetime (days)

Section clamav
archiveblockencrypted: <boolean> (default = 0)

Wether to block encrypted archives. Mark encrypted archives as viruses.

archivemaxfiles: <integer> (0 - N) (default = 1000)

Number of files to be scanned within an archive, a document, or any other kind of container. Warning: disabling this limit or setting it too high may result in severe damage to the system.

archivemaxrec: <integer> (1 - N) (default = 5)

Nested archives are scanned recursively, e.g. if a ZIP archive contains a TAR file, all files within it will also be scanned. This options specifies how deeply the process should be continued. Warning: setting this limit too high may result in severe damage to the system.

archivemaxsize: <integer> (1000000 - N) (default = 25000000)

Files larger than this limit won’t be scanned.

dbmirror: <string> (default = database.clamav.net)

ClamAV database mirror server.

delete: <string>

A list of settings you want to delete.

digest: <string>

Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.

maxcccount: <integer> (0 - N) (default = 0)

This option sets the lowest number of Credit Card or Social Security numbers found in a file to generate a detect.

maxscansize: <integer> (1000000 - N) (default = 100000000)

Sets the maximum amount of data to be scanned for each input file.

safebrowsing: <boolean> (default = 1)

Enables support for Google Safe Browsing.

Section mail
banner: <string> (default = ESMTP Proxmox)

ESMTP banner.

conn_count_limit: <integer> (0 - N) (default = 50)

How many simultaneous connections any client is allowed to make to this service. To disable this feature, specify a limit of 0.

conn_rate_limit: <integer> (0 - N) (default = 0)

The maximal number of connection attempts any client is allowed to make to this service per minute. To disable this feature, specify a limit of 0.

delete: <string>

A list of settings you want to delete.

digest: <string>

Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.

dnsbl_sites: <string>

Optional list of DNS white/blacklist domains (see postscreen_dnsbl_sites parameter).

dwarning: <integer> (0 - N) (default = 4)

SMTP delay warning time (in hours).

ext_port: <integer> (1 - 65535) (default = 26)

SMTP port number for incoming mail (untrusted). This must be a different number than int_port.

greylist: <boolean> (default = 1)

Use Greylisting.

helotests: <boolean> (default = 0)

Use SMTP HELO tests.

hide_received: <boolean> (default = 0)

Hide received header in outgoing mails.

int_port: <integer> (1 - 65535) (default = 25)

SMTP port number for outgoing mail (trusted).

max_filters: <integer> (3 - 40) (default = 15)

Maximum number of pmg-smtp-filter processes.

max_policy: <integer> (2 - 10) (default = 5)

Maximum number of pmgpolicy processes.

max_smtpd_in: <integer> (3 - 100) (default = 99)

Maximum number of SMTP daemon processes (in).

max_smtpd_out: <integer> (3 - 100) (default = 99)

Maximum number of SMTP daemon processes (out).

maxsize: <integer> (1024 - N) (default = 10485760)

Maximum email size. Larger mails are rejected.

message_rate_limit: <integer> (0 - N) (default = 0)

The maximal number of message delivery requests that any client is allowed to make to this service per minute.To disable this feature, specify a limit of 0.

rejectunknown: <boolean> (default = 0)

Reject unknown clients.

rejectunknownsender: <boolean> (default = 0)

Reject unknown senders.

relay: <string>

The default mail delivery transport (incoming mails).

relaynomx: <boolean> (default = 0)

Disable MX lookups for default relay.

relayport: <integer> (1 - 65535) (default = 25)

SMTP port number for relay host.

smarthost: <string>

When set, all outgoing mails are deliverd to the specified smarthost.

spf: <boolean> (default = 1)

Use Sender Policy Framework.

tls: <boolean> (default = 0)

Enable TLS.

tlsheader: <boolean> (default = 0)

Add TLS received header.

tlslog: <boolean> (default = 0)

Enable TLS Logging.

use_rbl: <boolean> (default = 1)

Use Realtime Blacklists.

verifyreceivers: <450 | 550>

Enable receiver verification. The value spefifies the numerical reply code when the Postfix SMTP server rejects a recipient address.

Section spam
bounce_score: <integer> (0 - 1000) (default = 0)

Additional score for bounce mails.

delete: <string>

A list of settings you want to delete.

digest: <string>

Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.

languages: (all|([a-z][a-z])+( ([a-z][a-z])+)*) (default = all)

This option is used to specify which languages are considered OK for incoming mail.

maxspamsize: <integer> (64 - N) (default = 204800)

Maximum size of spam messages in bytes.

rbl_checks: <boolean> (default = 1)

Enable real time blacklists (RBL) checks.

use_awl: <boolean> (default = 1)

Use the Auto-Whitelist plugin.

use_bayes: <boolean> (default = 1)

Whether to use the naive-Bayesian-style classifier.

use_razor: <boolean> (default = 1)

Whether to use Razor2, if it is available.

wl_bounce_relays: <string>

Whitelist legitimate bounce relays.

Section spamquar
allowhrefs: <boolean> (default = 1)

Allow to view hyperlinks.

authmode: <ldap | ldapticket | ticket> (default = ticket)

Authentication mode to access the quarantine interface. Mode ticket allows login using tickets sent with the daily spam report. Mode ldap requires to login using an LDAP account. Finally, mode ldapticket allows both ways.

delete: <string>

A list of settings you want to delete.

digest: <string>

Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.

hostname: <string>

Quarantine Host. Usefule if you run a Cluster and want users to connect to a specific host.

lifetime: <integer> (1 - N) (default = 7)

Quarantine life time (days)

mailfrom: <string>

Text for From header in daily spam report mails.

reportstyle: <custom | none | short | verbose> (default = verbose)

Spam report style.

viewimages: <boolean> (default = 1)

Allow to view images.

Section virusquar
allowhrefs: <boolean> (default = 1)

Allow to view hyperlinks.

delete: <string>

A list of settings you want to delete.

digest: <string>

Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.

lifetime: <integer> (1 - N) (default = 7)

Quarantine life time (days)

viewimages: <boolean> (default = 1)

Allow to view images.

11.2. Cluster Configuration

The file /etc/pmg/cluster.conf contains the cluster configuration.

11.2.1. File Format

The file is divided into several section. There is one master and several node sections.

master: <cid>
         OPTION value
         ...

node: <cid>
         OPTION value
         ...

Blank lines in the file separates sections, and lines starting with a # character are treated as comments and are also ignored.

11.2.2. Options

cid: <integer> (1 - N)

Cluster Node ID.

fingerprint: ^(:?[A-Z0-9][A-Z0-9]:){31}[A-Z0-9][A-Z0-9]$

SSL certificate fingerprint.

hostrsapubkey: ^[A-Za-z0-9\.\/\+]{200,}$

Public SSH RSA key for the host.

ip: <string>

IP address.

maxcid: <integer> (1 - N)

Maximum used cluster node ID (used internally, do not modify).

name: <string>

Node name.

rootrsapubkey: ^[A-Za-z0-9\.\/\+]{200,}$

Public SSH RSA key for the root user.

12. Appendix E: GNU Free Documentation License

Version 1.3, 3 November 2008

Copyright © 2000, 2001, 2002, 2007, 2008 Free Software Foundation, Inc. http://fsf.org/

Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.

0. PREAMBLE

The purpose of this License is to make a manual, textbook, or other functional and useful document "free" in the sense of freedom: to assure everyone the effective freedom to copy and redistribute it, with or without modifying it, either commercially or noncommercially. Secondarily, this License preserves for the author and publisher a way to get credit for their work, while not being considered responsible for modifications made by others.

This License is a kind of "copyleft", which means that derivative works of the document must themselves be free in the same sense. It complements the GNU General Public License, which is a copyleft license designed for free software.

We have designed this License in order to use it for manuals for free software, because free software needs free documentation: a free program should come with manuals providing the same freedoms that the software does. But this License is not limited to software manuals; it can be used for any textual work, regardless of subject matter or whether it is published as a printed book. We recommend this License principally for works whose purpose is instruction or reference.

1. APPLICABILITY AND DEFINITIONS

This License applies to any manual or other work, in any medium, that contains a notice placed by the copyright holder saying it can be distributed under the terms of this License. Such a notice grants a world-wide, royalty-free license, unlimited in duration, to use that work under the conditions stated herein. The "Document", below, refers to any such manual or work. Any member of the public is a licensee, and is addressed as "you". You accept the license if you copy, modify or distribute the work in a way requiring permission under copyright law.

A "Modified Version" of the Document means any work containing the Document or a portion of it, either copied verbatim, or with modifications and/or translated into another language.

A "Secondary Section" is a named appendix or a front-matter section of the Document that deals exclusively with the relationship of the publishers or authors of the Document to the Document’s overall subject (or to related matters) and contains nothing that could fall directly within that overall subject. (Thus, if the Document is in part a textbook of mathematics, a Secondary Section may not explain any mathematics.) The relationship could be a matter of historical connection with the subject or with related matters, or of legal, commercial, philosophical, ethical or political position regarding them.

The "Invariant Sections" are certain Secondary Sections whose titles are designated, as being those of Invariant Sections, in the notice that says that the Document is released under this License. If a section does not fit the above definition of Secondary then it is not allowed to be designated as Invariant. The Document may contain zero Invariant Sections. If the Document does not identify any Invariant Sections then there are none.

The "Cover Texts" are certain short passages of text that are listed, as Front-Cover Texts or Back-Cover Texts, in the notice that says that the Document is released under this License. A Front-Cover Text may be at most 5 words, and a Back-Cover Text may be at most 25 words.

A "Transparent" copy of the Document means a machine-readable copy, represented in a format whose specification is available to the general public, that is suitable for revising the document straightforwardly with generic text editors or (for images composed of pixels) generic paint programs or (for drawings) some widely available drawing editor, and that is suitable for input to text formatters or for automatic translation to a variety of formats suitable for input to text formatters. A copy made in an otherwise Transparent file format whose markup, or absence of markup, has been arranged to thwart or discourage subsequent modification by readers is not Transparent. An image format is not Transparent if used for any substantial amount of text. A copy that is not "Transparent" is called "Opaque".

Examples of suitable formats for Transparent copies include plain ASCII without markup, Texinfo input format, LaTeX input format, SGML or XML using a publicly available DTD, and standard-conforming simple HTML, PostScript or PDF designed for human modification. Examples of transparent image formats include PNG, XCF and JPG. Opaque formats include proprietary formats that can be read and edited only by proprietary word processors, SGML or XML for which the DTD and/or processing tools are not generally available, and the machine-generated HTML, PostScript or PDF produced by some word processors for output purposes only.

The "Title Page" means, for a printed book, the title page itself, plus such following pages as are needed to hold, legibly, the material this License requires to appear in the title page. For works in formats which do not have any title page as such, "Title Page" means the text near the most prominent appearance of the work’s title, preceding the beginning of the body of the text.

The "publisher" means any person or entity that distributes copies of the Document to the public.

A section "Entitled XYZ" means a named subunit of the Document whose title either is precisely XYZ or contains XYZ in parentheses following text that translates XYZ in another language. (Here XYZ stands for a specific section name mentioned below, such as "Acknowledgements", "Dedications", "Endorsements", or "History".) To "Preserve the Title" of such a section when you modify the Document means that it remains a section "Entitled XYZ" according to this definition.

The Document may include Warranty Disclaimers next to the notice which states that this License applies to the Document. These Warranty Disclaimers are considered to be included by reference in this License, but only as regards disclaiming warranties: any other implication that these Warranty Disclaimers may have is void and has no effect on the meaning of this License.

2. VERBATIM COPYING

You may copy and distribute the Document in any medium, either commercially or noncommercially, provided that this License, the copyright notices, and the license notice saying this License applies to the Document are reproduced in all copies, and that you add no other conditions whatsoever to those of this License. You may not use technical measures to obstruct or control the reading or further copying of the copies you make or distribute. However, you may accept compensation in exchange for copies. If you distribute a large enough number of copies you must also follow the conditions in section 3.

You may also lend copies, under the same conditions stated above, and you may publicly display copies.

3. COPYING IN QUANTITY

If you publish printed copies (or copies in media that commonly have printed covers) of the Document, numbering more than 100, and the Document’s license notice requires Cover Texts, you must enclose the copies in covers that carry, clearly and legibly, all these Cover Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on the back cover. Both covers must also clearly and legibly identify you as the publisher of these copies. The front cover must present the full title with all words of the title equally prominent and visible. You may add other material on the covers in addition. Copying with changes limited to the covers, as long as they preserve the title of the Document and satisfy these conditions, can be treated as verbatim copying in other respects.

If the required texts for either cover are too voluminous to fit legibly, you should put the first ones listed (as many as fit reasonably) on the actual cover, and continue the rest onto adjacent pages.

If you publish or distribute Opaque copies of the Document numbering more than 100, you must either include a machine-readable Transparent copy along with each Opaque copy, or state in or with each Opaque copy a computer-network location from which the general network-using public has access to download using public-standard network protocols a complete Transparent copy of the Document, free of added material. If you use the latter option, you must take reasonably prudent steps, when you begin distribution of Opaque copies in quantity, to ensure that this Transparent copy will remain thus accessible at the stated location until at least one year after the last time you distribute an Opaque copy (directly or through your agents or retailers) of that edition to the public.

It is requested, but not required, that you contact the authors of the Document well before redistributing any large number of copies, to give them a chance to provide you with an updated version of the Document.

4. MODIFICATIONS

You may copy and distribute a Modified Version of the Document under the conditions of sections 2 and 3 above, provided that you release the Modified Version under precisely this License, with the Modified Version filling the role of the Document, thus licensing distribution and modification of the Modified Version to whoever possesses a copy of it. In addition, you must do these things in the Modified Version:

  1. Use in the Title Page (and on the covers, if any) a title distinct from that of the Document, and from those of previous versions (which should, if there were any, be listed in the History section of the Document). You may use the same title as a previous version if the original publisher of that version gives permission.

  2. List on the Title Page, as authors, one or more persons or entities responsible for authorship of the modifications in the Modified Version, together with at least five of the principal authors of the Document (all of its principal authors, if it has fewer than five), unless they release you from this requirement.

  3. State on the Title page the name of the publisher of the Modified Version, as the publisher.

  4. Preserve all the copyright notices of the Document.

  5. Add an appropriate copyright notice for your modifications adjacent to the other copyright notices.

  6. Include, immediately after the copyright notices, a license notice giving the public permission to use the Modified Version under the terms of this License, in the form shown in the Addendum below.

  7. Preserve in that license notice the full lists of Invariant Sections and required Cover Texts given in the Document’s license notice.

  8. Include an unaltered copy of this License.

  9. Preserve the section Entitled "History", Preserve its Title, and add to it an item stating at least the title, year, new authors, and publisher of the Modified Version as given on the Title Page. If there is no section Entitled "History" in the Document, create one stating the title, year, authors, and publisher of the Document as given on its Title Page, then add an item describing the Modified Version as stated in the previous sentence.

  10. Preserve the network location, if any, given in the Document for public access to a Transparent copy of the Document, and likewise the network locations given in the Document for previous versions it was based on. These may be placed in the "History" section. You may omit a network location for a work that was published at least four years before the Document itself, or if the original publisher of the version it refers to gives permission.

  11. For any section Entitled "Acknowledgements" or "Dedications", Preserve the Title of the section, and preserve in the section all the substance and tone of each of the contributor acknowledgements and/or dedications given therein.

  12. Preserve all the Invariant Sections of the Document, unaltered in their text and in their titles. Section numbers or the equivalent are not considered part of the section titles.

  13. Delete any section Entitled "Endorsements". Such a section may not be included in the Modified Version.

  14. Do not retitle any existing section to be Entitled "Endorsements" or to conflict in title with any Invariant Section.

  15. Preserve any Warranty Disclaimers.

If the Modified Version includes new front-matter sections or appendices that qualify as Secondary Sections and contain no material copied from the Document, you may at your option designate some or all of these sections as invariant. To do this, add their titles to the list of Invariant Sections in the Modified Version’s license notice. These titles must be distinct from any other section titles.

You may add a section Entitled "Endorsements", provided it contains nothing but endorsements of your Modified Version by various parties—for example, statements of peer review or that the text has been approved by an organization as the authoritative definition of a standard.

You may add a passage of up to five words as a Front-Cover Text, and a passage of up to 25 words as a Back-Cover Text, to the end of the list of Cover Texts in the Modified Version. Only one passage of Front-Cover Text and one of Back-Cover Text may be added by (or through arrangements made by) any one entity. If the Document already includes a cover text for the same cover, previously added by you or by arrangement made by the same entity you are acting on behalf of, you may not add another; but you may replace the old one, on explicit permission from the previous publisher that added the old one.

The author(s) and publisher(s) of the Document do not by this License give permission to use their names for publicity for or to assert or imply endorsement of any Modified Version.

5. COMBINING DOCUMENTS

You may combine the Document with other documents released under this License, under the terms defined in section 4 above for modified versions, provided that you include in the combination all of the Invariant Sections of all of the original documents, unmodified, and list them all as Invariant Sections of your combined work in its license notice, and that you preserve all their Warranty Disclaimers.

The combined work need only contain one copy of this License, and multiple identical Invariant Sections may be replaced with a single copy. If there are multiple Invariant Sections with the same name but different contents, make the title of each such section unique by adding at the end of it, in parentheses, the name of the original author or publisher of that section if known, or else a unique number. Make the same adjustment to the section titles in the list of Invariant Sections in the license notice of the combined work.

In the combination, you must combine any sections Entitled "History" in the various original documents, forming one section Entitled "History"; likewise combine any sections Entitled "Acknowledgements", and any sections Entitled "Dedications". You must delete all sections Entitled "Endorsements".

6. COLLECTIONS OF DOCUMENTS

You may make a collection consisting of the Document and other documents released under this License, and replace the individual copies of this License in the various documents with a single copy that is included in the collection, provided that you follow the rules of this License for verbatim copying of each of the documents in all other respects.

You may extract a single document from such a collection, and distribute it individually under this License, provided you insert a copy of this License into the extracted document, and follow this License in all other respects regarding verbatim copying of that document.

7. AGGREGATION WITH INDEPENDENT WORKS

A compilation of the Document or its derivatives with other separate and independent documents or works, in or on a volume of a storage or distribution medium, is called an "aggregate" if the copyright resulting from the compilation is not used to limit the legal rights of the compilation’s users beyond what the individual works permit. When the Document is included in an aggregate, this License does not apply to the other works in the aggregate which are not themselves derivative works of the Document.

If the Cover Text requirement of section 3 is applicable to these copies of the Document, then if the Document is less than one half of the entire aggregate, the Document’s Cover Texts may be placed on covers that bracket the Document within the aggregate, or the electronic equivalent of covers if the Document is in electronic form. Otherwise they must appear on printed covers that bracket the whole aggregate.

8. TRANSLATION

Translation is considered a kind of modification, so you may distribute translations of the Document under the terms of section 4. Replacing Invariant Sections with translations requires special permission from their copyright holders, but you may include translations of some or all Invariant Sections in addition to the original versions of these Invariant Sections. You may include a translation of this License, and all the license notices in the Document, and any Warranty Disclaimers, provided that you also include the original English version of this License and the original versions of those notices and disclaimers. In case of a disagreement between the translation and the original version of this License or a notice or disclaimer, the original version will prevail.

If a section in the Document is Entitled "Acknowledgements", "Dedications", or "History", the requirement (section 4) to Preserve its Title (section 1) will typically require changing the actual title.

9. TERMINATION

You may not copy, modify, sublicense, or distribute the Document except as expressly provided under this License. Any attempt otherwise to copy, modify, sublicense, or distribute it is void, and will automatically terminate your rights under this License.

However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation.

Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice.

Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, receipt of a copy of some or all of the same material does not give you any rights to use it.

10. FUTURE REVISIONS OF THIS LICENSE

The Free Software Foundation may publish new, revised versions of the GNU Free Documentation License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. See http://www.gnu.org/copyleft/.

Each version of the License is given a distinguishing version number. If the Document specifies that a particular numbered version of this License "or any later version" applies to it, you have the option of following the terms and conditions either of that specified version or of any later version that has been published (not as a draft) by the Free Software Foundation. If the Document does not specify a version number of this License, you may choose any version ever published (not as a draft) by the Free Software Foundation. If the Document specifies that a proxy can decide which future versions of this License can be used, that proxy’s public statement of acceptance of a version permanently authorizes you to choose that version for the Document.

11. RELICENSING

"Massive Multiauthor Collaboration Site" (or "MMC Site") means any World Wide Web server that publishes copyrightable works and also provides prominent facilities for anybody to edit those works. A public wiki that anybody can edit is an example of such a server. A "Massive Multiauthor Collaboration" (or "MMC") contained in the site means any set of copyrightable works thus published on the MMC site.

"CC-BY-SA" means the Creative Commons Attribution-Share Alike 3.0 license published by Creative Commons Corporation, a not-for-profit corporation with a principal place of business in San Francisco, California, as well as future copyleft versions of that license published by that same organization.

"Incorporate" means to publish or republish a Document, in whole or in part, as part of another Document.

An MMC is "eligible for relicensing" if it is licensed under this License, and if all works that were first published under this License somewhere other than this MMC, and subsequently incorporated in whole or in part into the MMC, (1) had no cover texts or invariant sections, and (2) were thus incorporated prior to November 1, 2008.

The operator of an MMC Site may republish an MMC contained in the site under CC-BY-SA on the same site at any time before August 1, 2009, provided the MMC is eligible for relicensing.