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
  13 Application / database files are saved in the 'pharos-data' container
  14 which needs to be pre-built before bringing up the dashboard.
  15
  16 Deployment:
  17
  18 - clone the repository
  19 - complete the config.env.sample file and save it as config.env
  20 - install docker, docker-compose
  21 - run 'make data'
  22 - run 'make up' to run the dashboard
  23
  24 Updating:
  25
  26 - run 'docker-compose pull'
  27 - run 'docker-compose up -d'
  28 - make stop
  29 - git pull
  30 - make build
  31 - make start
  32
  33 If there is migrations that need user input (like renaming a field), they need to be run manually!
  34
  35 Logs / Shell access:
  36
  37 - there is some shortcuts in the makefile
  38
  39 Development:
  40
  41 - Install dependencies listed in 'Deployment'
  42 - run 'make build'
  43 - run 'make dev-up'