Updated readme file
This commit is contained in:
13
README.md
13
README.md
@@ -1,5 +1,6 @@
|
|||||||
# snibox-sqlite
|
# snibox-sqlite
|
||||||
|
|
||||||
|
|
||||||
Snibox container working with SQLite3 database for personal use
|
Snibox container working with SQLite3 database for personal use
|
||||||
|
|
||||||
To build this container use following command:
|
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
|
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.
|
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
|
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`
|
||||||
|
|||||||
Reference in New Issue
Block a user