Home

Welcome dear friend!

Good system software needs a proper documentation! That is why we are starting to write this Wiki besides our git logs, changelogs, readmes and so on. Step by step it will become more and more helpful.

FAQ

• What is this?

  • Wildduck is a node-based, flexible, API-first mail server. And this project encapsulates that service in to a wonderful docker container :-)

• How to use it?

  • If you followed the instructions on the README you will have a full featured mailserver running, waiting for you to configure it. Depending on your SSL options, your Server is either listening on 154 (IMAP) and 587 (Submission) or 993 (IMAPS) and 465 (SMTPS). The API itself runs on port 443 in the container.

• How to add a mail user?

  • After your system has started successfully you can run API requests against it, to create a user. The API is documented over here. To add a user you run:

    curl -i -XPOST https://your.mail.host.com/users \
    -H 'Content-type: application/json' \
    -d '{
        "username": "myuser",
        "password": "verysecret",
        "name": "John Doe",
        "address": "[email protected]"
    }'

    You can also use Insomnia to manage your mail server more easily.

• How to add DKIM keys?

  • For your first domain (the one in MAIL_DOMAIN environment variable) there exists already a DKIM key. But if you want to add another DKIM key, for another domain, you can use a convenience script in the container. If your services are running you can run:

    $ docker-compose exec mail generate_dkim

    It will guide you through the process.