github-com-docker-mailserver/docker-mailserver
1
0
Fork 0
mirror of https://github.com/docker-mailserver/docker-mailserver.git synced 2024-01-19 02:48:50 +00:00
Code Issues Projects Releases Wiki Activity
docker-mailserver/docs/content/config/setup.sh.md

87 lines
2.6 KiB
Markdown
Raw Normal View History

docs(refactor): Large refactor + additions + fixes 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.
2021-03-01 10:41:19 +00:00
---
title: Your best friend setup.sh
hide:
- toc # Hide Table of Contents for this page
---
[`setup.sh`][github-file-setupsh] 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.
Updated Setup docker mailserver using the script setup.sh (markdown)
2020-06-09 20:39:39 +00:00
Updated Setup docker mailserver using the script setup.sh (markdown)
2020-06-09 20:42:44 +00:00
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:
New page about setup.sh
2016-08-29 19:51:09 +00:00
docs(refactor): Large refactor + additions + fixes 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.
2021-03-01 10:41:19 +00:00
```sh
Updated Setup docker mailserver using the script setup.sh (markdown)
2021-01-19 08:45:01 +00:00
wget https://raw.githubusercontent.com/docker-mailserver/docker-mailserver/master/setup.sh
chmod a+x ./setup.sh
Updated Setup docker mailserver using the script setup.sh (markdown)
2017-03-17 22:34:05 +00:00
```
New page about setup.sh
2016-08-29 19:51:09 +00:00
Updated Setup docker mailserver using the script setup.sh (markdown)
2020-06-09 20:42:44 +00:00
## Usage
Updated Setup docker mailserver using the script setup.sh (markdown)
2021-01-19 08:45:01 +00:00
Run `./setup.sh -h` and you'll get some usage information:
docs(refactor): Large refactor + additions + fixes 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.
2021-03-01 10:41:19 +00:00
```bash
Updated Setup docker mailserver using the script setup.sh (markdown)
2021-01-19 08:45:01 +00:00
setup.sh Bootstrapping Script
New page about setup.sh
2016-08-29 19:51:09 +00:00
Usage updated
2016-12-03 00:11:25 +00:00
Usage: ./setup.sh [-i IMAGE_NAME] [-c CONTAINER_NAME] <subcommand> <subcommand> [args]
OPTIONS:
Updated Setup docker mailserver using the script setup.sh (markdown)
2021-01-19 08:45:01 +00:00
-i IMAGE_NAME The name of the docker-mailserver image
The default value is
'docker.io/mailserver/docker-maiserver:latest'
Add new options to reflect support for SELinux
2020-10-30 17:36:38 +00:00
Usage updated
2016-12-03 00:11:25 +00:00
-c CONTAINER_NAME The name of the running container.
New page about setup.sh
2016-08-29 19:51:09 +00:00
Updated Setup docker mailserver using the script setup.sh (markdown)
2021-01-19 08:45:01 +00:00
-p PATH Config folder path (default: /home/georg/github/docker-mailserver/config)
-h Show this help dialogue
Add new options to reflect support for SELinux
2020-10-30 17:36:38 +00:00
-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.
New page about setup.sh
2016-08-29 19:51:09 +00:00
SUBCOMMANDS:
email:
Updated Setup docker mailserver using the script setup.sh (markdown)
2021-01-19 08:45:01 +00:00
./setup.sh email add <email> [<password>]
./setup.sh email update <email> [<password>]
New page about setup.sh
2016-08-29 19:51:09 +00:00
./setup.sh email del <email>
Updated Setup docker mailserver using the script setup.sh (markdown)
2018-02-08 07:32:56 +00:00
./setup.sh email restrict <add|del|list> <send|receive> [<email>]
New page about setup.sh
2016-08-29 19:51:09 +00:00
./setup.sh email list
added updated alias methods for setup.sh
2017-05-13 18:15:04 +00:00
alias:
./setup.sh alias add <email> <recipient>
./setup.sh alias del <email> <recipient>
./setup.sh alias list
quota update
2020-04-25 21:32:25 +00:00
quota:
./setup.sh quota set <email> [<quota>]
./setup.sh quota del <email>
New page about setup.sh
2016-08-29 19:51:09 +00:00
config:
Updated Setup docker mailserver using the script setup.sh (markdown)
2021-01-27 12:41:53 +00:00
./setup.sh config dkim <keysize> (default: 4096) <domain.tld> (optional - for LDAP setups)
Updated Setup docker mailserver using the script setup.sh (markdown)
2021-01-19 08:45:01 +00:00
./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>
New page about setup.sh
2016-08-29 19:51:09 +00:00
debug:
./setup.sh debug fetchmail
Updated Setup docker mailserver using the script setup.sh (markdown)
2021-01-19 08:45:01 +00:00
./setup.sh debug fail2ban [<unban> <ip-address>]
Usage updated
2016-12-03 00:11:25 +00:00
./setup.sh debug show-mail-logs
./setup.sh debug inspect
./setup.sh debug login <commands>
Updated Setup docker mailserver using the script setup.sh (markdown)
2020-06-09 20:37:53 +00:00
Updated Setup docker mailserver using the script setup.sh (markdown)
2021-01-19 08:45:01 +00:00
help: Show this help dialogue
docs(refactor): Large refactor + additions + fixes 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.
2021-03-01 10:41:19 +00:00
```
[github-file-setupsh]: https://github.com/docker-mailserver/docker-mailserver/blob/master/setup.sh
Reference in a new issue Copy permalink