Skip to content

Latest commit

 

History

History
59 lines (36 loc) · 2.83 KB

README.md

File metadata and controls

59 lines (36 loc) · 2.83 KB
Raw

abuse-docker

Standalone image for AbuseIO 4.2 running on NGINX with MySQL, fetchmail and procmail

Here be dragons
Warning: this is an development release, don't use in a production environment

to build

The image uses composer and GitHub to retrieve its dependencies, you'll need to have a GitHub OATH token to retrieve them, you can get a OATH token on your GitHub profile. GitHub Tokens.

# docker build -t abuseio:4.2 --build-arg GITHUB_TOKEN=<my token> .

to run

# docker run -d -p 8000:8000 -p 3306:3306 -e "APP_URL=http://localhost:8000" -v <host_config_dir>:/config -v <host_data_dir>:/data -v <host_log_dir>:/log abuseio:4.2

and connect your browser to http://localhost:8000/

to update

Pull a new image and create a new container with the old volumes. After the update you should check if your config still works.

configuration

During the first boot of the container, AbuseIO will create an admin account and setup a default AbuseIO instance. The credentials, for the admin account, will be shown during this setup.

The /config volume, contains the basic settings for AbuseIO, most of them are set to default values.

Mail settings can be set in fetchmailrc ( incoming ) and abuseio.env ( outgoing ) for more information about these file see the links below. When you edit fetchmailrc, don't delete or alter the last line.

mda "/usr/bin/procmail -m /etc/procmailrc"

This line ensures that the mails are delivered to AbuseIO.

Others setting for e.g. parsers, collectors and find-contact modules can be found in the /config/abuseio directory.

ports

NGINX is accessible on container port 8000 and MySQL is accessible on port 3306. These ports can be published on the host by using the -p option of Docker, see incoming ports of the Docker Manual.

volumes

The container exports three volumes

  • /config all the necessary files to config AbuseIO e.g. mail credentials

  • /data persistent data: database and mailarchive

  • /log logging from AbuseIO, NGINX and procmail

The volumes can be mapped to local persistent storage, using the -v option of Docker, see mount volume of the Docker manual for more information