mirror of
https://github.com/tomav/docker-mailserver.git
synced 2024-07-04 15:11:12 +02:00
021e942c4c
Consistency pass, formatting cleanup and fixes, introduce admonitions, add front-matter. --- docs: Add front-matter --- docs: Fix and format links - Some links were invalid (eg files moved or renamed) - Some were valid but had invalid section headers (content removed or migrated) - Some use `http://` instead of `https://` when the website supports a secure connection. - Some already used the `[name][reference]` convention but often with a number that wasn't as useful for maintenance. - All referenced docs needed URLs replaced. Opted for the `[name][reference]` approach to group them all clearly at the bottom of the doc, especially with the relative URLs and in some cases many duplicate entries. - All `tomav` references from the original repo prior to switch to an organization have been corrected. - Minor cosmetic changes to the `name` part of the URL, such as for referencing issues to be consistent. - Some small changes to text body, usually due to duplicate URL reference that was unnecessary (open relay, youtous) - Switched other links to use the `[name][reference]` format when there was a large group of URLs such as wikipedia or kubernetes. Github repos that reference projects related to `docker-mailserver` also got placed here so they're noticed better by maintainers. This also helped quite a bit with `mermaid` external links that are very long. - There was a Github Wiki supported syntax in use `[[name | link]]` for `fetchmail` page that isn't compatible by default with MkDocs (needs a plugin), converted to `[name][reference]` instead since it's a relative link. --- docs: Update commit link for LDAP override script Logic moved to another file, keeping the permalink commit reference so it's unaffected by any changes in the file referenced in future. --- docs: Heading corrections Consistency pass. Helps with the Table of Contents (top-right UI) aka Document Outline. docs: codefence cleanup --- docs: misc cleanup --- docs: Add Admonitions Switches `<details>` usage for collapsible admonitions (`???`) while other text content is switched to the visually more distinct admoniton (`!!!` or `???+`) style. This does affect editor syntax highlighting a bit and markdown linting as it's custom non-standard markdown syntax.
2.6 KiB
2.6 KiB
| title | hide | |
|---|---|---|
| Your best friend setup.sh |
|
setup.sh is an administration script that helps with the most common tasks, including initial configuration. It is intented to be used from the host machine, not from within your running container.
The latest version of the script is included in the docker-mailserver repository. You may retrieve it at any time by running this command in your console:
wget https://raw.githubusercontent.com/docker-mailserver/docker-mailserver/master/setup.sh
chmod a+x ./setup.sh
Usage
Run ./setup.sh -h and you'll get some usage information:
setup.sh Bootstrapping Script
Usage: ./setup.sh [-i IMAGE_NAME] [-c CONTAINER_NAME] <subcommand> <subcommand> [args]
OPTIONS:
-i IMAGE_NAME The name of the docker-mailserver image
The default value is
'docker.io/mailserver/docker-maiserver:latest'
-c CONTAINER_NAME The name of the running container.
-p PATH Config folder path (default: /home/georg/github/docker-mailserver/config)
-h Show this help dialogue
-z Allow container access to the bind mount content
that is shared among multiple containers
on a SELinux-enabled host.
-Z Allow container access to the bind mount content
that is private and unshared with other containers
on a SELinux-enabled host.
SUBCOMMANDS:
email:
./setup.sh email add <email> [<password>]
./setup.sh email update <email> [<password>]
./setup.sh email del <email>
./setup.sh email restrict <add|del|list> <send|receive> [<email>]
./setup.sh email list
alias:
./setup.sh alias add <email> <recipient>
./setup.sh alias del <email> <recipient>
./setup.sh alias list
quota:
./setup.sh quota set <email> [<quota>]
./setup.sh quota del <email>
config:
./setup.sh config dkim <keysize> (default: 4096) <domain.tld> (optional - for LDAP setups)
./setup.sh config ssl <fqdn>
relay:
./setup.sh relay add-domain <domain> <host> [<port>]
./setup.sh relay add-auth <domain> <username> [<password>]
./setup.sh relay exclude-domain <domain>
debug:
./setup.sh debug fetchmail
./setup.sh debug fail2ban [<unban> <ip-address>]
./setup.sh debug show-mail-logs
./setup.sh debug inspect
./setup.sh debug login <commands>
help: Show this help dialogue