diff --git a/.vscode/settings.json b/.vscode/settings.json index 9ca376a..89862fc 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -1,13 +1,13 @@ { "markdown-pdf.stylesRelativePathFile": true, "markdown-pdf.styles": [ - "./misc/tools/cadoles_theme.css" + "tools/cadoles_theme.css" ], "markdown-pdf.breaks": true, "markdown-pdf.outputDirectory": "./", "markdown.extension.toc.levels": "2..6", "markdown-pdf.outputDirectoryRelativePathFile": true, - "markdown-pdf.headerTemplate": "
SHELA
Cadoles -
", + "markdown-pdf.headerTemplate": "
Envole
Cadoles -
", "esbonio.sphinx.confDir": "", "markdown-pdf.convertOnSave": true, "markdown-pdf.type": ["pdf","html"], diff --git a/doc/etude.html b/doc/etude.html index 001c898..d83f321 100644 --- a/doc/etude.html +++ b/doc/etude.html @@ -353,7 +353,7 @@ code { } - + @@ -365,8 +365,13 @@ code { : 'default' }); -

Envole

-

Introduction

+
+

logo

+
+
+

POC Envole

+
+

Introduction

Envole est une solution qui propose un ensemble d'applicatifs web fédérés autour d'un annaire afin de gérer l'identité ainsi qu'un SSO afin de gérer l'authentification.

Il s'appuit sur la distrution EOLE pour déployer ses différents composants.

Envole rencontre depuis des années des problèmatiques :

@@ -377,8 +382,8 @@ code {
  • Ou qui empéche le passage d'une application de fonctionner dans une version x d'eole car cette dernière propose une version trop résente de php pour l'application
  • Ce document va chercher à évaluer la possibilité de conteneriser les applications Envole, afin qu'elles puissent fonctionner le moins possible en contrainte avec la version d'Eole

    -

    Architecture

    -

    EoleBase

    +

    Architecture

    +

    EoleBase

    La présente étude part du principe qu'Envole ne serait plus installé sur une instance Scribe mais sur une installation EoleBase d'Eole

    Avantages

    -

    Paquet Debian

    +
    +
    +

    Paquet Debian

    Contrairement à la précédente logique Envole, il n'y aurait qu'un seul paquet Debian pour Envole. Il n'installerait pas les sources des applications, mais uniquement

    -

    POC

    +

    POC

    Afin de s'assurer de la faisabilité d'un tel changement, un POC a été initié, dans le cadre des éléments précédents cités. La première question fut de savoir quelle technologie de conteneurisation serait à utiliser PODMAN ou DOCKER, et dans leur logique de composer PODMAN-COMPOSE ou DOCKER-COMPOSER.

    -

    PODMAN vs DOCKER sur Eole

    +

    PODMAN vs DOCKER sur Eole

    PODMAN

    Eole a intégré à partir de la 2.9 dans sa distribution podman. Ce qui de prime abord devrait-être la technologie à utiliser, sauf que

    +
    +

    CONCLUSION

    Quoi qu'il arrive, une intégration compléte que cela soit avec Podman ou avec Docker, demandera un travail d'intégration d'Eole

    Ma préférence va malgrés tout sur Docker, il est plus souple moins verbeux et me semble plus fiable à long terme. Il serait possible de maitenir les deux solutions en parrallèle avec un effort supplémentaire d'intégration et de maintenance.

    -

    POC

    -

    Sources

    +

    POC

    +

    Sources

    Les sources du POC sont disponible ici
    https://forge.cadoles.com/Envole/envole

    Elles sont pour l'instant hébergé à Cadoles pour des raisons de simplicité de mise en oeuvre, mais à terme elles seront bien stockées chez Eole

    -

    Repository

    +

    Repository

    Certaines images sont hébergées elles aussi sur un repository public de Cadoles. Là aussi pour des raisons de simplicité de mise en oevre, mais à terme Eole devra fournir un repository propre aux images Envole.

    Les images en questions sont celles des applications maintenues par Envole, en l'occurence pour l'instant uniquement Ninegate. Mais à terme pourra aussi y figurer des images d'applications tiers sur lesquelles nous aurions besion d'altérer légèrement le comportement.

    -

    Installation du POC

    +

    Installation du POC

    1- Instancier un eolebase 2.9

    2- Installer eole-web

    apt-get install eole-web @@ -455,6 +464,8 @@ Applications Web > Nom de domaine des applications web = mondomaine.fr save & quit Reconfigure
    +
    +

    3- Installer docker & docker-compose

    apt install git make apt-transport-https ca-certificates curl gnupg-agent software-properties-common mkdir -p /etc/apt/keyrings @@ -474,6 +485,68 @@ cd /root/git/envole make install

    5- Configurer Envole

    +

    Le dictionnaire d'Envole dans genconfig est initalisé pour que l'on y indique un scribe distant.

    +

    6- Reconfigure

    +
    +
    +

    Complément sur variables Genconfig

    +
    +

    genconfig

    +
    +
    +
    +

    Maître de l'identité

    + +

    Mode d'Authentification
    +Il n'y a que Ninegate qui pour l'instant peut faire varier son mode d'authentification
    +A l'avenir on pourrait implémeter d'autre méthode d'authenfication, l'OPENID ou le SAML par exemple.

    + +

    Server CAS local
    +Si oui un conteneur Keycloak sera instancié qui sera préparamétré pour utiliser le procotole CAS en lien avec l'annuaire soit local soit distant déclaré dans le genconfig

    +

    ATTENTION = une foi instancié le serveur Keycloak ne prendra pas en compte des changement de paramétrage lié à l'annuaire

    +

    Base de Données
    +Si désactivé, l'ensemble des applications nécessitant une base de données ne pourront être activée.

    +

    Si distant, Envole ne fera pas le travail de créer les utilisateurs de base de données ainsi que les bases de données applicatives en elles-même. Cela sera à la charge d'un administrateur de réaliser ces tâches.

    +

    ATTENTION = une foi instancié les changement de login/password d'accès à la BDD ne seront pas appliqués

    +

    Annuaire
    +Le cas d'un annuaire local n'est utile que si le maître de l'authenfication est local.

    +

    ATTENTION = une foi instancié les changement de login/password d'accès à la BDD ne seront pas appliqués

    +

    Secrets
    +L'ensemble des secrets nécessaires. Comme indiqué plus haut un grand nombre d'entre eux ne peuvent être modifié après instanciation du service associé au secret : BDD / Annuaire / Keycloak

    +

    Nextcloud
    +Possiblité d'indiqué un partage Samba pour générer automatiquement un partage externe dans Nextcloud

    +
    +
    +

    Conclusion

    +

    Ce POC démontre qu'un modèle conteneriser d'Envole est tout à fait possible. Mais

    +

    Ce que le POC à montrer comme problème

    + +

    Ce que ne fait pas le POC

    + +

    Ce que le POC n'a pas du tout aborder

    + diff --git a/doc/etude.md b/doc/etude.md index e0aa9d3..816a836 100644 --- a/doc/etude.md +++ b/doc/etude.md @@ -1,6 +1,16 @@ -# Envole -## Introduction +::: title +![logo](./tools/logo.png) +::: + +::: title + +POC Envole + +::: + + +# Introduction Envole est une solution qui propose un ensemble d'applicatifs web fédérés autour d'un annaire afin de gérer l'identité ainsi qu'un SSO afin de gérer l'authentification. @@ -15,9 +25,9 @@ Envole rencontre depuis des années des problèmatiques : Ce document va chercher à évaluer la possibilité de conteneriser les applications Envole, afin qu'elles puissent fonctionner le moins possible en contrainte avec la version d'Eole -## Architecture +# Architecture -### EoleBase +## EoleBase La présente étude part du principe qu'Envole ne serait plus installé sur une instance Scribe mais sur une installation EoleBase d'Eole @@ -36,7 +46,11 @@ La présente étude part du principe qu'Envole ne serait plus installé sur une - Avoir un second nom de domaine pour l'accès aux applications Envole -### Paquet Debian +::: page-break + +::: + +## Paquet Debian Contrairement à la précédente logique Envole, il n'y aurait qu'un seul paquet Debian pour Envole. Il n'installerait pas les sources des applications, mais uniquement @@ -45,11 +59,11 @@ Contrairement à la précédente logique Envole, il n'y aurait qu'un seul paquet - le dossier de définitions de l'ensemble des conteneurs possible pour Envole - un script qui viendrait monter ou non les conteneurs souhaités par l'administateur -### POC +## POC Afin de s'assurer de la faisabilité d'un tel changement, un POC a été initié, dans le cadre des éléments précédents cités. La première question fut de savoir quelle technologie de conteneurisation serait à utiliser PODMAN ou DOCKER, et dans leur logique de composer PODMAN-COMPOSE ou DOCKER-COMPOSER. -### PODMAN vs DOCKER sur Eole +## PODMAN vs DOCKER sur Eole **PODMAN** @@ -70,6 +84,10 @@ Eole n'a pas intégré nativement docker. Mais il est tout à fait possible de l - Par la suite docker se comporte bien mieux que podman. Il est plus souple d'usage, moins verbeux - Mais tout comme podman, un reconfigure vient rendre totalement inopérant le reseau des conteneurs. Il est nécessaire de réinitialiser docker-ce pour rétablir le reseau. +::: page-break + +::: + **CONCLUSION** Quoi qu'il arrive, une intégration compléte que cela soit avec Podman ou avec Docker, demandera un travail d'intégration d'Eole @@ -78,22 +96,22 @@ Quoi qu'il arrive, une intégration compléte que cela soit avec Podman ou avec Ma préférence va malgrés tout sur Docker, il est plus souple moins verbeux et me semble plus fiable à long terme. Il serait possible de maitenir les deux solutions en parrallèle avec un effort supplémentaire d'intégration et de maintenance. -## POC +# POC -### Sources +## Sources Les sources du POC sont disponible ici https://forge.cadoles.com/Envole/envole Elles sont pour l'instant hébergé à Cadoles pour des raisons de simplicité de mise en oeuvre, mais à terme elles seront bien stockées chez Eole -### Repository +## Repository Certaines images sont hébergées elles aussi sur un repository public de Cadoles. Là aussi pour des raisons de simplicité de mise en oevre, mais à terme Eole devra fournir un repository propre aux images Envole. Les images en questions sont celles des applications maintenues par Envole, en l'occurence pour l'instant uniquement Ninegate. Mais à terme pourra aussi y figurer des images d'applications tiers sur lesquelles nous aurions besion d'altérer légèrement le comportement. -### Installation du POC +## Installation du POC 1- Instancier un eolebase 2.9 @@ -109,6 +127,10 @@ save & quit Reconfigure ``` +::: page-break + +::: + 3- Installer docker & docker-compose ``` apt install git make apt-transport-https ca-certificates curl gnupg-agent software-properties-common @@ -134,6 +156,100 @@ make install 5- Configurer Envole +Le dictionnaire d'Envole dans genconfig est initalisé pour que l'on y indique un scribe distant. + + +6- Reconfigure + + +::: page-break + +::: + +# Complément sur variables Genconfig + +::: img60 + +![genconfig](./img/genconfig.png) + +::: + +::: page-break + +::: + +**Maître de l'identité** +- **SQL** = c'est un cas bien particulier qui devrait pas vous concerner. C'est le cas où c'est Ninegate qui gére les utilisateurs et les groupes et qui va pousser ces informations dans un annuaire qui doit-être forcement local +- **LDAP** = c'est le cas classique d'un établissement scolaire. Ninegate synchronisera les utilisateurs et les groupes en fonction d'un annuaire distant. Cela pourrait-être aussi le cas d'usage d'un PIA qui a son propre annuaire. Tout dépendra du modèle d'annuaire déclaré dans le genconfig +- **SSO** = c'est le cas où il n'y a pas de synchronisation annuaire, mais que les applications se basent sur les attributs SSO pour autocreate et autoupdate les utilisateurs qui se connectent + + +**Mode d'Authentification** +Il n'y a que Ninegate qui pour l'instant peut faire varier son mode d'authentification +A l'avenir on pourrait implémeter d'autre méthode d'authenfication, l'OPENID ou le SAML par exemple. +- **SQL** = l'authentification se fait par le mécanisme interne à l'application. Pas de SSO dans ce cas. +- **LDAP** = l'authentification se fait via un bind sur l'annuaire. Pas de SSO dans ce cas. +- **CAS** = l'authentification se fait via le protocole CAS. Déclarer un serveur CAS dans ce cas est obligatoire. C'est le cas classique d'Envole à l'heure actuelle + + +**Server CAS local** +Si oui un conteneur Keycloak sera instancié qui sera préparamétré pour utiliser le procotole CAS en lien avec l'annuaire soit local soit distant déclaré dans le genconfig + +ATTENTION = une foi instancié le serveur Keycloak ne prendra pas en compte des changement de paramétrage lié à l'annuaire + + +**Base de Données** +Si désactivé, l'ensemble des applications nécessitant une base de données ne pourront être activée. + +Si distant, Envole ne fera pas le travail de créer les utilisateurs de base de données ainsi que les bases de données applicatives en elles-même. Cela sera à la charge d'un administrateur de réaliser ces tâches. + +ATTENTION = une foi instancié les changement de login/password d'accès à la BDD ne seront pas appliqués + + +**Annuaire** +Le cas d'un annuaire local n'est utile que si le maître de l'authenfication est local. + +ATTENTION = une foi instancié les changement de login/password d'accès à la BDD ne seront pas appliqués + + +**Secrets** +L'ensemble des secrets nécessaires. Comme indiqué plus haut un grand nombre d'entre eux ne peuvent être modifié après instanciation du service associé au secret : BDD / Annuaire / Keycloak + + +**Nextcloud** +Possiblité d'indiqué un partage Samba pour générer automatiquement un partage externe dans Nextcloud + +::: page-break + +::: + +# Conclusion + +Ce POC démontre qu'un modèle conteneriser d'Envole est tout à fait possible. Mais + +**Ce que le POC à montrer comme problème** +- Des versions trop anciennes que cela soit sur Podman ou Docker +- Un problème de variable d'environnement via Podman qui n'accepte pas de surcouche de variables +- Des problèmatiques de réseau après reconfigure à résoudre par EOLE +- Sur scribe29 : Nextcloud et Roundcube sont préinstallés. Si demain on souhaite mettre Envole sur scribe il faudra enlever cette dépendance. + +**Ce que ne fait pas le POC** +- Changer les secrets après instanciation +- Changer la configuration Keycloak après instanciation + +**Ce que le POC n'a pas du tout aborder** +- Comment migrer de la version actuelle d'Envole vers ce modèle +- Comment gérer la mise à jour des conteneurs (monté de version des applications) +- Comment intégrer les scripts de synchronisation annuaire sur les applications qui n'ont pas de mécanisme interne (poshprofil) +- Comment intégrer la sonde statistique +- Comment envoyer du mail (service scribe imap/smtp CASsifié sur le scribe et très complexe à utiliser à distance) + + + + + + + diff --git a/doc/etude.pdf b/doc/etude.pdf index bea1606..4b63a0d 100644 Binary files a/doc/etude.pdf and b/doc/etude.pdf differ diff --git a/doc/img/genconfig.png b/doc/img/genconfig.png new file mode 100644 index 0000000..079c49f Binary files /dev/null and b/doc/img/genconfig.png differ diff --git a/doc/tools/cadoles_theme.css b/doc/tools/cadoles_theme.css new file mode 100644 index 0000000..c82b60b --- /dev/null +++ b/doc/tools/cadoles_theme.css @@ -0,0 +1,143 @@ +@font-face { + font-family: "Roboto"; + src: url("fonts/Roboto/Roboto-Regular.ttf") format('truetype'); +} + +@font-face { + font-family: "Theboldefont"; + src: url("fonts/Theboldfont/THE BOLD FONT - FREE VERSION - 2023.ttf") format('truetype'); +} + +body { + font-family: "Roboto" !important; + color: #333; + max-width: 1200px; + margin: auto; +} + +.title { + color: #078eb5; + text-transform: uppercase; + font-size: 3em; + margin-top:30px; + text-align: center; + line-height: 1em; + font-weight: bold; + font-family: "Theboldefont" !important; +} + +.title img { + width: 80%; +} + +h1, h2, h3 { + font-family: "Theboldefont" !important; +} + +h1 { + text-transform: uppercase; + page-break-before: always; +} + +h2 { + text-transform: uppercase; + text-decoration: underline; +} + +h3 { + text-decoration: underline; +} + +a, a:hover, a:visited , h1, h2, h3, h4, h5, h6 { + color: #078eb5; + font-weight: bold +} + +img { + max-width:100%; + margin:auto; + display: block; + text-align:center; +} + +.center { + text-align: center; +} + +strong { + color: #078eb5; +} + +footer img { + width: 32px; +} + +.info, +.success, +.warning, +.danger { + padding: 1rem; + margin-bottom: 1rem; +} + +.info { + background-color: rgba(41, 128, 185, .1); + border-left: solid 4px rgba(41, 128, 185,1.0); + color: rgba(41, 128, 185,1.0); +} + +.success { + background-color: rgba(39, 174, 96, .1); + border-left: solid 4px rgba(39, 174, 96,1.0); + color:rgba(39, 174, 96,1.0); +} + +.warning { + padding: 1rem; + background-color: rgba(243, 156, 18, .1); + border-left: solid 4px #f39c12; + color: #f39c12; +} + +.danger { + background-color: rgba(231, 76, 60, .1); + border-left: solid 4px rgba(231, 76, 60,1.0); + color: rgba(231, 76, 60,1.0); +} + +.page-break { + page-break-after: always; +} + +.center { + text-align: center; +} + +table { + width:100%; +} + +table > thead > tr > th { + border: 1px solid; + text-align:center; +} + +table > tbody > tr > td { + border: 1px solid; +} + +.matriceresponsabilites { + text-align:center; + font-size: 10px; +} + +.matriceresponsabilites td:nth-child(2) { + text-align:left; +} + +.matriceresponsabilites td { + padding: 2px; +} + +.img50 {margin:auto; width:50%} +.img60 {margin:auto; width:60%} \ No newline at end of file diff --git a/doc/tools/e-ihm.sh b/doc/tools/e-ihm.sh new file mode 100755 index 0000000..75fab37 --- /dev/null +++ b/doc/tools/e-ihm.sh @@ -0,0 +1,186 @@ +#!/bin/bash + +TPUT=/usr/bin/tput +#test si TPUT est utilisable +if [ ! "$TERM" = "" ] && $TPUT hpa 60 >/dev/null 2>&1 && $TPUT setaf 1 >/dev/null 2>&1; then + FANCYTTY=1 +else + FANCYTTY=0 +fi + +Pause() { +if [ "$ModeTxt" == "yes" ];then + echo +elif [ "$ModeEad" == "yes" ];then + echo "
    " +else + [ $FANCYTTY = 1 ] && $TPUT setaf 6 + echo " Appuyez sur Entrée pour continuer ..." + [ $FANCYTTY = 1 ] && $TPUT sgr0 + read BiDon +fi +} + +Echo() { +if [ "$ModeEad" != "yes" ]; +then + echo "$1" +else + echo "$1
    " +fi +} + +EchoColor() { +if [ "$ModeTxt" = "yes" ];then + echo "$1" +elif [ "$ModeEad" = "yes" ];then + echo " $1
    " +else + [ "$FANCYTTY" = 1 ] && $TPUT setaf $2 + echo "$1" + [ "$FANCYTTY" = 1 ] && $TPUT sgr0 +fi +} + +EchoRouge() { + EchoColor "$1" "1" "red" +} + +EchoVert() { + EchoColor "$1" "2" "green" +} + +EchoOrange() { + EchoColor "$1" "3" "orange" +} + +EchoBleu() { + EchoColor "$1" "4" "blue" +} + +EchoMagenta() { + EchoColor "$1" "5" "magenta" +} + +EchoCyan() { + EchoColor "$1" "6" "cyan" +} + +EchoBlanc() { + EchoColor "$1" "7" "white" +} + +EchoGras() { +if [ "$ModeTxt" == "yes" ];then + echo "$1" +elif [ "$ModeEad" == "yes" ];then + echo " $1
    " +else + [ $FANCYTTY = 1 ] && $TPUT bold + echo "$1" + [ $FANCYTTY = 1 ] && $TPUT sgr0 +fi +} + +Clear() { +if [ "$ModeEad" != "yes" -a "$ModeTxt" != "yes" ];then + clear +fi +} + +Question_ouinon() { + #attention, il faut synchroniser les modifications avec /usr/share/pyshared/pyeole/ihm.py + question=$1 + [ "$2" = "" ] && interactive='True' || interactive=$2 + [ "$3" = "" ] && default="non" || default=$3 + [ "$4" = "" ] && level="info" || level=$4 + [ "$5" = "" ] && default_uninteractive=$default || default_uninteractive=$5 + [ ! "$interactive" = "True" ] && [ ! "$interactive" = "False" ] && echo "Question_ouinon : interactive doit être True ou False" && exit 1 + [ ! "$default" = "oui" ] && [ ! "$default" = "non" ] && echo "Question_ouinon : default doit etre oui ou non" && exit 1 + [ ! "$default_uninteractive" = "oui" ] && [ ! "$default_uninteractive" = "non" ] && echo "Question_ouinon : default_uninteractive doit etre oui ou non" && exit 1 + [ ! "$level" = "info" ] && [ ! "$level" = "warn" ] && [ ! "$level" = "err" ] && echo "Question_ouinon : level doit etre info, warn ou err" && exit 1 + #non interactive + if [ "$interactive" = "False" ]; then + Rep=default_uninteractive + else + question="$question [oui/non]" + if [ $level = "info" ]; then + echo "$question" + elif [ $level = "warn" ]; then + EchoOrange "$question" + else + EchoRouge "$question" + fi + echo -n "[$default] : " + read Rep + #passe en minuscule + Rep=`echo $Rep | tr A-Z a-z` + fi + if [ "$default" = "non" ]; then + if [ "$Rep" = "oui" -o "$Rep" = "o" -o "$Rep" = "yes" -o "$Rep" = "y" ];then + return 0 + else + return 1 + fi + else + if [ "$Rep" = "non" -o "$Rep" = "n" -o "$Rep" = "no" ];then + return 1 + else + return 0 + fi + fi +} + +EchoStart() { + for i in $(eval echo "{1..30}") + do + ligne+="=" + done + clear +} + +BigTitle(){ + size=`tput cols` + nb=${#1} + nbchar=$(($size - $nb - 4)) + + ligne="" + for i in $(eval echo "{1..$size}") + do + ligne+="=" + done + + finligne="" + for i in $(eval echo "{1..$nbchar}") + do + finligne+="=" + done + + echo + EchoVert $ligne + EchoVert "== $1 $finligne" + EchoVert $ligne + echo +} + +Title(){ + size=`tput cols` + nb=${#1} + nbchar=$(($size - $nb - 4)) + + ligne="" + for i in $(eval echo "{1..$size}") + do + ligne+="=" + done + + finligne="" + for i in $(eval echo "{1..$nbchar}") + do + finligne+="=" + done + + echo + EchoCyan "== $1 $finligne" + echo +} diff --git a/doc/tools/e-reconfigure.sh b/doc/tools/e-reconfigure.sh new file mode 100755 index 0000000..767794b --- /dev/null +++ b/doc/tools/e-reconfigure.sh @@ -0,0 +1,29 @@ +#!/bin/bash +. /usr/share/envole/docker/misc/e-ihm.sh + +RunCmd=CreoleRun + +clear +BigTitle "RECONFIGURE ENVOLE" +container_path_web=$(CreoleGet container_path_web non) + +Title "Rafraichissement creoled" +service creoled restart + +Title "Generation templates" +FILES="/usr/share/eole/creole/distrib/envole*" +for f in $FILES +do + if [ -f "$f" ] + then + EchoRouge $(basename $f) + CreoleCat -t $(basename $f) + fi +done + +Title "Restart apache" +service apache2 restart + +chmod +x $container_path_web/usr/share/envole/docker/envole.sh +$RunCmd "cd /usr/share/envole/docker && ./envole.sh" web + diff --git a/doc/tools/fonts/Roboto/LICENSE.txt b/doc/tools/fonts/Roboto/LICENSE.txt new file mode 100644 index 0000000..75b5248 --- /dev/null +++ b/doc/tools/fonts/Roboto/LICENSE.txt @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/doc/tools/fonts/Roboto/Roboto-Black.ttf b/doc/tools/fonts/Roboto/Roboto-Black.ttf new file mode 100644 index 0000000..2d45238 Binary files /dev/null and b/doc/tools/fonts/Roboto/Roboto-Black.ttf differ diff --git a/doc/tools/fonts/Roboto/Roboto-BlackItalic.ttf b/doc/tools/fonts/Roboto/Roboto-BlackItalic.ttf new file mode 100644 index 0000000..29a4359 Binary files /dev/null and b/doc/tools/fonts/Roboto/Roboto-BlackItalic.ttf differ diff --git a/doc/tools/fonts/Roboto/Roboto-Bold.ttf b/doc/tools/fonts/Roboto/Roboto-Bold.ttf new file mode 100644 index 0000000..d998cf5 Binary files /dev/null and b/doc/tools/fonts/Roboto/Roboto-Bold.ttf differ diff --git a/doc/tools/fonts/Roboto/Roboto-BoldItalic.ttf b/doc/tools/fonts/Roboto/Roboto-BoldItalic.ttf new file mode 100644 index 0000000..b4e2210 Binary files /dev/null and b/doc/tools/fonts/Roboto/Roboto-BoldItalic.ttf differ diff --git a/doc/tools/fonts/Roboto/Roboto-Italic.ttf b/doc/tools/fonts/Roboto/Roboto-Italic.ttf new file mode 100644 index 0000000..5b390ff Binary files /dev/null and b/doc/tools/fonts/Roboto/Roboto-Italic.ttf differ diff --git a/doc/tools/fonts/Roboto/Roboto-Light.ttf b/doc/tools/fonts/Roboto/Roboto-Light.ttf new file mode 100644 index 0000000..3526798 Binary files /dev/null and b/doc/tools/fonts/Roboto/Roboto-Light.ttf differ diff --git a/doc/tools/fonts/Roboto/Roboto-LightItalic.ttf b/doc/tools/fonts/Roboto/Roboto-LightItalic.ttf new file mode 100644 index 0000000..46e9bf7 Binary files /dev/null and b/doc/tools/fonts/Roboto/Roboto-LightItalic.ttf differ diff --git a/doc/tools/fonts/Roboto/Roboto-Medium.ttf b/doc/tools/fonts/Roboto/Roboto-Medium.ttf new file mode 100644 index 0000000..f714a51 Binary files /dev/null and b/doc/tools/fonts/Roboto/Roboto-Medium.ttf differ diff --git a/doc/tools/fonts/Roboto/Roboto-MediumItalic.ttf b/doc/tools/fonts/Roboto/Roboto-MediumItalic.ttf new file mode 100644 index 0000000..5dc6a2d Binary files /dev/null and b/doc/tools/fonts/Roboto/Roboto-MediumItalic.ttf differ diff --git a/doc/tools/fonts/Roboto/Roboto-Regular.ttf b/doc/tools/fonts/Roboto/Roboto-Regular.ttf new file mode 100644 index 0000000..2b6392f Binary files /dev/null and b/doc/tools/fonts/Roboto/Roboto-Regular.ttf differ diff --git a/doc/tools/fonts/Roboto/Roboto-Thin.ttf b/doc/tools/fonts/Roboto/Roboto-Thin.ttf new file mode 100644 index 0000000..4e797cf Binary files /dev/null and b/doc/tools/fonts/Roboto/Roboto-Thin.ttf differ diff --git a/doc/tools/fonts/Roboto/Roboto-ThinItalic.ttf b/doc/tools/fonts/Roboto/Roboto-ThinItalic.ttf new file mode 100644 index 0000000..eea836f Binary files /dev/null and b/doc/tools/fonts/Roboto/Roboto-ThinItalic.ttf differ diff --git a/doc/tools/fonts/Theboldfont/THE BOLD FONT - FREE VERSION - 2023.otf b/doc/tools/fonts/Theboldfont/THE BOLD FONT - FREE VERSION - 2023.otf new file mode 100644 index 0000000..10b9f20 Binary files /dev/null and b/doc/tools/fonts/Theboldfont/THE BOLD FONT - FREE VERSION - 2023.otf differ diff --git a/doc/tools/fonts/Theboldfont/THE BOLD FONT - FREE VERSION - 2023.ttf b/doc/tools/fonts/Theboldfont/THE BOLD FONT - FREE VERSION - 2023.ttf new file mode 100644 index 0000000..34b573d Binary files /dev/null and b/doc/tools/fonts/Theboldfont/THE BOLD FONT - FREE VERSION - 2023.ttf differ diff --git a/doc/tools/fonts/Theboldfont/THE BOLD FONT - LICENSE - 2023.rtf b/doc/tools/fonts/Theboldfont/THE BOLD FONT - LICENSE - 2023.rtf new file mode 100644 index 0000000..0464261 --- /dev/null +++ b/doc/tools/fonts/Theboldfont/THE BOLD FONT - LICENSE - 2023.rtf @@ -0,0 +1,41 @@ +{\rtf1\ansi\ansicpg1252\cocoartf1504\cocoasubrtf840 +{\fonttbl\f0\fswiss\fcharset0 Helvetica;} +{\colortbl;\red255\green255\blue255;\red0\green0\blue0;\red255\green255\blue255;} +{\*\expandedcolortbl;;\csgenericrgb\c0\c0\c0;\cssrgb\c100000\c100000\c100000;} +\paperw11900\paperh16840\margl1440\margr1440\vieww10800\viewh8400\viewkind0 +\pard\tx566\tx1133\tx1700\tx2267\tx2834\tx3401\tx3968\tx4535\tx5102\tx5669\tx6236\tx6803\pardirnatural\partightenfactor0 + +\f0\fs24 \cf0 \ +Thank you for downloading \ + +\b\fs28 THE BOLD FONT. +\b0\fs24 \ +\ +It is a 100% free font so you can use it as much as you like for whatever you like.\ +Of course every donation for my effort would be highly appreciated. You can find a donate button on the DaFont page where you downloaded the font.\ +\ +Did you know that there is also a +\b PRO +\b0 version available. It comes with lowercase characters and has way more glyphs that the free version. You can get it at:\ +\ +{\field{\*\fldinst{HYPERLINK "https://the-bold-font.com/"}}{\fldrslt +\b\fs28 WWW.THE-BOLD-FONT.COM }} +\b \ + +\b0 \ +Thank you so much and have fun designing with +\b\fs28 THE BOLD FONT +\b0\fs24 !\ +\ +\ +\pard\pardeftab720\sl380\partightenfactor0 +\cf2 \cb3 \expnd0\expndtw0\kerning0 +Yours sincerely,\ +Sven Pels\ + +\b\fs28 THE BOLD FONT.\ + +\b0\fs24 \ +Copyright \'a9 2023 +\b THE BOLD FONT. +\b0 Sven Pels. All rights reserved.} \ No newline at end of file diff --git a/doc/tools/fonts/Theboldfont/THE BOLD FONT - VISUAL - PRO.jpg b/doc/tools/fonts/Theboldfont/THE BOLD FONT - VISUAL - PRO.jpg new file mode 100644 index 0000000..a19bf9d Binary files /dev/null and b/doc/tools/fonts/Theboldfont/THE BOLD FONT - VISUAL - PRO.jpg differ diff --git a/doc/tools/logo.png b/doc/tools/logo.png new file mode 100644 index 0000000..829329a Binary files /dev/null and b/doc/tools/logo.png differ diff --git a/misc/tools/logo.png b/misc/tools/logo.png index 6b0753a..829329a 100644 Binary files a/misc/tools/logo.png and b/misc/tools/logo.png differ