This in turn allows to also use images from other subdirectories, e.g.
`images/installer/`, and not just from `images/screenshot/`.
Replacing all paths was done mechanically using:
sed -i 's/thumbnail="pmg-gui/thumbnail="screenshot\/pmg-gui/g' *.adoc
Signed-off-by: Christoph Heiss <c.heiss@proxmox.com>
<formalpara{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}><title>{title}</title><para>
{thumbnail#}<mediaobject>
{thumbnail#} <imageobject>
-{thumbnail#} <imagedata fileref="images/screenshot/{thumbnail}"{width? contentwidth="{width}"}{height? contentdepth="{height}"}{scale? scale="{scale}"}{scaledwidth? width="{scaledwidth}" scalefit="1"}{align? align="{align}"}/>
+{thumbnail#} <imagedata fileref="images/{thumbnail}"{width? contentwidth="{width}"}{height? contentdepth="{height}"}{scale? scale="{scale}"}{scaledwidth? width="{scaledwidth}" scalefit="1"}{align? align="{align}"}/>
{thumbnail#} </imageobject>
{thumbnail#} <textobject><phrase>{alt={thumbnail}}</phrase></textobject>
{thumbnail#}</mediaobject>
# Paragraph substitution.
[paragraph]
<div class="paragraph{role? {role}}{unbreakable-option? unbreakable}"{id? id="{id}"}>
-{thumbnail#}<a class="image" href="images/screenshot/{thumbnail}">
-{thumbnail#}<img src="images/screenshot/{thumbnail}" alt="{alt={thumbnail}}"
+{thumbnail#}<a class="image" href="images/{thumbnail}">
+{thumbnail#}<img src="images/{thumbnail}" alt="{alt={thumbnail}}"
{thumbnail#}{width#}width="{width}"
{thumbnail#}{big#}{width%}width="800"
{thumbnail#}{big%}{width%}width="250"
Status
~~~~~~
-[thumbnail="pmg-gui-server-status.png", big=1]
+[thumbnail="screenshot/pmg-gui-server-status.png", big=1]
This page shows statistics about server CPU, memory, disk and network
usage. You can select the displayed time span from the upper right.
Services
~~~~~~~~
-[thumbnail="pmg-gui-service-status.png", big=1]
+[thumbnail="screenshot/pmg-gui-service-status.png", big=1]
This panel lists all the major services used for mail processing and
cluster synchronization. If necessary, you can start, stop or restart
Updates
~~~~~~~
-[thumbnail="pmg-gui-updates.png", big=1]
+[thumbnail="screenshot/pmg-gui-updates.png", big=1]
We release software updates on a regular basis, and it is recommended
to always run the latest available version. This page shows the
Syslog and Tasks
~~~~~~~~~~~~~~~~
-[thumbnail="pmg-gui-syslog.png", big=1]
+[thumbnail="screenshot/pmg-gui-syslog.png", big=1]
The Syslog page gives you a quick real-time log view. You can use the
xref:pmg_tracking_center[Tracking Center] to search the logs.
Spam
~~~~
-[thumbnail="pmg-gui-spam-quarantine.png", big=1]
+[thumbnail="screenshot/pmg-gui-spam-quarantine.png", big=1]
This panel lets you inspect the mail quarantine. Emails can be safely
previewed and if desired, delivered to the original user.
Tracking Center
---------------
-[thumbnail="pmg-gui-tracking-center.png", big=1]
+[thumbnail="screenshot/pmg-gui-tracking-center.png", big=1]
Email processing is a complex task and involves several service
daemons. Each daemon logs information to the syslog service. The
Postfix Queue Administration
----------------------------
-[thumbnail="pmg-gui-queue-admin-summary.png", big=1]
+[thumbnail="screenshot/pmg-gui-queue-admin-summary.png", big=1]
Mail-queues are one of the central concepts of the SMTP protocol. Once a
mail server accepts a mail for further processing it saves it to a queue.
Deferred Mail
~~~~~~~~~~~~~
-[thumbnail="pmg-gui-queue-admin-deferred.png"]
+[thumbnail="screenshot/pmg-gui-queue-admin-deferred.png"]
In the 'Deferred Mail' tab, you can examine each deferred email
separately. In addition to providing contact information about the
enabled in your server's firmware settings. Secure boot needs to be disabled
when booting an installer prior to {pmg} version 8.1.
-[thumbnail="../installer/pmg-grub-menu.png"]
+[thumbnail="installer/pmg-grub-menu.png"]
After choosing the correct entry (for example, Boot from USB) the {pmg} menu
will be displayed, and one of the following options can be selected:
can be used if the machine is completely headless and only has a serial console
available.
-[thumbnail="../installer/pmg-tui-installer.png"]
+[thumbnail="installer/pmg-tui-installer.png"]
Both modes use the same code base for the actual installation process to
benefit from more than a decade of bug fixes and ensure feature parity.
You normally select *Install {pmg} (Graphical)* to start the installation.
-[thumbnail="../installer/pmg-select-target-disk.png"]
+[thumbnail="installer/pmg-select-target-disk.png"]
The first step is to read our EULA (End User License Agreement). Following
this, you can select the target hard disk(s) for the installation.
WARNING: ZFS on top of any hardware RAID is not supported and can result in data
loss.
-[thumbnail="../installer/pmg-select-location.png", float="left"]
+[thumbnail="installer/pmg-select-location.png", float="left"]
The next page asks for basic configuration options like your
location, timezone, and keyboard layout. The location is used to
change them in rare situations when auto-detection fails, or when you want to
use a keyboard layout not commonly used in your country.
-[thumbnail="../installer/pmg-set-password.png"]
+[thumbnail="installer/pmg-set-password.png"]
You then need to specify an email address and the superuser (root)
password. The password must have at least 5 characters, but we highly
All those notification mails will be sent to the specified email address.
-[thumbnail="../installer/pmg-setup-network.png"]
+[thumbnail="installer/pmg-setup-network.png"]
The next step is the network configuration. Please note that you can use either
IPv4 or IPv6 here, but not both. If you want to configure a dual stack node,
you can easily do that after the installation.
-[thumbnail="../installer/pmg-installation.png", float="left"]
+[thumbnail="installer/pmg-installation.png", float="left"]
When you press `Next`, you will see an overview of your entered configuration.
Please re-check every setting, you can still use the `Previous` button to go
After clicking `Install`, the installer will begin to format and copy packages
to the target disk(s).
-[thumbnail="../installer/pmg-summary.png"]
+[thumbnail="installer/pmg-summary.png"]
Copying the packages usually takes several minutes. When this is
finished, you can reboot the server.
Further configuration is done via the {pmg} web interface:
-[thumbnail="pmg-gui-login-window.png"]
+[thumbnail="screenshot/pmg-gui-login-window.png"]
. Point your browser to the IP address given during the installation
(https://youripaddress:8006).
Repository Management
^^^^^^^^^^^^^^^^^^^^^
-[thumbnail="pmg-gui-admin-repositories.png"]
+[thumbnail="screenshot/pmg-gui-admin-repositories.png"]
Since {pmg} 7.0 you can check the repository state in the web interface. The
'Dashboard' shows a high level status overview, while the separate 'Repository'
management interface allows you to set up and maintain even a complex mail
system with ease.
-[thumbnail="pmg-gui-dashboard.png"]
+[thumbnail="screenshot/pmg-gui-dashboard.png"]
There is no need to install a separate management tool. Any modern internet
browser is sufficient.
easy but powerful way to define filter rules by user, domain, time
frame, content type, and resulting action.
-[thumbnail="pmg-gui-mail-filter-rules.png", big=1]
+[thumbnail="screenshot/pmg-gui-mail-filter-rules.png", big=1]
Every rule has 5 categories ('FROM', 'TO', 'WHEN', 'WHAT', and
'ACTION'), and each category may contain several objects to match
'Action' - objects
------------------
-[thumbnail="pmg-gui-mail-filter-actions.png", big=1]
+[thumbnail="screenshot/pmg-gui-mail-filter-actions.png", big=1]
Please note that some actions stop further rule processing. We call
such actions 'final'.
'Who' objects
-------------
-[thumbnail="pmg-gui-mail-filter-who-objects.png", big=1]
+[thumbnail="screenshot/pmg-gui-mail-filter-who-objects.png", big=1]
These types of objects can be used for the 'TO' and/or 'FROM' category,
and match the sender or recipient of the email. A single object can
'What' objects
--------------
-[thumbnail="pmg-gui-mail-filter-what-objects.png", big=1]
+[thumbnail="screenshot/pmg-gui-mail-filter-what-objects.png", big=1]
'What' objects are used to classify the mail's content. A single
object can combine multiple items, and the following item types are
'When' objects
--------------
-[thumbnail="pmg-gui-mail-filter-when-objects.png", big=1]
+[thumbnail="screenshot/pmg-gui-mail-filter-when-objects.png", big=1]
'When' objects are used to activate rules at specific times of the
day. You can compose them from one or more time frame items.
If you already have a certificate which you want to use for a {pmg} host, you
can simply upload that certificate over the web interface.
-[thumbnail="pmg-gui-certs-upload-custom.png"]
+[thumbnail="screenshot/pmg-gui-certs-upload-custom.png"]
Note that any certificate key files must not be password protected.
ACME Account
^^^^^^^^^^^^
-[thumbnail="pmg-gui-acme-create-account.png"]
+[thumbnail="screenshot/pmg-gui-acme-create-account.png"]
You need to register an ACME account per cluster, with the endpoint you want to
use. The email address used for that account will serve as the contact point for
public internet. The `dns-01` challenge can be used in such cases. This
challenge is fulfilled by creating a certain DNS record in the domain's zone.
-[thumbnail="pmg-gui-acme-create-challenge-plugin.png"]
+[thumbnail="screenshot/pmg-gui-acme-create-challenge-plugin.png"]
{pmg} supports both of those challenge types out of the box, you can configure
plugins either over the web interface under `Certificates -> ACME Challenges`,
You can add new or manage existing domain entries under `Certificates`, or
using the `pmgconfig` command.
-[thumbnail="pmg-gui-acme-add-domain.png"]
+[thumbnail="screenshot/pmg-gui-acme-add-domain.png"]
After configuring the desired domain(s) for a node and ensuring that the
desired ACME account is selected, you can order your new certificate over the
The easiest way to configure a new plugin with the DNS API is using the web
interface (`Certificates -> ACME Accounts/Challenges`).
-[thumbnail="pmg-gui-acme-create-challenge-plugin.png"]
+[thumbnail="screenshot/pmg-gui-acme-create-challenge-plugin.png"]
Here you can add a new challenge plugin by selecting your API provider and
entering the credential data to access your account over their API.
current day. This period can be changed to any other day, a whole month or even
a whole year.
-[thumbnail="pmg-gui-statistics-general.png", big=1]
+[thumbnail="screenshot/pmg-gui-statistics-general.png", big=1]
On the main statistics page there are three graphs with additional data:
Spam Scores
-----------
-[thumbnail="pmg-gui-statistics-spam-scores.png", big=1]
+[thumbnail="screenshot/pmg-gui-statistics-spam-scores.png", big=1]
The `Spam Scores` panel shows the distribution of the different spam scores for
the selected time period. Note that you can also select a whole month or even a
Virus Charts
------------
-[thumbnail="pmg-gui-statistics-virus-charts.png"]
+[thumbnail="screenshot/pmg-gui-statistics-virus-charts.png"]
The `Virus Charts` panel gives you an overview of how many virus files were
tried to be transmitted through your mail infrastructure, but got caught early
Hourly Distribution
-------------------
-[thumbnail="pmg-gui-statistics-hourly-distribution.png", big=1]
+[thumbnail="screenshot/pmg-gui-statistics-hourly-distribution.png", big=1]
The `Hourly Distribution` shows the amount of incoming and outgoing mail per
hour for the selected time period. For periods spanning a whole month or a
Postscreen
----------
-[thumbnail="pmg-gui-statistics-postscreen.png"]
+[thumbnail="screenshot/pmg-gui-statistics-postscreen.png"]
Contains a chart with the RBL (Real-time Blackhole Lists) and `pregreet`
rejects for the selected time frame.
Domain
------
-[thumbnail="pmg-gui-statistics-domain.png"]
+[thumbnail="screenshot/pmg-gui-statistics-domain.png"]
The `Domain` view is split into two tabs, one for incoming and one for outgoing
mails.
Sender
------
-[thumbnail="pmg-gui-statistics-sender.png", big=1]
+[thumbnail="screenshot/pmg-gui-statistics-sender.png", big=1]
The `Sender` panel contains a list of e-mail addresses that sent mail out in
the selected time frame, with a total count, how many viruses were detected and
Receiver
--------
-[thumbnail="pmg-gui-statistics-receiver.png"]
+[thumbnail="screenshot/pmg-gui-statistics-receiver.png"]
Similar to the `Sender` panel, this contains a list of e-mail addresses that
received e-mails from outside, with a total, spam and virus count, as well
Contact
-------
-[thumbnail="pmg-gui-statistics-contact.png"]
+[thumbnail="screenshot/pmg-gui-statistics-contact.png"]
This contains the list of external recipients that received mail from this
{pmg}, coming in on the internal port, with total count, virus count and size.
endif::manvolnum[]
ifndef::manvolnum[]
-[thumbnail="pmg-gui-backup.png", big=1]
+[thumbnail="screenshot/pmg-gui-backup.png", big=1]
endif::manvolnum[]
{pmg} includes the ability to back up and restore the
~~~~~~~
ifndef::manvolnum[]
-[thumbnail="pmg-gui-pbs-remote.png"]
+[thumbnail="screenshot/pmg-gui-pbs-remote.png"]
endif::manvolnum[]
~~~~~~~~~~~
ifndef::manvolnum[]
-[thumbnail="pmg-gui-pbs-backup.png", big=1]
+[thumbnail="screenshot/pmg-gui-pbs-backup.png", big=1]
endif::manvolnum[]
With a configured remote, you can create backups using the GUI or the
Creating a Cluster
~~~~~~~~~~~~~~~~~~
-[thumbnail="pmg-gui-cluster-panel.png", big=1]
+[thumbnail="screenshot/pmg-gui-cluster-panel.png", big=1]
You can create a cluster from any existing {pmg} host. All data is
preserved.
Adding Cluster Nodes
~~~~~~~~~~~~~~~~~~~~
-[thumbnail="pmg-gui-cluster-join.png", big=1]
+[thumbnail="screenshot/pmg-gui-cluster-join.png", big=1]
When you add a new node to a cluster (using `join`), all data on that node is
destroyed. The whole database is initialized with the cluster data from
~~~~~~~~~~~~~~~~
ifndef::manvolnum[]
-[thumbnail="pmg-gui-network-config.png", big=1]
+[thumbnail="screenshot/pmg-gui-network-config.png", big=1]
endif::manvolnum[]
As network and time are configured in the installer, these generally do not
~~~~~~~
ifndef::manvolnum[]
-[thumbnail="pmg-gui-system-options.png", big=1]
+[thumbnail="screenshot/pmg-gui-system-options.png", big=1]
endif::manvolnum[]
~~~~~~~~
ifndef::manvolnum[]
-[thumbnail="pmg-gui-mailproxy-relaying.png", big=1]
+[thumbnail="screenshot/pmg-gui-mailproxy-relaying.png", big=1]
endif::manvolnum[]
These settings are saved to the 'mail' subsection in `/etc/pmg/pmg.conf`. Some of these correspond
~~~~~~~~~~~~~
ifndef::manvolnum[]
-[thumbnail="pmg-gui-mailproxy-relaydomains.png", big=1]
+[thumbnail="screenshot/pmg-gui-mailproxy-relaydomains.png", big=1]
endif::manvolnum[]
A list of relayed mail domains, that is, what destination domains this
~~~~~
ifndef::manvolnum[]
-[thumbnail="pmg-gui-mailproxy-ports.png", big=1]
+[thumbnail="screenshot/pmg-gui-mailproxy-ports.png", big=1]
endif::manvolnum[]
These settings are saved to the 'mail' subsection in `/etc/pmg/pmg.conf`. Many of these correspond
~~~~~~~
ifndef::manvolnum[]
-[thumbnail="pmg-gui-mailproxy-options.png", big=1]
+[thumbnail="screenshot/pmg-gui-mailproxy-options.png", big=1]
endif::manvolnum[]
These settings are saved to the 'mail' subsection in `/etc/pmg/pmg.conf`,
~~~~~~~~~~
ifndef::manvolnum[]
-[thumbnail="pmg-gui-mailproxy-transports.png", big=1]
+[thumbnail="screenshot/pmg-gui-mailproxy-transports.png", big=1]
endif::manvolnum[]
You can use {pmg} to send emails to different internal email servers. For
~~~~~~~~
ifndef::manvolnum[]
-[thumbnail="pmg-gui-mailproxy-networks.png", big=1]
+[thumbnail="screenshot/pmg-gui-mailproxy-networks.png", big=1]
endif::manvolnum[]
You can add additional internal (trusted) IP networks or hosts. All hosts in
~~~
ifndef::manvolnum[]
-[thumbnail="pmg-gui-mailproxy-tls.png", big=1]
+[thumbnail="screenshot/pmg-gui-mailproxy-tls.png", big=1]
endif::manvolnum[]
Transport Layer Security (TLS) provides certificate-based authentication and
~~~~~~~~~~~~
ifndef::manvolnum[]
-[thumbnail="pmg-gui-mailproxy-dkim.png", big=1]
+[thumbnail="screenshot/pmg-gui-mailproxy-dkim.png", big=1]
endif::manvolnum[]
DomainKeys Identified Mail (DKIM) Signatures (see {dkim_rfc}) is a method to
~~~~~~~~~
ifndef::manvolnum[]
-[thumbnail="pmg-gui-mailproxy-whitelist.png", big=1]
+[thumbnail="screenshot/pmg-gui-mailproxy-whitelist.png", big=1]
endif::manvolnum[]
All SMTP checks are disabled for those entries (e.g. Greylisting,
~~~~~~~
ifndef::manvolnum[]
-[thumbnail="pmg-gui-spam-options.png", big=1]
+[thumbnail="screenshot/pmg-gui-spam-options.png", big=1]
endif::manvolnum[]
{pmg} uses a wide variety of local and network tests to identify spam
~~~~~~~~~~
ifndef::manvolnum[]
-[thumbnail="pmg-gui-spamquar-options.png", big=1]
+[thumbnail="screenshot/pmg-gui-spamquar-options.png", big=1]
endif::manvolnum[]
{pmg} analyses all incoming email messages and decides for each
~~~~~~~~~~~~~~~~~~~~~~~~~~~
ifndef::manvolnum[]
-[thumbnail="pmg-gui-spam-custom-scores.png", big=1]
+[thumbnail="screenshot/pmg-gui-spam-custom-scores.png", big=1]
endif::manvolnum[]
While the default scoring of {spamassassin}'s ruleset provides very good
~~~~~~~
ifndef::manvolnum[]
-[thumbnail="pmg-gui-virus-options.png", big=1]
+[thumbnail="screenshot/pmg-gui-virus-options.png", big=1]
endif::manvolnum[]
All mails are automatically passed to the included virus detector
include::pmg.clamav-conf-opts.adoc[]
ifndef::manvolnum[]
-[thumbnail="pmg-gui-clamav-database.png", big=1]
+[thumbnail="screenshot/pmg-gui-clamav-database.png", big=1]
endif::manvolnum[]
Please note that the virus signature database is automatically
~~~~~~~~~~
ifndef::manvolnum[]
-[thumbnail="pmg-gui-virusquar-options.png", big=1]
+[thumbnail="screenshot/pmg-gui-virusquar-options.png", big=1]
endif::manvolnum[]
Identified virus mails are automatically moved to the virus
Local Users
~~~~~~~~~~~
-[thumbnail="pmg-gui-local-user-config.png", big=1]
+[thumbnail="screenshot/pmg-gui-local-user-config.png", big=1]
Local users can manage and audit {pmg}. They can login on the management web
interface.
LDAP/Active Directory
~~~~~~~~~~~~~~~~~~~~~
-[thumbnail="pmg-gui-ldap-user-config.png", big=1]
+[thumbnail="screenshot/pmg-gui-ldap-user-config.png", big=1]
With {pmg}, users can use LDAP and Active directory as authentication methods to
access their individual xref:pmgadministration_spam_quarantine[Spam Quarantine].
Fetchmail
~~~~~~~~~
-[thumbnail="pmg-gui-fetchmail-config.png", big=1]
+[thumbnail="screenshot/pmg-gui-fetchmail-config.png", big=1]
Fetchmail is a utility for polling and forwarding emails. You can define
email accounts, which will then be fetched and forwarded to the email
Determine which Bootloader is Used
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-[thumbnail="boot-grub.png", float="left"]
+[thumbnail="screenshot/boot-grub.png", float="left"]
The simplest and most reliable way to determine which bootloader is used, is to
watch the boot process of the {pmg} node.
You will either see the blue box of GRUB or the simple black on white
`systemd-boot`.
-[thumbnail="boot-systemdboot.png"]
+[thumbnail="screenshot/boot-systemdboot.png"]
Determining the bootloader from a running system might not be 100% accurate. The
safest way is to run the following command: