mirror of
https://github.com/docker-mailserver/docker-mailserver
synced 2024-05-18 19:56:04 +02:00
463bc967d2
Additionally replaces old references to `tvial` images with the new `mailserver` docker image name.
32 lines
1.8 KiB
Markdown
32 lines
1.8 KiB
Markdown
---
|
|
title: Home
|
|
---
|
|
|
|
# Welcome to the Extended Documentation for `docker-mailserver`!
|
|
|
|
Please first have a look at the [`README.md`][github-file-readme] to setup and configure this server.
|
|
|
|
This documentation provides you with advanced configuration, detailed examples, and hints.
|
|
|
|
## Getting Started
|
|
|
|
1. The script [`setup.sh`][github-file-setupsh] is supplied with this project. It supports you in **configuring and administrating** your server. Information on how to get it and how to use it is available [on a dedicated page][docs-setupsh].
|
|
2. Be aware that advanced tasks may still require tweaking environment variables, reading through documentation and sometimes inspecting your running container for debugging purposes. After all, a mail server is a complex arrangement of various programs.
|
|
3. A list of all configuration options is provided in [`ENVIRONMENT.md`][github-file-env]. The [`README.md`][github-file-readme] is a good starting point to understand what this image is capable of.
|
|
4. A list of all optional and automatically created configuration files and directories is available [on the dedicated page][docs-optionalconfig].
|
|
|
|
!!! tip
|
|
See the [FAQ][docs-faq] for some more tips!
|
|
|
|
## Contributing
|
|
|
|
We are always happy to welcome new contributors. For guidelines and entrypoints please have a look at the [Contributing section][docs-contributing].
|
|
|
|
[docs-contributing]: ./contributing/issues-and-pull-requests.md
|
|
[docs-faq]: ./faq.md
|
|
[docs-optionalconfig]: ./config/advanced/optional-config.md
|
|
[docs-setupsh]: ./config/setup.sh.md
|
|
[github-file-readme]: https://github.com/docker-mailserver/docker-mailserver/blob/master/README.md
|
|
[github-file-env]: https://github.com/docker-mailserver/docker-mailserver/blob/master/ENVIRONMENT.md
|
|
[github-file-setupsh]: https://github.com/docker-mailserver/docker-mailserver/blob/master/setup.sh
|