postal/README.md
2018-08-03 06:02:42 +02:00

2.4 KiB

Alpine Linux Container (Default)

For this container, use the 'alpine' folder.

Ubuntu Linux Container

For this container, use the 'ubuntu' folder

Instructions

Change configuration in docker-compose.yml to update passwords for MySQL/RabbitMQ. Note that both passwords in the postal service, mysql service and rabbitmq service have to be changed to the same values.

Then, begin by following the directions at https://github.com/atech/postal/wiki/Installation#initialize-database--assets. Postal can be accessed by checking the section below. Note that postal intialize-config is already run for you, as the database parameters need to be configured to match the environment variables before the postal tool can be used.

After configuration is done, run the following to bring the container up.

docker-compose up -d

Using the postal tool.

To use the postal tool, simply run

docker-compose run postal <parameter>

For example, the following command runs postal initialize inside the container.

docker-compose run postal initialize

Migrations

See https://github.com/atech/postal/wiki/Upgrading. Note that building a new container (or pulling a new version from Docker Hub) will update the files in postal, so all you have to run is postal upgrade after building or retrieving the new container. Updating postal using its auto-update feature is highly not reccomended and likely does not work properly.

Ports

Port mappings may change (as they have in the past). If SMTP/HTTP(s) is not working, verify that the mapped ports are correct.

Anti-Spam / Antivirus

The initial design for the container was to be simple, minimal, and customizable, so Spamassassin and ClamAV are not included by default. Feel free to fork and add to the Dockerfile (though you must set docker-compose.yml to build from Dockerfile and not pull an image), or add them by linking additional containers.

Updates

  • v2.0.0
    • Update to more reliable version of YAML management system
    • Split into ubuntu and alpine images
  • v1.0.0
    • Initial Release