diff --git a/examples/docker-compose.mysql.yml b/examples/docker-compose.mysql.yml index c784fdf..74b5963 100644 --- a/examples/docker-compose.mysql.yml +++ b/examples/docker-compose.mysql.yml @@ -9,16 +9,17 @@ services: ports: - "80:80" environment: - - "REPORT_DB_HOST=db" - - "REPORT_DB_PORT=3306" - - "REPORT_DB_NAME=dmarc_report" - - "REPORT_DB_USER=dmarc_report" - - "REPORT_DB_PASS=${DMARC_DB_PASSWORD}" - - "PARSER_IMAP_SERVER=mail" - - "PARSER_IMAP_PORT=143" - - "PARSER_IMAP_USER=${DMARC_EMAIL}" - - "PARSER_IMAP_PASS=${DMARC_PASSWORD}" - - "PARSER_IMAP_READ_FOLDER=Inbox" + - "REPORT_DB_HOST=${DB_HOST:-db}" + - "REPORT_DB_TYPE=${DB_TYPE:-mysql}" + - "REPORT_DB_PORT=${DB_PORT:-3306}" + - "REPORT_DB_NAME=${DB_NAME:-dmarc_report}" + - "REPORT_DB_USER=${DB_USER:-dmarc_report}" + - "REPORT_DB_PASS=${DB_PASSWORD}" + - "PARSER_IMAP_SERVER=${IMAP_SERVER}" + - "PARSER_IMAP_PORT=${IMAP_PORT:-993}" + - "PARSER_IMAP_USER=${IMAP_USER}" + - "PARSER_IMAP_PASS=${IMAP_PASSWORD}" + - "PARSER_IMAP_READ_FOLDER=${IMAP_READ_FOLDER:-Inbox}" - "PARSER_IMAP_MOVE_FOLDER=${IMAP_MOVE_FOLDER:-processed}" - "PARSER_IMAP_MOVE_FOLDER_ERR=${IMAP_MOVE_FOLDER_ERR:-error}" diff --git a/examples/docker-compose.postgres.yml b/examples/docker-compose.postgres.yml index 8dba293..42cead9 100644 --- a/examples/docker-compose.postgres.yml +++ b/examples/docker-compose.postgres.yml @@ -9,16 +9,17 @@ services: ports: - "80:80" environment: - - "REPORT_DB_TYPE=pgsql" - - "REPORT_DB_PORT=5432" - - "REPORT_DB_NAME=dmarc_report" - - "REPORT_DB_USER=dmarc_report" - - "REPORT_DB_PASS=${DMARC_DB_PASSWORD}" + - "REPORT_DB_HOST=${DB_HOST:-db}" + - "REPORT_DB_TYPE=${DB_TYPE:-mysql}" + - "REPORT_DB_PORT=${DB_PORT:-3306}" + - "REPORT_DB_NAME=${DB_NAME:-dmarc_report}" + - "REPORT_DB_USER=${DB_USER:-dmarc_report}" + - "REPORT_DB_PASS=${DB_PASSWORD}" - "PARSER_IMAP_SERVER=${IMAP_SERVER}" - "PARSER_IMAP_PORT=${IMAP_PORT:-993}" - - "PARSER_IMAP_USER=${DMARC_EMAIL}" - - "PARSER_IMAP_PASS=${DMARC_PASSWORD}" - - "PARSER_IMAP_READ_FOLDER=Inbox" + - "PARSER_IMAP_USER=${IMAP_USER}" + - "PARSER_IMAP_PASS=${IMAP_PASSWORD}" + - "PARSER_IMAP_READ_FOLDER=${IMAP_READ_FOLDER:-Inbox}" - "PARSER_IMAP_MOVE_FOLDER=${IMAP_MOVE_FOLDER:-processed}" - "PARSER_IMAP_MOVE_FOLDER_ERR=${IMAP_MOVE_FOLDER_ERR:-error}" diff --git a/examples/env.example b/examples/env.example index 67d8cc7..067afc8 100644 --- a/examples/env.example +++ b/examples/env.example @@ -1,21 +1,39 @@ +# databse host address +DB_HOST= + +# the database type mysql or pgsql +DB_TYPE= + +# the datbase port (mysql 3306) (pqsql 5432) +DB_PORT= + +# the databse name +DB_NAME= + +# the databse name +DB_USER= + # mysql root password. Irrelevant if you are using postgres ROOT_DB_PASSWORD= -# database password for the dmarc user -DMARC_DB_PASSWORD= +# database password for the database user +DB_PASSWORD= # the email address receiving the DMARC reports -DMARC_EMAIL= +IMAP_USER= # the password for the email address receiving the DMARC reports -DMARC_PASSWORD= +IMAP_PASSWORD= # the server the email address is hosted on IMAP_SERVER= -# optional: default is 993 +# optional: default is 993 ( or 143) IMAP_PORT= +# optional: default is "Inbox" +IMAP_READ_FOLDER + # optional: default is "processed" IMAP_MOVE_FOLDER=