ReadME En/Ca Synchronized
Yoselin Ribero
Josep Maria Viñolas Auquer
parent
d6d64cb296
commit
c16072b8a2
43
README.md
43
README.md
|
|
@ -6,7 +6,7 @@ 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, l’Ajuntament de Barcelona y el Consorci d'Educació de Barcelona
|
||||
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 i el Consorci d'Educació de Barcelona.
|
||||
|
||||
# Què és això
|
||||
|
||||
|
|
@ -14,11 +14,11 @@ Aquest projecte permet facilitar un proveïdor d'identitat complet i moltes apli
|
|||
|
||||
- **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.
|
||||
- **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.
|
||||
- **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)
|
||||
|
||||
| | |
|
||||
|
|
@ -37,7 +37,7 @@ Per migrar i introduïr fàcilment usuaris i grups al sistema també hi ha dues
|
|||
- Des de la consola d'administració de Google en format JSON
|
||||
- Des d'un fitxer CSV
|
||||
|
||||
Aquesta interfície d'administració està en estat alfa, però ja permet gestionar usuaris sincronitzats entre keycloak, moodle i nextcloud.
|
||||
Aquesta interfície d'administració està en estat alfa, però ja permet gestionar usuaris sincronitzats entre Keycloak, Moodle i Nextcloud.
|
||||
|
||||
# Estat del projecte
|
||||
|
||||
|
|
@ -63,7 +63,7 @@ Canvia les contrasenyes per defecte
|
|||
./securize_conf.sh
|
||||
```
|
||||
|
||||
Editeu les variables de fitxer digitaldemocratic.conf per satisfer les vostres necessitats.
|
||||
Editeu les variables del fitxer digitaldemocratic.conf per satisfer les vostres necessitats.
|
||||
|
||||
```
|
||||
cp -R custom.sample custom
|
||||
|
|
@ -73,7 +73,7 @@ Edita i substitueix els fitxers per personalitzar el sistema.
|
|||
|
||||
La primera vegada executa:
|
||||
```
|
||||
./dd-ctl update-repo
|
||||
./dd-ctl repo-update
|
||||
```
|
||||
|
||||
I després:
|
||||
|
|
@ -84,21 +84,21 @@ I després:
|
|||
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
|
||||
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*.
|
||||
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.
|
||||
- Nextcloud: Automatitzada. Després d'acabar el *make all* hauria d'estar llest. En cas que falli 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 connector. En cas que falli refereix a isard-sso/docs.
|
||||
|
||||
## Instal.lació estesa
|
||||
|
||||
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ó
|
||||
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 & docker-compose a la documentació oficial i a la carpeta sysadm teniu alguns scripts d'automatització
|
||||
|
||||
Qualsevol distribució hauria de funcionar però, si voleu utilitzar els nostres scripts sysadm per instal·lar docker & docker-compose , utilitzeu Debian Buster (10).
|
||||
|
||||
|
|
@ -120,12 +120,13 @@ Referiu-vos a la documentació oficial (https://docs.docker.com/compose/install/
|
|||
|
||||
### Configuració
|
||||
|
||||
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.
|
||||
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 DOMAIN al vostre domini arrel.
|
||||
|
||||
- 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.
|
||||
|
||||
#### Subdominis
|
||||
|
||||
- Keycloak: sso.<yourdomain.org>
|
||||
- Api: api.<yourdomain.org>
|
||||
- Moodle: moodle.<yourdomain.org>
|
||||
|
|
@ -140,16 +141,21 @@ Copieu digitaldemocratic.conf.exemple a digitaldemocratic.conf i editeu-lo per
|
|||
Copia recursivament la carpeta *custom.sample* a *custom* i edita els fitxers yaml de personalització i menú i substitueix les imatges.
|
||||
|
||||
### Iniciar el projecte
|
||||
|
||||
La primera vegada (i si voleu actualitzar a la última versió posteriorment) executeu:
|
||||
|
||||
```
|
||||
./dd-ctl update-repo
|
||||
./dd-ctl repo-update
|
||||
```
|
||||
I després
|
||||
|
||||
I després:
|
||||
|
||||
```
|
||||
./dd-ctl all
|
||||
```
|
||||
|
||||
Posteriorment podreu iniciar o aturar amb:
|
||||
|
||||
```
|
||||
./dd-ctl down
|
||||
./dd-ctl up
|
||||
|
|
@ -158,4 +164,3 @@ Posteriorment podreu iniciar o aturar amb:
|
|||
### Integració
|
||||
|
||||
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.
|
||||
|
||||
|
|
|
|||
69
README_en.md
69
README_en.md
|
|
@ -6,20 +6,20 @@ AGPLv3 (https://www.gnu.org/licenses/agpl-3.0.en.html)
|
|||
|
||||
### Credits
|
||||
|
||||
Pilot project of the Democratic Digitalization Plan led by Xnet and promoter families. Software created by IsardVDI and 3iPunt with the collaboration of MaadiX.net, Affac, the Barcelona City Hall and the Barcelona Education Consortium
|
||||
Pilot project of the Democratic Digitalization Plan led by Xnet and promoter families. Software created by IsardVDI and 3iPunt with the collaboration of MaadiX.net, Affac, the Barcelona City Hall and the Barcelona Education Consortium.
|
||||
|
||||
# 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)
|
||||
- **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 a standalone host.
|
||||
- **Forms**: A forms Nextcloud plugin.
|
||||
- ... (some apps like jitsi or BigBlueButton are not fully integrated right now)
|
||||
|
||||
| | |
|
||||
| ---------------------------- | ------------------------------- |
|
||||
|
|
@ -27,27 +27,27 @@ This project allows to bring up with ease a full identity provider and many apps
|
|||
|
||||
# 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.
|
||||
Now there is an administration interface that allows to easily manage users and groups and keep it in sync between applications. This is done by executing actions on the different applications apis.
|
||||
|
||||
|  |  |
|
||||
| ---------------------------- | --------------------------------- |
|
||||
|
||||
To easily migrate and populate system there are also two provided imports for users and groups:
|
||||
To easily migrate and insert users and groups to the system there are also two provided imports:
|
||||
|
||||
- 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.
|
||||
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.
|
||||
Functional, but we are still working on and will have lots of improvements in the upcoming months. Some automatizations need to be done, specially with SAML integration in moodle and Keycloak.
|
||||
|
||||
Your collaboration is wellcome! Just fork this repo and do a PR or open us an issue.
|
||||
Your collaboration is welcome! Just *fork* this repo to develop and do a PR or open an *issue*.
|
||||
|
||||
# DigitalDemocratic Documentation
|
||||
|
||||
This documentation is writed in Markdown using [MkDocs+Gitlab](https://gitlab.com/pages/mkdocs).
|
||||
This documentation is written 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).
|
||||
|
||||
|
|
@ -57,7 +57,7 @@ See `docs` directory for Markdown files or the [auto-built site](https://digital
|
|||
cp digitaldemocratic.conf.sample digitaldemocratic.conf
|
||||
```
|
||||
|
||||
Change default passwords
|
||||
Changes default passwords
|
||||
|
||||
```
|
||||
./securize_conf.sh
|
||||
|
|
@ -69,32 +69,35 @@ Edit digitaldemocratic.conf file variables to suit your needs.
|
|||
cp -R custom.sample custom
|
||||
```
|
||||
|
||||
Edit and replace files to personalize system.
|
||||
Edit and replace files to personalize the system.
|
||||
|
||||
The first time execute:
|
||||
|
||||
```
|
||||
./dd-ctl update-repo
|
||||
./dd-ctl repo-update
|
||||
```
|
||||
|
||||
And then:
|
||||
|
||||
```
|
||||
./dd-ctl all
|
||||
```
|
||||
|
||||
NOTE: The SAML Auth in plugin automation status now is:
|
||||
NOTE: The SAML Auth in plugin is now automated:
|
||||
- Moodle: Not fully automated.
|
||||
1. Login to moodle as admin via: https://moodle.\<domain\>/login/index.php?saml=off
|
||||
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
|
||||
4. Click 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.
|
||||
- Nextcloud: Fully automated. After finishing the *make all* it should be ready. In case it fails refer to isard-sso/docs.
|
||||
- Wordpress: Practically automated. After finishing the *make all* it should be ready and you will only need to activate the plugin. In case it fails refer to isard-sso/docs.
|
||||
|
||||
## Extended
|
||||
## Extended Installation
|
||||
|
||||
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.
|
||||
|
||||
|
|
@ -118,12 +121,13 @@ Refer to the official documentation (https://docs.docker.com/compose/install/) o
|
|||
|
||||
### Setup
|
||||
|
||||
Copy digitaldemocratic.conf.sample to digitaldemocratic.conf and edit to satisfy your needs. At least (to development) you should adapt the DOMINI envvar to your root domain.
|
||||
Copy digitaldemocratic.conf.sample to digitaldemocratic.conf and edit to satisfy your needs. At least (for development) you should adapt the DOMAIN envvar to your root domain.
|
||||
|
||||
- PRODUCTION: You'll need a multidomain dns (or redirect all the subdomains) to your server IP.
|
||||
- DEVELOPMENT: You'll have to edit your /etc/hosts and add all the required domains to your development server IP.
|
||||
|
||||
#### Subdomains
|
||||
|
||||
- Keycloak: sso.<yourdomain.org>
|
||||
- Api: api.<yourdomain.org>
|
||||
- Moodle: moodle.<yourdomain.org>
|
||||
|
|
@ -143,20 +147,24 @@ echo '192.168.0.5 mydomain.org admin.mydomain.org nextcloud.mydomain.org moodle.
|
|||
|
||||
### Customization
|
||||
|
||||
Recursively copy the *custom.sampl* folder to *custom* and edit the yaml personalization files and substitute the image.
|
||||
Recursively copy the *custom.sample* folder to *custom* and edit the yaml personalization files and menu and substitute the image.
|
||||
|
||||
### Start the project
|
||||
|
||||
The first time (and to upgrade later) you should execute:
|
||||
The first time (and if you want to upgrade to the latest version later) you should execute:
|
||||
|
||||
```
|
||||
./dd-ctl update-repo
|
||||
```
|
||||
|
||||
And after:
|
||||
|
||||
```
|
||||
./dd-ctl all
|
||||
```
|
||||
|
||||
Then you can control the up/down:
|
||||
Then you can start or stop with:
|
||||
|
||||
```
|
||||
./dd-ctl down
|
||||
./dd-ctl up
|
||||
|
|
@ -164,7 +172,4 @@ Then you can control the up/down:
|
|||
|
||||
### Integration
|
||||
|
||||
Read the [SAML_README.md](https://gitlab.com/isard/isard-sso/-/blob/master/docs/SAML_README.md) in isard-sso/docs folder
|
||||
to known more about setting and customizing applications, specially if the SSO fails to get correctly configured the
|
||||
first time.
|
||||
|
||||
Read the [SAML_README.md](https://gitlab.com/isard/isard-sso/-/blob/master/docs/SAML_README.md) file in isard-sso/docs folder to integrate all the applicactions. Now, Nextcloud and Wordpress should integrate automatically with the Keycloak.
|
||||
|
|
|
|||
Loading…
Reference in New Issue