Skip to main content

Tipboard - a flexible solution for creating your dashboards.

Project description

Tipboard

docs redhat python37:rhel7 bitnami python:3.7 django 2.0

/ C.I C.D Release
Gitlab Gitlab Build status pipeline success docker_hub gitlab:1.0.0
Azure Travis Build Status pipeline success docker_hub azure:1.0.0
AWS CircleCI Gitlab Build status docker_hub aws:1.0.0
Openshift Travis Build Status deploy success helm tipboard:1.0.0
Travis Travis Build Status
Docker Docker build docker stars
Pypi 3 Travis Build Status Travis Build Status PyPI version Python >=3.7
Pypi 2 Gitlab Build status Gitlab Build status PyPI version Python 2.7

|

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.

Source Distribution

tipboard2.0-2.0.6.tar.gz (548.9 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page