Added catalan version and added credits
darta
parent
19b42e9f3a
commit
fc9685164a
95
README.md
95
README.md
|
|
@ -1,91 +1,94 @@
|
||||||
# What's this
|
[English](https://gitlab.com/digitaldemocratic/digitaldemocratic/-/blob/master/README_en.md) - [Català](https://gitlab.com/digitaldemocratic/digitaldemocratic/-/blob/master/README.md)
|
||||||
|
|
||||||
This project allows to bring up with ease a full identity provider and many apps to have an environment thought for schools and universities. The project will provide an integrated solution to handle the common environment in education:
|
# Què és això
|
||||||
|
|
||||||
- **Classrooms**: A moodle instance with custom theme and custom plugins.
|
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ó:
|
||||||
- **Cloud drive**: A nextcloud instance with custom theme and custom plugins.
|
|
||||||
- **Documents**: An onlyoffice instance integrated with nextcloud.
|
- **Aules**: Una instància de Moodle amb tema personalitzat i connectors personalitzats.
|
||||||
- **Web pages**: A wordpress instance with custom theme and custom plugins.
|
- **Fitxers**: Una instància del Nextcloud amb tema personalitzat i connectors personalitzats.
|
||||||
- **Pad**: An etherpad instance integrated with nextcloud.
|
- **Documents**: Una instància d'OnlyOffice integrada amb nextcloud.
|
||||||
- **Conferences**: A BigBlueButton integrated with moodle and nextcloud. This needs an standalone host right now
|
- **Pàgines web**: Una instància de pressió de paraules amb el tema personalitzat i connectors personalitzats.
|
||||||
- **Forms**: A forms nextcloud plugins.
|
- **Pad**: Una instància etherpad integrada amb nextcloud.
|
||||||
- ... (some apps are there like jitsi or BigBlueButton but not fully integrated right now)
|
- **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)
|
||||||
|
|
||||||
| | |
|
| | |
|
||||||
| ---------------------------- | ------------------------------- |
|
| ---------------------------- | ------------------------------- |
|
||||||
|  |  |
|
|  |  |
|
||||||
|
|
||||||
# Administration interface
|
# Interfície d'administració
|
||||||
|
|
||||||
Now there is an administration interface that allows to easily manager users and groups and keep it in sync between applications. This is done by executing actions on the applications apis.
|
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.
|
||||||
|
|
||||||
|  |  |
|
|  |  |
|
||||||
| ---------------------------- | --------------------------------- |
|
| ---------------------------- | --------------------------------- |
|
||||||
|
|
||||||
To easily migrate and populate system there are also two provided imports for users and groups:
|
Per migrar i introduïr fàcilment usuaris i grups al sistema també hi ha dues importacions::
|
||||||
|
|
||||||
- From Google Admin Console as a JSON dump
|
- Des de la consola d'administració de Google en format JSON
|
||||||
- From a CSV file
|
- Des d'un fitxer CSV
|
||||||
|
|
||||||
This admin interface is now in an alpha status but allows to manage users in sync between keycloak, moodle and nextcloud.
|
Aquesta interfície d'administració està en estat alfa, però ja permet gestionar usuaris sincronitzats entre keycloak, moodle i nextcloud.
|
||||||
|
|
||||||
# Project status
|
# Estat del projecte
|
||||||
|
|
||||||
It works but as we are working on it it will have lots of improvements upcoming months. Some automatizations need to be done, specially with SAML integration in moodle and Keycloak initial personalization.
|
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.
|
||||||
|
|
||||||
Your collaboration is wellcome! Just fork this repo and do a PR or open us an issue.
|
La vostra col·laboració és benvinguda! Podeu fer un *fork* del projecte per a desenvolupar o bé obrir-nos *incidències* en aquest repositori.
|
||||||
|
|
||||||
# DigitalDemocratic Documentation
|
# Documentació DigitalDemocratic
|
||||||
|
|
||||||
This documentation is writed in Markdown using [MkDocs+Gitlab](https://gitlab.com/pages/mkdocs).
|
Està escrita en markdown utilitzant [MkDocs+Gitlab](https://gitlab.com/pages/mkdocs).
|
||||||
|
|
||||||
See `docs` directory for Markdown files or the [auto-built site](https://digitaldemocratic.gitlab.io/digitaldemocratic).
|
Mire al directori `docs` els fitxers Markdown o bé a [auto-built site](https://digitaldemocratic.gitlab.io/digitaldemocratic).
|
||||||
|
|
||||||
## Quick start
|
## Inici ràpid
|
||||||
|
|
||||||
```
|
```
|
||||||
cp digitaldemocratic.conf.sample digitaldemocratic.conf
|
cp digitaldemocratic.conf.sample digitaldemocratic.conf
|
||||||
```
|
```
|
||||||
|
|
||||||
Change default passwords
|
Canvia les contrasenyes per defecte
|
||||||
|
|
||||||
```
|
```
|
||||||
./securize_conf.sh
|
./securize_conf.sh
|
||||||
```
|
```
|
||||||
|
|
||||||
Edit digitaldemocratic.conf file variables to suit your needs.
|
Editeu les variables de fitxer digitaldemocratic.conf per satisfer les vostres necessitats.
|
||||||
|
|
||||||
```
|
```
|
||||||
cp -R custom.sample custom
|
cp -R custom.sample custom
|
||||||
```
|
```
|
||||||
|
|
||||||
Edit and replace files to personalize system.
|
Edita i substitueix els fitxers per personalitzar el sistema.
|
||||||
|
|
||||||
```
|
```
|
||||||
make all
|
make all
|
||||||
```
|
```
|
||||||
|
|
||||||
NOTE: The SAML Auth in plugin automation status now is:
|
NOTA: L'autenticació SAML actualment es troba automatitzada:
|
||||||
- Moodle: Not fully automated.
|
|
||||||
1. Login to moodle as admin via: https://moodle.\<domain\>/login/index.php?saml=off
|
|
||||||
2. Go to authentication configuration: https://moodle.\<domain\>/admin/settings.php?section=manageauths
|
|
||||||
3. Enable SAML2 clicking the eye.
|
|
||||||
4. Clic on *configuration* on SAML2
|
|
||||||
5. Click on the *Regenerate certificate* button inside the form. After that go back to SAML2 configuration page.
|
|
||||||
6. Click on the *Lock certificate* button.
|
|
||||||
7. In the terminal execute the script to autoconfigure: docker exec isard-sso-admin python3 moodle_saml.py
|
|
||||||
8. The last thing is to purge moodle cache: [[missing docker exec php-fpm7 script, do it through moodle web ui]]
|
|
||||||
|
|
||||||
- Nextcloud: Fully automated. After finishing the *make all* should be ready. In case it fails refer to isard-sso/docs.
|
- Moodle: No completament automatitzat.
|
||||||
- Wordpress: Fully automated. After finishing the *make all* should be ready. In case it fails refer to isard-sso/docs.
|
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]]
|
||||||
|
|
||||||
## Extended
|
- 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.
|
||||||
|
|
||||||
You can start this project in any docker & docker-compose host (any OS should work). To install those packages in your distro refer to docker & docker-compose in this documentation and in the sysadm folder you have some scripts.
|
## Instal.lació estesa
|
||||||
|
|
||||||
Any distro should work but, if you want to use our sysadm scripts to install docker & docker compose use Debian Buster (10).
|
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ó
|
||||||
|
|
||||||
### Clone and submodules
|
Qualsevol distribució hauria de funcionar però, si voleu utilitzar els nostres scripts sysadm per instal·lar docker & docker-compose , utilitzeu Debian Buster (10).
|
||||||
|
|
||||||
|
### Clonar els submòduls
|
||||||
|
|
||||||
```
|
```
|
||||||
git clone https://gitlab.com/digitaldemocratic/digitaldemocratic/
|
git clone https://gitlab.com/digitaldemocratic/digitaldemocratic/
|
||||||
|
|
@ -95,11 +98,11 @@ git submodule update --init --recursive
|
||||||
|
|
||||||
### docker
|
### docker
|
||||||
|
|
||||||
Refer to the official documentation (https://docs.docker.com/engine/install/) or use our sysadm script if you are on a Debian Buster (10).
|
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).
|
||||||
|
|
||||||
### docker-compose
|
### docker-compose
|
||||||
|
|
||||||
Refer to the official documentation (https://docs.docker.com/compose/install/) or use our sysadm script if you are on a Debian Buster (10).
|
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).
|
||||||
|
|
||||||
### Settings
|
### Settings
|
||||||
|
|
||||||
|
|
@ -134,3 +137,7 @@ Please read the [SAML_README.md](https://gitlab.com/isard/isard-sso/-/blob/maste
|
||||||
### License
|
### License
|
||||||
|
|
||||||
AGPLv3 (https://www.gnu.org/licenses/agpl-3.0.en.html)
|
AGPLv3 (https://www.gnu.org/licenses/agpl-3.0.en.html)
|
||||||
|
|
||||||
|
### Credits
|
||||||
|
|
||||||
|
Pilot project of the Democratic Digitalization Plan led by Xnet and promoting families. Software created by IsardVDI and 3iPunt in collaboration with MaadiX.net, Affac, Barcelona City Council and the Barcelona Education Consortium
|
||||||
|
|
|
||||||
|
|
@ -0,0 +1,142 @@
|
||||||
|
[English](https://gitlab.com/digitaldemocratic/digitaldemocratic/-/blob/master/README_en.md) - [Català](https://gitlab.com/digitaldemocratic/digitaldemocratic/-/blob/master/README.md)
|
||||||
|
|
||||||
|
# What's this
|
||||||
|
|
||||||
|
This project allows to bring up with ease a full identity provider and many apps to have an environment thought for schools and universities. The project will provide an integrated solution to handle the common environment in education:
|
||||||
|
|
||||||
|
- **Classrooms**: A moodle instance with custom theme and custom plugins.
|
||||||
|
- **Cloud drive**: A nextcloud instance with custom theme and custom plugins.
|
||||||
|
- **Documents**: An onlyoffice instance integrated with nextcloud.
|
||||||
|
- **Web pages**: A wordpress instance with custom theme and custom plugins.
|
||||||
|
- **Pad**: An etherpad instance integrated with nextcloud.
|
||||||
|
- **Conferences**: A BigBlueButton integrated with moodle and nextcloud. This needs an standalone host right now
|
||||||
|
- **Forms**: A forms nextcloud plugins.
|
||||||
|
- ... (some apps are there like jitsi or BigBlueButton but not fully integrated right now)
|
||||||
|
|
||||||
|
| | |
|
||||||
|
| ---------------------------- | ------------------------------- |
|
||||||
|
|  |  |
|
||||||
|
|
||||||
|
# Administration interface
|
||||||
|
|
||||||
|
Now there is an administration interface that allows to easily manager users and groups and keep it in sync between applications. This is done by executing actions on the applications apis.
|
||||||
|
|
||||||
|
|  |  |
|
||||||
|
| ---------------------------- | --------------------------------- |
|
||||||
|
|
||||||
|
To easily migrate and populate system there are also two provided imports for users and groups:
|
||||||
|
|
||||||
|
- From Google Admin Console as a JSON dump
|
||||||
|
- From a CSV file
|
||||||
|
|
||||||
|
This admin interface is now in an alpha status but allows to manage users in sync between keycloak, moodle and nextcloud.
|
||||||
|
|
||||||
|
# Project status
|
||||||
|
|
||||||
|
It works but as we are working on it it will have lots of improvements upcoming months. Some automatizations need to be done, specially with SAML integration in moodle and Keycloak initial personalization.
|
||||||
|
|
||||||
|
Your collaboration is wellcome! Just fork this repo and do a PR or open us an issue.
|
||||||
|
|
||||||
|
# DigitalDemocratic Documentation
|
||||||
|
|
||||||
|
This documentation is writed in Markdown using [MkDocs+Gitlab](https://gitlab.com/pages/mkdocs).
|
||||||
|
|
||||||
|
See `docs` directory for Markdown files or the [auto-built site](https://digitaldemocratic.gitlab.io/digitaldemocratic).
|
||||||
|
|
||||||
|
## Quick start
|
||||||
|
|
||||||
|
```
|
||||||
|
cp digitaldemocratic.conf.sample digitaldemocratic.conf
|
||||||
|
```
|
||||||
|
|
||||||
|
Change default passwords
|
||||||
|
|
||||||
|
```
|
||||||
|
./securize_conf.sh
|
||||||
|
```
|
||||||
|
|
||||||
|
Edit digitaldemocratic.conf file variables to suit your needs.
|
||||||
|
|
||||||
|
```
|
||||||
|
cp -R custom.sample custom
|
||||||
|
```
|
||||||
|
|
||||||
|
Edit and replace files to personalize system.
|
||||||
|
|
||||||
|
```
|
||||||
|
make all
|
||||||
|
```
|
||||||
|
|
||||||
|
NOTE: The SAML Auth in plugin automation status now is:
|
||||||
|
- Moodle: Not fully automated.
|
||||||
|
1. Login to moodle as admin via: https://moodle.\<domain\>/login/index.php?saml=off
|
||||||
|
2. Go to authentication configuration: https://moodle.\<domain\>/admin/settings.php?section=manageauths
|
||||||
|
3. Enable SAML2 clicking the eye.
|
||||||
|
4. Clic on *configuration* on SAML2
|
||||||
|
5. Click on the *Regenerate certificate* button inside the form. After that go back to SAML2 configuration page.
|
||||||
|
6. Click on the *Lock certificate* button.
|
||||||
|
7. In the terminal execute the script to autoconfigure: docker exec isard-sso-admin python3 moodle_saml.py
|
||||||
|
8. The last thing is to purge moodle cache: [[missing docker exec php-fpm7 script, do it through moodle web ui]]
|
||||||
|
|
||||||
|
- Nextcloud: Fully automated. After finishing the *make all* should be ready. In case it fails refer to isard-sso/docs.
|
||||||
|
- Wordpress: Fully automated. After finishing the *make all* should be ready. In case it fails refer to isard-sso/docs.
|
||||||
|
|
||||||
|
## Extended
|
||||||
|
|
||||||
|
You can start this project in any docker & docker-compose host (any OS should work). To install those packages in your distro refer to docker & docker-compose in this documentation and in the sysadm folder you have some scripts.
|
||||||
|
|
||||||
|
Any distro should work but, if you want to use our sysadm scripts to install docker & docker compose use Debian Buster (10).
|
||||||
|
|
||||||
|
### Clone and submodules
|
||||||
|
|
||||||
|
```
|
||||||
|
git clone https://gitlab.com/digitaldemocratic/digitaldemocratic/
|
||||||
|
cd digitaldemocratic
|
||||||
|
git submodule update --init --recursive
|
||||||
|
```
|
||||||
|
|
||||||
|
### docker
|
||||||
|
|
||||||
|
Refer to the official documentation (https://docs.docker.com/engine/install/) or use our sysadm script if you are on a Debian Buster (10).
|
||||||
|
|
||||||
|
### docker-compose
|
||||||
|
|
||||||
|
Refer to the official documentation (https://docs.docker.com/compose/install/) or use our sysadm script if you are on a Debian Buster (10).
|
||||||
|
|
||||||
|
### Configuració
|
||||||
|
|
||||||
|
Copieu digitaldemocratic.conf.sample 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.
|
||||||
|
|
||||||
|
- PRODUCCIÓ: Necessiteu un dns multidomini (o redirigeix els subdominis múltiples) a la vostra màquina servidor.
|
||||||
|
- Desenvolupament: Heu d'editar el fitxer /etc/hosts i afegir els subdominis només per a propòsits de proves local.
|
||||||
|
|
||||||
|
#### Subdominis
|
||||||
|
- 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>
|
||||||
|
- (opcional) FreeIPA: ipa.<yourdomain.org>
|
||||||
|
|
||||||
|
### Personalització
|
||||||
|
|
||||||
|
Copia recursivament la carpeta *custom.sample* a *custom* i edita els fitxers yaml de personalització i de menú i substitueix les imatges.
|
||||||
|
|
||||||
|
### Inicial el projecte
|
||||||
|
```
|
||||||
|
make all
|
||||||
|
```
|
||||||
|
|
||||||
|
### Integració
|
||||||
|
|
||||||
|
Llegiu el [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 plugin de Wordpress que cal només activar-lo en acabar.
|
||||||
|
|
||||||
|
### Llicència
|
||||||
|
|
||||||
|
AGPLv3 (https://www.gnu.org/licenses/agpl-3.0.en.html)
|
||||||
|
|
||||||
|
### Credits
|
||||||
|
|
||||||
|
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, l’Ajuntament de Barcelona y el Consorci d'Educació de Barcelona
|
||||||
Loading…
Reference in New Issue