summaryrefslogtreecommitdiffstats
path: root/dashboard/readme.txt
blob: 96ece9207250dba18b4ad040dd8ad82bed0dfb76 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
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'