Tipboard - a flexible solution for creating your dashboards.
Project description
Tipboard
/ | C.I | C.D | Release |
---|---|---|---|
Gitlab | |||
Azure | |||
AWS | |||
Openshift | |||
Travis | |||
Docker | |||
Pypi 3 | |||
Pypi 2 |
|
Introduction
Tipboard is a system for creating dashboards, written in JavaScript and Python. Its widgets ('tiles' in Tipboard's terminology) are completely separated from data sources, which provides great flexibility and relatively high degree of possible customizations.
Because of its intended target (displaying various data and statistics in your office), it is optimized for larger screens.
A detailed, technical documentation for Tipboard can be found here.
Quick start
Execution by python
Some required packages need to be present, and python3.7 is required now
$ sudo apt-get install python-dev python-virtualenv redis-server
Install with python dependencies on virtual env
$ virtualenv tb-env # create virtual env
$ source tb-env/bin/activate # activate virtual env
$ (tb-env)$ install -r requirements.txt # install python lib
$ (tb-env)$ tipboard create_project my_test_dashboard
$ (tb-env)$ python manage.py runserver # start webserver
Install with python dependencies on system
$ pip install -r requirements.txt
$ python manage.py runserver
Execution by docker
It's a non-root bitnami/python3.7 image
By git source
$ docker build -t tipboard:local .
$ docker run -p 8080:8080 tipboard:local
By docker hub
$ docker pull themaux/tipboard
$ docker run -p 8080:8080 themaux/tipboard
Remove redis from contener
1 - In Dockerfile, comment line 3 `RUN apt-get update && apt-get install redis-server -y`
2 - In entrypoint.sh, comment line 2 `nohup redis-server &`
3 - Change the value *REDIS_HOST* & *REDIS_PASSWORD* in the tipboard/Config/properties.json
Execution on cloud
Deploy on AWS
# From sources git source
$ eb init -p docker tipboard-aws
$ eb create --single
$ eb status
$ eb open
Deploy on Openshift
# From docker hub
$ oc new-app themaux/tipboard
# Update the config_layout.yaml
$ oc apply -f ./helm/tipboard-charts-deploy/manifests/tipboard-ops/charts/config/templates/tipboard-configmap.yaml
Deploy on Azure
# From docker hub
$ oc new-app themaux/tipboard
# Update the config_layout.yaml
$ oc apply -f ./helm/tipboard-charts-deploy/manifests/tipboard-ops/charts/config/templates/tipboard-configmap.yaml
Deploy on clusters kubernets
# Build helm package
$ helm package ./helm/tipboard-charts-template/python3-tipboard --save=false -d ./helm/charts/tipboard-charts-deploy
# Build deployment helm template
$ mkdir manifests
$ helm template --values tipboard_helm.yaml --name tipboard --output-dir ./manifests .
# Deploy manifest
$ oc apply -R -f ./manifests || helm install --name tipboard MY_PATH_ENVIRONMENT
License
Tipboard is licensed under the Apache License, v2.0.
Copyright (c) 2013-2017 Allegro Group.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.