tools/pharos-dashboard/readme.txt

   1 ##############################################################################
   2 # Copyright (c) 2016 Max Breitenfeldt and others.
   3 #
   4 # All rights reserved. This program and the accompanying materials
   5 # are made available under the terms of the Apache License, Version 2.0
   6 # which accompanies this distribution, and is available at
   7 # http://www.apache.org/licenses/LICENSE-2.0
   8 ##############################################################################
   9
  10
  11 The dashboard is deployed using docker-compose.
  12 Application / database files are saved in /var/lib/pharos_dashboard/.
  13
  14 Deployment:
  15
  16 - clone the repository
  17 - complete the config.env.sample file and save it as config.env
  18 - install docker, docker-compose and bower
  19 - run 'bower install' in ./src/static/ to fetch javascript dependencies
  20 - run 'make build' to build the containers
  21 - run 'make up' to run the dashboard
  22
  23 Updating:
  24
  25 - make stop
  26 - git pull
  27 - run 'bower install' if javascript dependencies changed
  28 - make build
  29 - make start
  30
  31 If there is migrations that need user input (like renaming a field), they need to be run manually!
  32
  33 Logs / Shell access:
  34
  35 - there is some shortcuts in the makefile