:leveloffset: 0
-Useful Command Line Tools
+Useful Command-line Tools
-------------------------
:leveloffset: 2
:leveloffset: 0
[appendix]
-Command Line Interface
+Command-line Interface
----------------------
*pmgbackup* - Proxmox Mail Gateway Backup and Restore Utility
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
+also use the standard `systemctl` command-line tool to manage or view
service status, for example:
-----
engine, designed for detecting Trojans, viruses, malware, and other
malicious threats.
-It provides a high performance, multi-threaded scanning daemon, command
-line utilities for on demand file scanning, and an intelligent tool
+It provides a high performance, multi-threaded scanning daemon, command-line
+utilities for on demand file scanning, and an intelligent tool
for automatic signature updates.
renewal-due or similar notifications from the ACME endpoint.
You can register or deactivate ACME accounts over the web interface
-`Certificates -> ACME Accounts` or using the `pmgconfig` command line tool.
+`Certificates -> ACME Accounts` or using the `pmgconfig` command-line tool.
----
pmgconfig acme account register <account-name> <mail@example.com>
----
triggered if the certificate either has already expired or if it will expire in
the next 30 days.
-Manually Change Certificate over Command-Line
+Manually Change Certificate over the Command Line
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
If you want to get rid of certificate verification warnings, you have to
Test your new certificate, using your browser.
NOTE: To transfer files to and from your {pmg}, you can use secure copy: If your
-desktop runs Linux, you can use the `scp` command line tool. If your desktop PC
+desktop runs Linux, you can use the `scp` command-line tool. If your desktop PC
runs windows, please use an scp client like WinSCP (see https://winscp.net/).
Change Certificate for Cluster Setups
-------------
You can create a backup by simply pressing the 'Backup' button in the 'Local
-Backup/Restore' tab on the GUI, or by using the command line interface:
+Backup/Restore' tab on the GUI, or by using the command-line interface:
----
# pmgbackup backup
----
TIP: You can configure and access all backup-related functionality on
-both the web interface and the command line interface.
+both the web interface and the command-line interface.
[[pmgbackup_pbs_schedule]]
Scheduled Backups
Cluster Administration
----------------------
-Cluster administration can be done from the GUI or by using the command
-line utility `pmgcm`. The CLI tool is a bit more verbose, so we suggest
+Cluster administration can be done from the GUI or by using the command-line
+utility `pmgcm`. The CLI tool is a bit more verbose, so we suggest
to use that if you run into any problems.
NOTE: Always set up the IP configuration, before adding a node to the
~~~~~~~~~~~~~~~~~~~
The GUI shows the status of all cluster nodes. You can also view this
-using the command line tool:
+using the command-line tool:
----
pmgcm status
{pmg} is usually configured using the web-based Graphical User Interface (GUI),
but it is also possible to directly edit the configuration files, using the
-REST API over 'https' or the command line tool `pmgsh`.
+REST API over 'https' or the command-line tool `pmgsh`.
-The command line tool `pmgconfig` is used to simplify some common configuration
+The command-line tool `pmgconfig` is used to simplify some common configuration
tasks, such as generating certificates and rewriting service configuration
files.
:pmg-toplevel:
endif::manvolnum[]
-The command line tool `pmgperf` gathers some general
+The command-line tool `pmgperf` gathers some general
performance data. This is mostly useful for debugging and identifying
performance bottlenecks. It computes the following metrics: