pmg-administration.adoc: add administration section

asciidoc/asciidoc-pmg.conf

@@ -10,7 +10,9 @@ manmanual=Proxmox Mail Gateway Documentation
 max-width=55em
 spamassassin=http://spamassassin.apache.org[SpamAssassin(TM)]
 postfix=http://www.postfix.org[Postfix]
+systemd=https://www.freedesktop.org/wiki/Software/systemd/[systemd]
 clamav=https://www.clamav.net[ClamAV(R)]
+debian=https://www.debian.org[Debian]
 tts=http://www.template-toolkit.org[Template Toolkit]
 ifndef::docinfo1[]
 author=Proxmox Server Solutions Gmbh

pmg-admin-guide.adoc

@@ -29,6 +29,8 @@ include::pmgconfig.adoc[]
 
 include::pmg-mail-filter.adoc[]
 
+include::pmg-administration.adoc[]
+
 include::pmgbackup.adoc[]
 
 include::pmgcm.adoc[]

pmg-administration.adoc

@@ -0,0 +1,96 @@
+Administration
+==============
+
+The Administration GUI allows you to do common administration tasks
+like updating software packages, manage quarantine, view service
+status and manage mail queues. It also provides server statistics in
+order to verify server health.
+
+
+Server Administration
+---------------------
+
+Server status
+~~~~~~~~~~~~~
+
+image::images/screenshot/pmg-gui-server-status.png[]
+
+This page shows server statistics about CPU, memory, disk and network
+usage. You can select the displayed time span on the upper right.
+
+Administrators can open a terminal window using the 'Console'
+button. It is also possible to trigger a server 'Restart' or
+'Shutdown'.
+
+
+Services
+~~~~~~~~
+
+image::images/screenshot/pmg-gui-service-status.png[]
+
+This panel lists all major services used for mail processing and
+cluster synchronization. If necessary, you can start, stop or restart
+them. The 'Syslog' button shows the system log filtered for the
+selected service.
+
+Please note that {pmg} uses {systemd} to manage services, so you can
+also use the standard `systemctl` command line tool to manage or view
+service status, for example:
+
+-----
+systemctl status postfix
+-----
+
+
+Updates
+~~~~~~~
+
+image::images/screenshot/pmg-gui-updates.png[]
+
+We release software updates on a regular basis, and it is recommended
+to always run the latest available version. This page shows the
+available updates, and administrator can run an upgrade by pressing
+the 'Upgrade' button.
+
+See section xref:pmg_package_repositories[Package Repositories] for
+details abaout available package repositories.
+
+
+Syslog and Tasks
+~~~~~~~~~~~~~~~~
+
+image::images/screenshot/pmg-gui-syslog.png[]
+
+
+TODO
+
+
+Quarantine
+----------
+
+Spam
+~~~~
+
+DODO
+
+Virus
+~~~~~
+
+TODO
+
+User White- and Blacklist
+~~~~~~~~~~~~~~~~~~~~~~~~~
+
+TODO
+
+
+Tracking Center
+---------------
+
+TODO
+
+
+Postfix Queue Administration
+----------------------------
+
+TODO

pmg-installation.adoc

@@ -231,3 +231,129 @@ configuration is also completely up to you.
 
 NOTE: In general, this is not trivial, especially when you use LVM or
 ZFS.
+
+
+[[pmg_package_repositories]]
+Package Repositories
+--------------------
+
+All {debian} based systems use
+http://en.wikipedia.org/wiki/Advanced_Packaging_Tool[APT] as package
+management tool. The list of repositories is defined in
+`/etc/apt/sources.list` and `.list` files found inside
+`/etc/apt/sources.d/`. Updates can be installed directly using
+`apt-get`, or via the GUI.
+
+Apt `sources.list` files list one package repository per line, with
+the most preferred source listed first. Empty lines are ignored, and a
+`#` character anywhere on a line marks the remainder of that line as a
+comment. The information available from the configured sources is
+acquired by `apt-get update`.
+
+.File `/etc/apt/sources.list`
+----
+deb http://ftp.debian.org/debian stretch main contrib
+
+# security updates
+deb http://security.debian.org stretch/updates main contrib
+----
+
+In addition, {pmg} provides three different package repositories.
+
+
+{pmg} Enterprise Repository
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+This is the default, stable and recommended repository, available for
+all {pmg} subscription users. It contains the most stable packages,
+and is suitable for production use. The `pmg-enterprise` repository is
+enabled by default:
+
+.File `/etc/apt/sources.list.d/pmg-enterprise.list`
+----
+deb https://enterprise.proxmox.com/debian/pmg stretch pmg-enterprise
+----
+
+As soon as updates are available, the `root@pam` user is notified via
+email about the available new packages. On the GUI, the change-log of
+each package can be viewed (if available), showing all details of the
+update. So you will never miss important security fixes.
+
+Please note that and you need a valid subscription key to access this
+repository. We offer different support levels, and you can find further
+details at https://www.proxmox.com/en/proxmox-mail-gateway/pricing.
+
+NOTE: You can disable this repository by commenting out the above line
+using a `#` (at the start of the line). This prevents error messages
+if you do not have a subscription key. Please configure the
+`pmg-no-subscription` repository in that case.
+
+
+{pmg} No-Subscription Repository
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+As the name suggests, you do not need a subscription key to access
+this repository. It can be used for testing and non-production
+use. Its not recommended to run on production servers, as these
+packages are not always heavily tested and validated.
+
+We recommend to configure this repository in `/etc/apt/sources.list`.
+
+.File `/etc/apt/sources.list`
+----
+deb http://ftp.debian.org/debian stretch main contrib
+
+# PMG pmg-no-subscription repository provided by proxmox.com,
+# NOT recommended for production use
+deb http://download.proxmox.com/debian/pmg stretch pmg-no-subscription
+
+# security updates
+deb http://security.debian.org stretch/updates main contrib
+----
+
+
+{pmg} Test Repository
+~~~~~~~~~~~~~~~~~~~~~
+
+Finally, there is a repository called `pmgtest`. This one contains the
+latest packages and is heavily used by developers to test new
+features. As usual, you can configure this using
+`/etc/apt/sources.list` by adding the following line:
+
+.sources.list entry for `pmgtest`
+----
+deb http://download.proxmox.com/debian/pmg stretch pmgtest
+----
+
+WARNING: the `pmgtest` repository should (as the name implies) only be used
+for testing new features or bug fixes.
+
+
+SecureApt
+~~~~~~~~~
+
+We use GnuPG to sign the `Release` files inside those repositories,
+and APT uses that signatures to verify that all packages are from a
+trusted source.
+
+The key used for verification is already installed if you install from
+our installation CD. If you install by other means, you can manually
+download the key with:
+
+ # wget http://download.proxmox.com/debian/proxmox-ve-release-5.x.gpg -O /etc/apt/trusted.gpg.d/proxmox-ve-release-5.x.gpg
+
+Please verify the checksum afterwards:
+
+----
+# sha512sum /etc/apt/trusted.gpg.d/proxmox-ve-release-5.x.gpg
+ffb95f0f4be68d2e753c8875ea2f8465864a58431d5361e88789568673551501ae574283a4e0492f17d79dc67edfb173a56a6304dea39e01f249ebdabc9f074a  /etc/apt/trusted.gpg.d/proxmox-ve-release-5.x.gpg
+----
+
+or
+
+----
+# md5sum /etc/apt/trusted.gpg.d/proxmox-ve-release-5.x.gpg
+511d36d0f1350c01c42a3dc9f3c27939  /etc/apt/trusted.gpg.d/proxmox-ve-release-5.x.gpg
+----
+
+