From 05e1cc30350bfc21ea78f5f81f7bb6520389d63c Mon Sep 17 00:00:00 2001 From: Pavel Pivovarov Date: Tue, 9 Jul 2019 13:05:17 +1000 Subject: [PATCH] Updated readme file --- README.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index ff01017..1562c33 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,6 @@ # snibox-sqlite + Snibox container working with SQLite3 database for personal use To build this container use following command: @@ -15,7 +16,6 @@ Alternatively you can pull ready to use image from [Docker Hub](https://hub.dock docker pull snowmean/snibox-sqlite:latest ``` -Default database file location is `/app/db/database/snibox.sqlite3`, but you can redefine its location by using environment variable `DATABASE`. Container runs `rake db:migrate` on every start, in order to create database file if not exist, or update database scheme if required, so backups are highly recommended. @@ -29,3 +29,14 @@ docker run -d --name snibox \ snowmean/snibox-sqlite ``` +## Environment variables + +`DATABASE` - Defines sqlite3 database file location within container. + +_Default_: `/app/db/database/snibox.sqlite3` + +--- + +`WEB_CONSOLE_WHITELISTED_IPS` - Defines whitelisted IPs for the Web Console. + +_Default_: `0.0.0.0/0`