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

corrected CONTRIBUTING & README

Browse source
This commit is contained in:
Georg Lauterbach 2020-12-22 11:08:50 +01:00
parent 7517315b85
commit 2020df88fe
No known key found for this signature in database
GPG key ID: 2FDC58699AF121C6
2 changed files with 11 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
CONTRIBUTING.md
View file

@ -125,13 +125,15 @@ A construct to trace error in your scripts looks like this. Remember: Remove `se
set -xeuEo pipefail set -xeuEo pipefail
trap '__log_err ${FUNCNAME[0]:-"?"} ${_:-"?"} ${LINENO:-"?"} ${?:-"?"}' ERR trap '__log_err ${FUNCNAME[0]:-"?"} ${_:-"?"} ${LINENO:-"?"} ${?:-"?"}' ERR
SCRIPT='NAME OF THIS SCRIPT'
function __log_err function __log_err
{ {
printf "\n––– \e[1m\e[31mUNCHECKED ERROR\e[0m\n%s\n%s\n%s\n%s\n\n" \ printf "\n––– \e[1m\e[31mUNCHECKED ERROR\e[0m\n%s\n%s\n%s\n%s\n\n" \
" – script = ${SCRIPT,,:-'UNKNOWN'}.sh" \ " – script = ${SCRIPT:-'unknown'}" \
" – function = ${1} / ${2}" \ " – function = ${1} / ${2}" \
" – line = ${3}" \ " – line = ${3}" \
" – exit code = ${4}" " – exit code = ${4}" 1>&2
<CODE TO RUN AFTERWARDS> <CODE TO RUN AFTERWARDS>
} }

12
README.md
View file

@ -1,6 +1,7 @@
# docker-mailserver # docker-mailserver
![build_status] [![docker_pulls]][docker::hub] ![build_status] [![docker_pulls]][docker::hub]
[![gh_stars]][repo] [![contributors]][repo] [![forks]][repo] [![gh_stars]][repo] [![contributors]][repo] [![forks]][repo]
[build_status]: https://img.shields.io/travis/tomav/docker-mailserver/master?style=for-the-badge [build_status]: https://img.shields.io/travis/tomav/docker-mailserver/master?style=for-the-badge
@ -17,7 +18,7 @@ A fullstack but simple mail server (SMTP, IMAP, Antispam, Antivirus...). Only co
[Why this image was created.](http://tvi.al/simple-mail-server-with-docker/) [Why this image was created.](http://tvi.al/simple-mail-server-with-docker/)
1. [Announcements](#announcements) 1. [Release Notes](#release-notes)
2. [Includes](#includes) 2. [Includes](#includes)
3. [Issues & Contributing](#issues--contributing) 3. [Issues & Contributing](#issues--contributing)
4. [Requirements](#requirements) 4. [Requirements](#requirements)
@ -97,7 +98,7 @@ Download the `docker-compose.yml`, `compose.env`, `mailserver.env` and the `setu
wget https://raw.githubusercontent.com/tomav/docker-mailserver/master/setup.sh wget https://raw.githubusercontent.com/tomav/docker-mailserver/master/setup.sh
wget https://raw.githubusercontent.com/tomav/docker-mailserver/master/docker-compose.yml wget https://raw.githubusercontent.com/tomav/docker-mailserver/master/docker-compose.yml
wget https://raw.githubusercontent.com/tomav/docker-mailserver/master/mailserver.env wget https://raw.githubusercontent.com/tomav/docker-mailserver/master/mailserver.env
curl -o .env https://raw.githubusercontent.com/tomav/docker-mailserver/master/compose.env wget -O .env https://raw.githubusercontent.com/tomav/docker-mailserver/master/compose.env
chmod a+x ./setup.sh chmod a+x ./setup.sh
``` ```
@ -118,7 +119,7 @@ chmod a+x ./setup.sh
### Get up and running ### Get up and running
If you'd like to use SELinux, add `-z` to the variable `SELINUX_LABEL` in `.env`. If you want the volume bind mount to be shared among other containers switch `-Z` to `-z` If you'd like to use SELinux, add `-Z` to the variable `SELINUX_LABEL` in `.env`. If you want the volume bind mount to be shared among other containers switch `-Z` to `-z`
``` BASH ``` BASH
# without SELinux # without SELinux
@ -248,7 +249,7 @@ version: '3.8'
services: services:
mail: mail:
image: tvial/docker-mailserver:latest image: docker.io/tvial/docker-mailserver:latest
hostname: mail # ${HOSTNAME} hostname: mail # ${HOSTNAME}
domainname: domain.com # ${DOMAINNAME} domainname: domain.com # ${DOMAINNAME}
container_name: mail # ${CONTAINER_NAME} container_name: mail # ${CONTAINER_NAME}
@ -268,6 +269,7 @@ services:
- ENABLE_CLAMAV=1 - ENABLE_CLAMAV=1
- ENABLE_FAIL2BAN=1 - ENABLE_FAIL2BAN=1
- ENABLE_POSTGREY=1 - ENABLE_POSTGREY=1
- ENABLE_SASLAUTHD=0
- ONE_DIR=1 - ONE_DIR=1
- DMS_DEBUG=0 - DMS_DEBUG=0
cap_add: cap_add:
@ -288,7 +290,7 @@ version: '3.8'
services: services:
mail: mail:
image: tvial/docker-mailserver:latest image: docker.io/tvial/docker-mailserver:latest
hostname: mail # ${HOSTNAME} hostname: mail # ${HOSTNAME}
domainname: domain.com # ${DOMAINNAME} domainname: domain.com # ${DOMAINNAME}
container_name: mail # ${CONTAINER_NAME} container_name: mail # ${CONTAINER_NAME}