postal/README.md

38 lines
2.1 KiB
Markdown
Raw Normal View History

2017-04-27 11:23:57 +02:00
## Docker container for [atech/postal](https://github.com/atech/postal)
2017-05-09 22:41:46 +02:00
### Docker Hub Daily Builds Status
2017-05-09 22:39:47 +02:00
2017-05-11 04:12:39 +02:00
| tag | Status | Docker Hub |
| ------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------- |
| latest | [![Daily Build](https://api.travis-ci.org/ALinuxNinja/docker-postal.svg?branch=latest)](https://travis-ci.org/ALinuxNinja/docker-postal) | [\[DockerHub\]](https://hub.docker.com/r/alinuxninja/postal/) |
2017-05-11 01:03:06 +02:00
Side Note: Sometimes, ruby fails to fetch and the build looks like it's failed. Also, each branch corresponds to the docker tag, so the "master" branch always shows that it has failed.
2017-05-09 22:33:13 +02:00
2017-04-27 11:23:57 +02:00
### Instructions
2017-04-27 21:38:02 +02:00
Change configuration in docker-compose.yml to update passwords for MySQL/RabbitMQ.
Both passwords in the `postal` service, `mysql` service and `rabbitmq` service have to be changed.
2017-04-27 11:23:57 +02:00
2017-05-06 04:31:47 +02:00
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 "intialize-config" is already run for you, as the database parameters need to be configured before the postal tool can be used.
After configuration is done, run the following to bring the container up.
2017-04-27 11:23:57 +02:00
```
docker-compose up -d
```
2017-05-06 04:31:47 +02:00
### 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
```
2017-04-28 01:07:05 +02:00
2017-05-06 04:31:47 +02:00
### Migrations
See https://github.com/atech/postal/wiki/Upgrading.
2017-04-27 21:38:31 +02:00
2017-04-27 21:38:02 +02:00
Be sure to do some port mappings to allow your SMTP server and HTTP(s) server to be accessed. I suggest simply port mapping the SMTP server and using [jwilder/nginx-proxy](https://github.com/jwilder/nginx-proxy) to proxy the HTTP server.
2017-04-27 11:23:57 +02:00
Still WIP