artheriom/docker-mailserver-api repository overview

⁠docker-mailserver API

⁠Tags

Caution : latest is an unsable build ! Consider using a specified tag instead.

• v1.0.0

⁠Overview

A simple REST-API backend for docker-mailserver⁠ who enables users to manage emails, aliases, quotas and restrictions through a REST API.

⁠Why did you do this ?

I am using docker-mailserver every day to manage my own mail, but also my family's one. And I always through it was terrible to have to log on my server through SSH to simply change a mailbox password, or create an alias.

So, I decided to write a simple client/server application who will allow me to manage this kind of things through a GUI.

⁠Prerequisites :

• Docker
• A running docker-mailserver >= 11.0.0 instance.
• That's all.

⁠Dev prerequisites :

• All prerequisites cited above
• Golang >= 1.18

⁠API

You will find all the required documentation in /api folder.

⁠Configuration & run

You must provide, through environment variables :

• MAILS_PASSWORD : This password will allow you to request all pages, through the Authorization header.
• MAILS_CONTAINER_NAME, which is the name of your docker-mailserver container.

Server will expose port 8080.

⁠Docker run

docker run -p 8080:8080 -d -e MAILS_PASSWORD=CHANGE_ME -e MAILS_CONTAINER_NAME=mail -v /var/run/docker.sock:/var/run/docker.sock artheriom/docker-mailserver-api:v1.0.0

⁠License

Licensed under AGPL.