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 'laas-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 (or 'make dev-up' for development)
  23 - get the rsa.pem and rsa.pub keys from your jira admin and place them in src/account
  24
  25 Production will be running on port 80 by default.
  26 Development will be running on port 8000 by default.
  27
  28 Updating:
  29
  30 - run 'docker-compose pull'
  31 - run 'docker-compose up -d'
  32 - make stop
  33 - git pull
  34 - make build
  35 - make start
  36
  37 If there is migrations that need user input (like renaming a field), they need to be run manually!
  38
  39 Logs / Shell access:
  40
  41 - there is some shortcuts in the makefile
  42
  43 Development:
  44
  45 - Install dependencies listed in 'Deployment'
  46 - run 'make build'
  47 - run 'make dev-up'
  48
  49     NOTE: DEBUG must be set to True in config.env when running development builds