digitaldemocratic/README.md

145 lines
6.7 KiB
Markdown
Raw Normal View History

[English](https://gitlab.com/digitaldemocratic/digitaldemocratic/-/blob/master/README_en.md) - [Català](https://gitlab.com/digitaldemocratic/digitaldemocratic/-/blob/master/README.md)
2021-05-06 12:18:11 +02:00
2021-07-21 17:34:30 +02:00
### Llicència
AGPLv3 (https://www.gnu.org/licenses/agpl-3.0.en.html)
### Crèdits
Projecte pilot del Pla de Digitalització Democràtica dirigit per Xnet i famílies promotores. Programari creat per IsardVDI i 3iPunt amb la col·laboració de MaadiX.net, Affac, lAjuntament de Barcelona y el Consorci d'Educació de Barcelona
# Què és això
2021-05-06 12:18:11 +02:00
Aquest projecte permet facilitar un proveïdor d'identitat complet i moltes aplicacions per tenir un entorn pensat per a escoles i universitats. El projecte proporcionarà una solució integrada per a gestionar l'entorn comú en l'educació:
- **Aules**: Una instància de Moodle amb tema personalitzat i connectors personalitzats.
- **Fitxers**: Una instància del Nextcloud amb tema personalitzat i connectors personalitzats.
- **Documents**: Una instància d'OnlyOffice integrada amb nextcloud.
- **Pàgines web**: Una instància de pressió de paraules amb el tema personalitzat i connectors personalitzats.
- **Pad**: Una instància etherpad integrada amb nextcloud.
- **Conferències**: Un BigBlueButton integrat amb moodle i nextcloud. Necessita un servidor independent.
- **Formularis**: Els connectors del nextcloud dels formularis.
- ... (algunes aplicacions com jitsi o BigBlueButton no estan totalment integrades ara mateix)
2021-05-06 12:18:11 +02:00
2021-05-06 12:25:18 +02:00
| | |
| ---------------------------- | ------------------------------- |
| ![](docs/img/classrooms.png) | ![](docs/img/cloud_storage.png) |
# Interfície d'administració
2021-06-06 23:34:56 +02:00
Ara hi ha una interfície d'administració que permet gestionar fàcilment usuaris i grups i mantenir-los sincronitzats entre aplicacions. Això es fa executant accions sobre les apis de les diferents aplicacions.
2021-06-06 23:34:56 +02:00
2021-06-06 23:38:32 +02:00
| ![](docs/img/admin_sync.png) | ![](docs/img/admin_user_edit.png) |
| ---------------------------- | --------------------------------- |
2021-06-06 23:34:56 +02:00
Per migrar i introduïr fàcilment usuaris i grups al sistema també hi ha dues importacions::
2021-06-06 23:34:56 +02:00
- Des de la consola d'administració de Google en format JSON
- Des d'un fitxer CSV
2021-06-06 23:34:56 +02:00
Aquesta interfície d'administració està en estat alfa, però ja permet gestionar usuaris sincronitzats entre keycloak, moodle i nextcloud.
2021-06-06 23:34:56 +02:00
# Estat del projecte
2021-05-06 12:18:11 +02:00
Funcional, però hi seguim treballant i tindrà moltes millores en els pròxims mesos. Cal fer algunes automatitzacions, especialment amb la integració de SAML a Moodle i Keycloak.
2021-05-06 12:25:18 +02:00
La vostra col·laboració és benvinguda! Podeu fer un *fork* del projecte per a desenvolupar o bé obrir-nos *incidències* en aquest repositori.
2021-05-06 12:18:11 +02:00
# Documentació DigitalDemocratic
2021-02-22 15:43:07 +01:00
Està escrita en markdown utilitzant [MkDocs+Gitlab](https://gitlab.com/pages/mkdocs).
2021-02-22 15:43:07 +01:00
Mire al directori `docs` els fitxers Markdown o bé a [auto-built site](https://digitaldemocratic.gitlab.io/digitaldemocratic).
2021-04-08 13:52:16 +02:00
## Inici ràpid
2021-04-08 13:52:16 +02:00
```
2021-05-19 12:52:36 +02:00
cp digitaldemocratic.conf.sample digitaldemocratic.conf
2021-04-08 13:52:16 +02:00
```
Canvia les contrasenyes per defecte
```
./securize_conf.sh
```
Editeu les variables de fitxer digitaldemocratic.conf per satisfer les vostres necessitats.
2021-04-08 13:52:16 +02:00
2021-05-19 12:52:36 +02:00
```
cp -R custom.sample custom
```
Edita i substitueix els fitxers per personalitzar el sistema.
2021-05-19 12:52:36 +02:00
2021-04-08 13:52:16 +02:00
```
2021-09-28 15:57:57 +02:00
./dd-ctl all
2021-04-08 13:52:16 +02:00
```
NOTA: L'autenticació SAML actualment es troba automatitzada:
- Moodle: No completament automatitzat.
1. Inicieu la sessió a moodle com a administrador via: https://moodle.\<domain\>/login/index.php?saml=off
2. Aneu a la configuració d'autenticació: https://moodle.\<domain\>/admin/settings.php?section=manageauths
3. Activa SAML2 fent clic a l'ull.
4. Clic a configuració* a SAML2
5. Feu clic al botó Regenera el certificat* dins del formulari. Després d'això, torna a la pàgina de configuració de SAML2.
6. Feu clic al botó Bloqueja el certificat*.
7. Al terminal executeu l'script per autoconfigure: acoblador exec isard-sso-admin python3 moodle_saml.py
8. L'última cosa és purgar la memòria cau de moodle: ]]femida l'script php-fpm7 de l'acoblador Exec, feu-ho a través de moodle ui]]
- Nextcloud: automatitzada. Després d'acabar el *make all* hauria d'estar llest. En cas que falla es refereix a isard-sso/docs.
- Wordpress: Pràcticament automatitzat. Després d'acabar el *make all* hauria d'estar llest i només caldrà activar el plugin. En cas que falla es refereix a isard-sso/docs.
2021-04-08 13:52:16 +02:00
## Instal.lació estesa
2021-05-06 12:18:11 +02:00
Podeu iniciar aquest projecte en qualsevol servidor amb docker & docker-compose (qualsevol sistema operatiu hauria de funcionar). Per a instal·lar aquests paquets a la vostra distribució, consulteu el funcionament de docker-compose a la documentació oficial i a la carpeta sysadm teniu alguns scripts d'automatització
2021-05-06 12:18:11 +02:00
Qualsevol distribució hauria de funcionar però, si voleu utilitzar els nostres scripts sysadm per instal·lar docker & docker-compose , utilitzeu Debian Buster (10).
2021-05-06 12:18:11 +02:00
### Clonar els submòduls
2021-05-06 12:18:11 +02:00
2021-05-28 11:50:29 +02:00
```
2021-05-06 12:18:11 +02:00
git clone https://gitlab.com/digitaldemocratic/digitaldemocratic/
cd digitaldemocratic
git submodule update --init --recursive
2021-05-28 11:50:29 +02:00
```
2021-05-06 12:18:11 +02:00
### docker
Referiu-vos a la documentació oficial (https://docs.docker.com/engine/install/) o utilitzeu l'script a la carpeta sysadm per a Debian Buster (10).
2021-05-06 12:18:11 +02:00
### docker-compose
Referiu-vos a la documentació oficial (https://docs.docker.com/compose/install/) o utilitzeu l'script a la carpeta sysadm per a Debian Buster (10).
2021-05-06 12:18:11 +02:00
2021-07-06 19:32:18 +02:00
### Configuració
2021-05-06 12:18:11 +02:00
2021-07-06 19:32:18 +02:00
Copieu digitaldemocratic.conf.exemple a digitaldemocratic.conf i editeu-lo per satisfer les vostres necessitats. Com a mínim (per a desenvolupament) heu d'adaptar la variable de DOMINI al vostre domini arrel.
2021-05-06 12:18:11 +02:00
2021-07-06 19:32:18 +02:00
- PRODUCCIÓ: Necessiteu un dns multidomini (o redirigeix els subdominis múltiples) a la vostra màquina d'amfitrió.
- Desenvolupament: Editeu el fitxer /etc/hosts i afegiu els subdominis per a propòsits de proves locals.
2021-05-06 12:18:11 +02:00
2021-07-06 19:32:18 +02:00
#### Subdominis
2021-05-06 12:18:11 +02:00
- Keycloak: sso.<yourdomain.org>
- Api: api.<yourdomain.org>
- Moodle: moodle.<yourdomain.org>
- Nextcloud: nextcloud.<yourdomain.org>
- Wordpress: wp.<yourdomain.org>
- Onlyoffice: oof.<yourdomain.org>
- Etherpad: pad.<yourdomain.org>
2021-07-06 19:32:18 +02:00
- (opcional) FreeIPA: ipa.<yourdomain.org>
2021-05-06 12:18:11 +02:00
2021-07-06 19:32:18 +02:00
### Personalització
2021-05-19 12:52:36 +02:00
2021-07-06 19:32:18 +02:00
Copia recursivament la carpeta *custom.sample* a *custom* i edita els fitxers yaml de personalització i menú i substitueix les imatges.
2021-05-19 12:52:36 +02:00
2021-07-06 19:32:18 +02:00
### Iniciar el projecte
2021-05-06 12:18:11 +02:00
```
2021-09-28 15:57:57 +02:00
./dd-ctl all
2021-05-06 12:18:11 +02:00
```
2021-06-06 23:47:54 +02:00
2021-07-06 19:32:18 +02:00
### Integració
2021-05-06 12:18:11 +02:00
2021-07-06 19:32:18 +02:00
Llegiu el fitxer [SAML_README.md](https://gitlab.com/isard/isard-sso/-/blob/master/docs/SAML_README.md) a la carpeta isard-sso/docs per integrar totes les aplicacions. Ara el Nextcloud i el Wordpress s'haurien d'integrar automàticament amb el Keycloak després d'acabar el *make all* excepte Moodle que encara necessita alguns passos manuals i el Wordpress que cal només activar el connector.
2021-07-05 17:32:33 +02:00