Network7/postal
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
iloveyatoo 2020-04-17 06:08:43 +01:00
parent 6afefc555f
commit 3752ab3d9e
1 changed files with 13 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
README.md
View File

@ -15,18 +15,17 @@ For this container, use the 'alpine' folder.
For this container, use the 'ubuntu' folder. For this container, use the 'ubuntu' folder.
### Instructions ### 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. 1. Change the folder to either `ubuntu` or `alpine`, depending on which version you want to use
2. Open `docker-compose.yml`
3. Update `MYSQL_ROOT_PASSWORD` and `RABBITMQ_DEFAULT_PASS` everywhere in the file to new secret passwords
4. Update `POSTAL_FNAME` (First Name), `POSTAL_LNAME` (Last Name), `POSTAL_PASSWORD`, and `POSTAL_EMAIL` values in the file
5. Run `docker-compose up -d`
#### Initialize Database and write assets ### Notes
```docker-compose run postal initialize``` * The `POSTAL_EMAIL` and `POSTAL_PASSWORD` values will be the email and password you use to login
* `POSTAL_EMAIL` and `POSTAL_PASSWORD` will only be used if there is a need to initialize the postal installation. As a result, changing them will not change the admin username or password while postal is already setup
* All the setup instructions are already run
#### Create User
```docker-compose run postal make-user```
#### Running Container
After configuration is done, run the following to bring the container up.
```
docker-compose up -d
``` ```
### Using the `postal` tool. ### Using the `postal` tool.
To use the `postal` tool, simply run To use the `postal` tool, simply run
@ -48,6 +47,10 @@ Port mappings may change (as they have in the past). If SMTP/HTTP(s) is not work
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. 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 ### Updates
- v3.0.0
* Move to Gitlab with automated testing
* Add user creation system for more reliability
* Add some more checks on MySQL during startup
- v2.0.0 - v2.0.0
* Update to more reliable version of YAML management system * Update to more reliable version of YAML management system