From e57b3e050cb5b2e85e6460536da8e3a4e8aebbc3 Mon Sep 17 00:00:00 2001 From: stremovsky Date: Sun, 29 Dec 2019 08:30:18 +0200 Subject: [PATCH] add custom configuration section --- INSTALLATION.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/INSTALLATION.md b/INSTALLATION.md index 8e5650d..c9e5c23 100644 --- a/INSTALLATION.md +++ b/INSTALLATION.md @@ -17,6 +17,8 @@ This command will init Databunker service, init database and start container. This command will print **DATABUNKER_MASTERKEY** and **DATABUNKER_ROOTTOKEN**. +You can run: ```docker logs dbunker``` to view these codes. + The database will be init in the ~/data directory. **DATABUNKER_MASTERKEY** is used to encrypt database records. @@ -42,6 +44,32 @@ docker run -p 3000:3000 -v ~/data:/databunker/data \ --rm --name dbunker paranoidguy/databunker ``` +# Custom configuration + +Databunker has a configuration file that you can alter to enable custom email gateway, notification urls, +twilio account (sms gateway), etc... + +There are number of ways you can change configuration file it in container, for example by creating your own Docker file. +Another option is to create this file outside of container in conf/ directory and mount this directory in container. + +### You can do it as following: + +1. Download default configuration file and place it in ~/conf/ directory. +``` +mkdir ~/conf +curl https://raw.githubusercontent.com/paranoidguy/databunker/master/create-test-user.sh -o ~/conf/databunker.yaml +``` + +2. After that you can alter the configuration file with your editor: **~/conf/databunker.yaml** + +3. Run container and mount ~/conf/ directory: + +``` +docker run -p 3000:3000 -v ~/data:/databunker/data -v ~/conf:/databunker/conf \ + -e "DATABUNKER_MASTERKEY=**DATABUNKER_MASTERKEY**" \ + --rm --name dbunker paranoidguy/databunker +``` + # SSL certificates You can generate SSL certificates and place them in the /databunker/certs directory in the running container.