Clone this repository and build the image with docker build <arguments> (imagename) .
Prebuilt Images
Builds of the image are available on Docker Hub and is the recommended method of installation.
The following image tags are available along with their tagged release based on what's written in the Changelog:
Container OS
Tag
Alpine
:latest
Multi Architecture
Images are built primarily for amd64 architecture, and may also include builds for arm/v6, arm/v7, arm64 and others. These variants are all unsupported. Consider sponsoring my work so that I can work with various hardware. To see if this image supports multiple architecures, type docker manifest (image):(tag)
Configuration
Quick Start
The quickest way to get started is using docker-compose. See the examples folder for a working
docker-compose.yml that can be modified for development or production use.
Map persistent storage for access to configuration and data files for backup.
Persistent Storage
The following directories are used for configuration and can be mapped for persistent storage.
Directory
Description
/config/
Auto generated Postal Config and Signing Key resides here
/logs/
Logfiles
/assets/custom
Optional Use this to drop files overop of the Postal sourcode for cherry picked overrides of files
Environment Variables
Base Images used
This image relies on an Alpine Linux base image that relies on an init system for added capabilities. Outgoing SMTP capabilities are handlded via msmtp. Individual container performance monitoring is performed by zabbix-agent. Additional tools include: bash,curl,less,logrotate, nano,vim.
Be sure to view the following repositories to understand all the customizable options:
SMTP Server to be used to send messages from Postal Management System to users
127.0.0.1
SMTP_PORT
SMTP Port to be used to send messages from Postal Management System to Users
25
SMTP_USER
Username to authenticate to SMTP Server
SMTP_PASS
Password to authenticate to SMTP Server
Relay
Parameter
Description
Default
SMTP_RELAY_HOST
Relay all outbound messages to this hostname
SMTP_RELAY_PORT
SMTP Relay Port
25
SMTP_RELAY_SSL_MODE
Relay SSL / TLS Mode
Auto
Other Settings
Parameter
Description
Default
CONFIG_FILE
Configuration File
postal.yml
CONFIG_PATH
Configuration Path
/config/
FAST_SERVER_BIND_IP
Bind IP for the Web Interface
0.0.0.0
FAST_SERVER_BIND_PORT_TLS
Bind Port for the TLS Tracking Service
8443
FAST_SERVER_BIND_PORT
Bind Port for the Tracking Server
8080
SETUP_TYPE
Choose AUTO or MANUAL Setup type - Auto uses these environment variables
AUTO
SIGNING_KEY_FILE
Signing Key File
signing.key
SIGNING_KEY_SIZE
Signing Key Size
1024
WEB_BIND_IP
Bind IP for the Web Interface
0.0.0.0
WEB_BIND_PORT
Bind Port for the Web Interface
5000
WEB_HOSTNAME
Hostname for Web Interface
postal.example.com
WEB_MAX_THREADS
Max Threads for Web Interface
5
WEB_PROTOCOL
Protocol for Web Interface http or https
http
Networking
Port
Description
25
SMTP
80
Web Interface
8080
Fast Server /Tracking
8443
Fast Server / Tracking
5000
Puma`
Maintenance
Shell Access
For debugging and maintenance purposes you may want access the containers shell.
bash docker exec -it (whatever your container name is) bash
Support
These images were built to serve a specific need in a production environment and gradually have had more functionality added based on requests from the community.
Usage
The Discussions board is a great place for working with the community on tips and tricks of using this image.