Developer Guide

Welcome to the Borgia developer guide. These documents teach you how to use Borgia as a developer.

You will learn in this guide :

• Installation for development

• Installation for a production solution

• How to use production Ansible script

• Installation of a logging and monitoring solution based on Grafana

• Structure and organization of the project

Borgia basic dependencies are :

• Django : Borgia run with the django framework

• django-bootstrap-form : To use bootstrap with django

• django-static-precompiler : For static files

• djangorestframework : For API

• openpyxl : For excel manipulation

• Pillow : For users images

If you want to develop your own solution or extension from Borgia, do not hesitate to make a fork of this project, it is under the GNU GPL v3 license.

The basic concepts to know before embarking on development are:

• Principles of web development

• Web development tools: HTML, CSS, JavaScript

• Basics of Python and the Django framework.

• Knowledge of databases (PostgreSQL)

But no problem if you don’t master everything, Borgia is a great learning opportunity.

• Development setup
  • Documentation - Installation
  • Introduction
  • Installing dependencies
  • Configuring settings.py
  • Migrations and initial data
  • Run local server
  • Tests
• Production setup
  • Documentation - Installation
  • Introduction
  • First server configuration
  • Before starting
    • Update the server:
    • Remove Apache if installed:
    • Install necessary packages for the rest of the installation:
    • Install all necessary packages:
    • Creating the PostgreSQL Database and User
    • Installation of Yarn
    • Create the Borgia root folder:
  • Copy of Borgia
    • Creating a Python Virtual Environment for your Project
  • Installation of packages necessary for the application
  • Software configuration
    • Vital parameters
    • Database
    • Mail server
    • Administrators
  • Database migration
  • Intermediate test
    • UFW configuration
    • Run the server
  • Optionnal : testing Gunicorn’s ability to serve the project
  • Deactivate the venv
  • Creating systemd Socket and Service Files for Gunicorn
    • Checking for the Gunicorn Socket File
    • Testing Socket Activation
  • Configure Nginx to Proxy Pass to Gunicorn
    • Allow Nginx through the UFW firewall
  • Save to git
• Grafana monitoring
  • Installation of libraries
  • Django application log system
  • Install Grafana
  • Deploy your Grafana instance on the web
  • Virtual machine use case (Proxmox VM)
  • Install Loki and Promtail
  • Add the Grafana container to the loki network
  • Add Loki to Grafana.
• Prometheus install
  • Install django-prometheus package
  • Prometheus install
  • Add Prometheus data source to Grafana
  • Creation of the Django monitoring panel