diff options
Diffstat (limited to 'readme.txt')
-rw-r--r-- | readme.txt | 43 |
1 files changed, 43 insertions, 0 deletions
diff --git a/readme.txt b/readme.txt new file mode 100644 index 0000000..96ece92 --- /dev/null +++ b/readme.txt @@ -0,0 +1,43 @@ +############################################################################## +# Copyright (c) 2016 Max Breitenfeldt and others. +# +# All rights reserved. This program and the accompanying materials +# are made available under the terms of the Apache License, Version 2.0 +# which accompanies this distribution, and is available at +# http://www.apache.org/licenses/LICENSE-2.0 +############################################################################## + + +The dashboard is deployed using docker-compose. + +Application / database files are saved in the 'pharos-data' container +which needs to be pre-built before bringing up the dashboard. + +Deployment: + +- clone the repository +- complete the config.env.sample file and save it as config.env +- install docker, docker-compose +- run 'make data' +- run 'make up' to run the dashboard + +Updating: + +- run 'docker-compose pull' +- run 'docker-compose up -d' +- make stop +- git pull +- make build +- make start + +If there is migrations that need user input (like renaming a field), they need to be run manually! + +Logs / Shell access: + +- there is some shortcuts in the makefile + +Development: + +- Install dependencies listed in 'Deployment' +- run 'make build' +- run 'make dev-up' |