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/README.md

51 lines
3.8 KiB
Markdown
Raw Normal View History

Final Migration Step (#6) * first migration steps * altered issue templates * altered README * removed .travis.yml * adjusting registry & repository, Dockerfile and compose.env * Close stale issues automatically * Integrated CI with Github Actions (#3) * feat: integrated ci with github actions * fix: use secrets for docker org and update image * docs: clarify why we use -t if no tty exists * fix: correct remaining references to old repo chore: prettier automatically updated markdown as well * fix: hardcode docker org * change testing image to just testing * ci: add armv7 as a supported platform * finished migration steps * corrected linting in build-push action * corrected linting in build-push action (2) * minor preps for PR * correcting push on pull request and minor details * adjusted workflows to adhere closer to @wernerfred's diagram * minor patches * adjusting Dockerfile's installation of base packages * adjusting schedule for stale issue action * reverting license text * improving CONTRIBUTING.md PR text * Update CONTRIBUTING.md * a bigger patch at the end * moved all scripts into one directory under target/scripts/ * moved the quota-warning.sh script into target/scripts/ and removed empty directory /target/dovecot/scripts * minor fixes here and there * adjusted workflows for use a fully qualified name (i.e. docker.io/...) * improved on the Dockerfile layer count * corrected local tests - now they (actually) work (fine)! * corrected start-mailserver.sh to make use of defaults consistently * removed very old, deprecated variables (actually only one) * various smaller improvements in the end * last commit before merging #6 * rearranging variables to use alphabetic order Co-authored-by: casperklein <casperklein@users.noreply.github.com> Co-authored-by: Nick Pappas <radicand@users.noreply.github.com> Co-authored-by: William Desportes <williamdes@wdes.fr>
2021-01-16 09:16:05 +00:00
# Docker Mailserver
Added Docker Pull image
2016-06-25 08:57:46 +00:00
Better incorporate the new, great documentation (#1878)
2021-04-01 20:44:31 +00:00
[![ci::status]][ci::github] [![docker::pulls]][docker::hub] [![documentation::badge]][documentation::web]
corrected CONTRIBUTING & README
2020-12-22 10:08:50 +00:00
docs(fix): README - Update CI status badge URL (#2951)
2022-12-23 13:32:06 +00:00
[ci::status]: https://img.shields.io/github/actions/workflow/status/docker-mailserver/docker-mailserver/default_on_push.yml?branch=master&color=blue&label=CI&logo=github&logoColor=white&style=for-the-badge
Final Migration Step (#6) * first migration steps * altered issue templates * altered README * removed .travis.yml * adjusting registry & repository, Dockerfile and compose.env * Close stale issues automatically * Integrated CI with Github Actions (#3) * feat: integrated ci with github actions * fix: use secrets for docker org and update image * docs: clarify why we use -t if no tty exists * fix: correct remaining references to old repo chore: prettier automatically updated markdown as well * fix: hardcode docker org * change testing image to just testing * ci: add armv7 as a supported platform * finished migration steps * corrected linting in build-push action * corrected linting in build-push action (2) * minor preps for PR * correcting push on pull request and minor details * adjusted workflows to adhere closer to @wernerfred's diagram * minor patches * adjusting Dockerfile's installation of base packages * adjusting schedule for stale issue action * reverting license text * improving CONTRIBUTING.md PR text * Update CONTRIBUTING.md * a bigger patch at the end * moved all scripts into one directory under target/scripts/ * moved the quota-warning.sh script into target/scripts/ and removed empty directory /target/dovecot/scripts * minor fixes here and there * adjusted workflows for use a fully qualified name (i.e. docker.io/...) * improved on the Dockerfile layer count * corrected local tests - now they (actually) work (fine)! * corrected start-mailserver.sh to make use of defaults consistently * removed very old, deprecated variables (actually only one) * various smaller improvements in the end * last commit before merging #6 * rearranging variables to use alphabetic order Co-authored-by: casperklein <casperklein@users.noreply.github.com> Co-authored-by: Nick Pappas <radicand@users.noreply.github.com> Co-authored-by: William Desportes <williamdes@wdes.fr>
2021-01-16 09:16:05 +00:00
[ci::github]: https://github.com/docker-mailserver/docker-mailserver/actions
[docker::pulls]: https://img.shields.io/docker/pulls/mailserver/docker-mailserver.svg?style=for-the-badge&logo=docker&logoColor=white
[docker::hub]: https://hub.docker.com/r/mailserver/docker-mailserver/
Better incorporate the new, great documentation (#1878)
2021-04-01 20:44:31 +00:00
[documentation::badge]: https://img.shields.io/badge/DOCUMENTATION-GH%20PAGES-0078D4?style=for-the-badge&logo=git&logoColor=white
docs: Change `edge` version links to `latest` + fix links intended as relative not absolute (#3190) * docs: change some absolute links to relative links * docs: change most hard-coded links to `edge` to point to `latest` * Apply suggestions from code review * docs: revert 404 page to edge and change canonical link to `latest --------- Co-authored-by: Brennan Kinney <5098581+polarathene@users.noreply.github.com> Co-authored-by: Georg Lauterbach <44545919+georglauterbach@users.noreply.github.com>
2023-03-22 10:43:10 +00:00
[documentation::web]: https://docker-mailserver.github.io/docker-mailserver/latest/
added description for user-patches & reworked SELinux settings
2020-12-19 12:17:48 +00:00
completely refactor README & parts of docs (#3097) Co-authored-by: Brennan Kinney <5098581+polarathene@users.noreply.github.com>
2023-02-19 12:25:14 +00:00
## :page_with_curl: About
Fix some documentation links (#2426)
2022-02-23 17:22:44 +00:00
completely refactor README & parts of docs (#3097) Co-authored-by: Brennan Kinney <5098581+polarathene@users.noreply.github.com>
2023-02-19 12:25:14 +00:00
A production-ready fullstack but simple containerized mail server (SMTP, IMAP, LDAP, Antispam, Antivirus, etc.). Only configuration files, no SQL database. Keep it simple and versioned. Easy to deploy and upgrade. Originally created by @tomav, this project is now maintained by volunteers since January 2021.
Working image.
2015-03-28 15:44:40 +00:00
completely refactor README & parts of docs (#3097) Co-authored-by: Brennan Kinney <5098581+polarathene@users.noreply.github.com>
2023-02-19 12:25:14 +00:00
## :bulb: Documentation
adjusted coding style guidelines; added table of contents
2020-09-09 15:19:48 +00:00
completely refactor README & parts of docs (#3097) Co-authored-by: Brennan Kinney <5098581+polarathene@users.noreply.github.com>
2023-02-19 12:25:14 +00:00
We provide a [dedicated documentation][documentation::web] hosted on GitHub Pages. Make sure to read it as it contains all the information necessary to set up and configure your mail server. The documentation is crafted with Markdown & [MkDocs Material](https://squidfunk.github.io/mkdocs-material/).
## :boom: Issues
If you have issues, please search through [the documentation][documentation::web] **for your version** before opening an issue. The issue tracker is for issues, not for personal support. Make sure the version of the documentation matches the image version you're using!
## :link: Links to Useful Resources
docs: Change `edge` version links to `latest` + fix links intended as relative not absolute (#3190) * docs: change some absolute links to relative links * docs: change most hard-coded links to `edge` to point to `latest` * Apply suggestions from code review * docs: revert 404 page to edge and change canonical link to `latest --------- Co-authored-by: Brennan Kinney <5098581+polarathene@users.noreply.github.com> Co-authored-by: Georg Lauterbach <44545919+georglauterbach@users.noreply.github.com>
2023-03-22 10:43:10 +00:00
1. [FAQ](https://docker-mailserver.github.io/docker-mailserver/latest/faq/)
2. [Usage](https://docker-mailserver.github.io/docker-mailserver/latest/usage/)
3. [Examples](https://docker-mailserver.github.io/docker-mailserver/latest/examples/tutorials/basic-installation/)
4. [Issues and Contributing](https://docker-mailserver.github.io/docker-mailserver/latest/contributing/issues-and-pull-requests/)
completely refactor README & parts of docs (#3097) Co-authored-by: Brennan Kinney <5098581+polarathene@users.noreply.github.com>
2023-02-19 12:25:14 +00:00
5. [Release Notes](./CHANGELOG.md)
docs: Change `edge` version links to `latest` + fix links intended as relative not absolute (#3190) * docs: change some absolute links to relative links * docs: change most hard-coded links to `edge` to point to `latest` * Apply suggestions from code review * docs: revert 404 page to edge and change canonical link to `latest --------- Co-authored-by: Brennan Kinney <5098581+polarathene@users.noreply.github.com> Co-authored-by: Georg Lauterbach <44545919+georglauterbach@users.noreply.github.com>
2023-03-22 10:43:10 +00:00
6. [Environment Variables](https://docker-mailserver.github.io/docker-mailserver/latest/config/environment/)
7. [Updating](https://docker-mailserver.github.io/docker-mailserver/latest/faq/#how-do-i-update-dms)
Updated readme with announcement
2020-03-16 17:38:28 +00:00
completely refactor README & parts of docs (#3097) Co-authored-by: Brennan Kinney <5098581+polarathene@users.noreply.github.com>
2023-02-19 12:25:14 +00:00
## :package: Included Services
Simplified configurations
2015-03-29 12:07:56 +00:00
docs: miscellaneous improvements (#3219) Co-authored-by: Brennan Kinney <5098581+polarathene@users.noreply.github.com>
2023-04-08 09:54:16 +00:00
- [Postfix](http://www.postfix.org) with SMTP or LDAP authentication and support for [extension delimiters](https://docker-mailserver.github.io/docker-mailserver/latest/config/user-management/aliases/#address-tags-extension-delimiters-an-alternative-to-aliases)
docs: Change `edge` version links to `latest` + fix links intended as relative not absolute (#3190) * docs: change some absolute links to relative links * docs: change most hard-coded links to `edge` to point to `latest` * Apply suggestions from code review * docs: revert 404 page to edge and change canonical link to `latest --------- Co-authored-by: Brennan Kinney <5098581+polarathene@users.noreply.github.com> Co-authored-by: Georg Lauterbach <44545919+georglauterbach@users.noreply.github.com>
2023-03-22 10:43:10 +00:00
- [Dovecot](https://www.dovecot.org) with SASL, IMAP, POP3, LDAP, [basic Sieve support](https://docker-mailserver.github.io/docker-mailserver/latest/config/advanced/mail-sieve) and [quotas](https://docker-mailserver.github.io/docker-mailserver/latest/config/user-management/accounts#notes)
rspamd: add feature for adjusting options with a file parsed by DMS (#3059) Co-authored-by: Brennan Kinney <5098581+polarathene@users.noreply.github.com>
2023-02-19 11:36:43 +00:00
- [Rspamd](https://rspamd.com/)
Update readme reorg dockerfile and add comments
2019-08-31 07:15:42 +00:00
- [Amavis](https://www.amavis.org/)
fix SpamAssassin spelling/typos (#1869)
2021-03-28 20:07:52 +00:00
- [SpamAssassin](http://spamassassin.apache.org/) supporting custom rules
Update readme reorg dockerfile and add comments
2019-08-31 07:15:42 +00:00
- [ClamAV](https://www.clamav.net/) with automatic updates
completely refactor README & parts of docs (#3097) Co-authored-by: Brennan Kinney <5098581+polarathene@users.noreply.github.com>
2023-02-19 12:25:14 +00:00
- [OpenDKIM](http://www.opendkim.org) & [OpenDMARC](https://github.com/trusteddomainproject/OpenDMARC)
Update readme reorg dockerfile and add comments
2019-08-31 07:15:42 +00:00
- [Fail2ban](https://www.fail2ban.org/wiki/index.php/Main_Page)
- [Fetchmail](http://www.fetchmail.info/fetchmail-man.html)
feature: adding `getmail` as an alternative to `fetchmail` (#2803) Co-authored-by: Brennan Kinney <5098581+polarathene@users.noreply.github.com> Co-authored-by: Georg Lauterbach <44545919+georglauterbach@users.noreply.github.com> Co-authored-by: Casper <casperklein@users.noreply.github.com>
2023-05-23 15:25:08 +00:00
- [Getmail6](https://getmail6.org/documentation.html)
Update readme reorg dockerfile and add comments
2019-08-31 07:15:42 +00:00
- [Postscreen](http://www.postfix.org/POSTSCREEN_README.html)
- [Postgrey](https://postgrey.schweikert.ch/)
completely refactor README & parts of docs (#3097) Co-authored-by: Brennan Kinney <5098581+polarathene@users.noreply.github.com>
2023-02-19 12:25:14 +00:00
- Support for [LetsEncrypt](https://letsencrypt.org/), manual and self-signed certificates
docs: Change `edge` version links to `latest` + fix links intended as relative not absolute (#3190) * docs: change some absolute links to relative links * docs: change most hard-coded links to `edge` to point to `latest` * Apply suggestions from code review * docs: revert 404 page to edge and change canonical link to `latest --------- Co-authored-by: Brennan Kinney <5098581+polarathene@users.noreply.github.com> Co-authored-by: Georg Lauterbach <44545919+georglauterbach@users.noreply.github.com>
2023-03-22 10:43:10 +00:00
- A [setup script](https://docker-mailserver.github.io/docker-mailserver/latest/config/setup.sh) for easy configuration and maintenance
completely refactor README & parts of docs (#3097) Co-authored-by: Brennan Kinney <5098581+polarathene@users.noreply.github.com>
2023-02-19 12:25:14 +00:00
- SASLauthd with LDAP authentication
Reference in a new issue Copy permalink