From 4b804b1942c643dd2aed338415203b1793a9bc39 Mon Sep 17 00:00:00 2001 From: Yoselin Ribero Date: Mon, 7 Feb 2022 07:50:34 +0000 Subject: [PATCH 1/8] Updated readme eng --- README_en.md | 28 ++++++++++------------------ 1 file changed, 10 insertions(+), 18 deletions(-) diff --git a/README_en.md b/README_en.md index 993f6b2..dcfcf83 100644 --- a/README_en.md +++ b/README_en.md @@ -12,6 +12,12 @@ AGPLv3 (https://www.gnu.org/licenses/agpl-3.0.en.html) 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. +# Project status + +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 welcome! Just *fork* this repo to develop and do a PR or open an *issue*. + # 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: @@ -43,17 +49,6 @@ To easily migrate and insert users and groups to the system there are also two p This admin interface is now in an alpha status but allows to manage users in sync between Keycloak, Moodle and Nextcloud. -# Project status - -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 welcome! Just *fork* this repo to develop and do a PR or open an *issue*. - -# DigitalDemocratic Documentation - -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). ## Quick start @@ -101,6 +96,10 @@ NOTE: The SAML Auth in plugin is now automated: - 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. +## Instructions for post install + +There is a step by step manual in: (https://digitaldemocratic.gitlab.io/digitaldemocratic). + ## 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. @@ -142,13 +141,6 @@ Copy digitaldemocratic.conf.sample to digitaldemocratic.conf and edit to satisfy - Etherpad: pad. - (optional) FreeIPA: ipa. -NOTE: To test it in your computer without a domain you'll need to simulate a domain and set it in digitaldemocratic.conf and then add to your /etc/hosts this subdomains to your IP. - -For example: - -``` -echo '192.168.0.5 mydomain.org admin.mydomain.org nextcloud.mydomain.org moodle.mydomain.org sso.mydomain.org api.mydomain.org wp.mydomain.org pad.mydomain.org oof.mydomain.org' >> /etc/hosts -``` ### Customization From 069573034c7c31735bc2870c0588a564be7c28df Mon Sep 17 00:00:00 2001 From: Yoselin Ribero Date: Mon, 7 Feb 2022 08:04:30 +0000 Subject: [PATCH 2/8] Readme castellano --- README_es.md | 173 +++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 173 insertions(+) create mode 100644 README_es.md diff --git a/README_es.md b/README_es.md new file mode 100644 index 0000000..209a4e4 --- /dev/null +++ b/README_es.md @@ -0,0 +1,173 @@ +[English](https://gitlab.com/digitaldemocratic/digitaldemocratic/-/blob/master/README_en.md) - [Català](https://gitlab.com/digitaldemocratic/digitaldemocratic/-/blob/master/README.md) - Español + +DD es el workspace educativo generado en el marco del Plan de Digitalitzación Democrática de Xnet. Ha sido creado y powered por Xnet, familias y centros promotores, IsardVDI, 3iPunt, Dirección de Innovación Democrática, Dirección de Innovación Digital, Comisionado de Economía Social del Ayuntamiento de Barcelona y Consorci d’Educació de Barcelona. En colaboración con aFFaC y AirVPN. + +### Licencia + +AGPLv3 (https://www.gnu.org/licenses/agpl-3.0.en.html) + +### Créditos + +Proyecto piloto del Plan de Digitalización Democrática dirigido por Xnet y familias promotoras. Programario creado por IsardVDI y 3iPunt con la colaboración de MaadiX.net, Affac, el Ayuntamiento de Barcelona y el Consorcio de Educación de Barcelona. + +# Estado del proyecte + +Funcional, pero seguimos trabajando y tendrá muchas mejoras en los próximos meses. Hace falta hacer algunas automatizaciones, especialmente con la integración de SAML a Moodle y Keycloak. + +Vuestra colaboración es bienvenida! Puedes hacer un *fork* del proyecto para desarrollar o bien crear una *incidencia* en este repositorio. + +# Qué es esto + +Este proyecto permite facilitar un proveedor de identidad completo y muchas aplicaciones para tener un entorno pensado para escuelas y universidades. El proyecto proporcionará una solución integrada para gestionar el entorno común en la educación: + +- **Aulas**: Una instancia de Moodle con tema personalizado y conectores personalizados. +- **Archivos**: Una instancia del Nextcloud con tema personalizado y conectores personalizados. +- **Documentos**: Una instancia de OnlyOffice integrada con Nextcloud. +- **Págines web**: Una instancia de presión de palabras con el tema personalizado y conectores personalitzados. +- **Pad**: Una instancia Etherpad integrada con Nextcloud. +- **Conferencias**: Un BigBlueButton integrado con Moodle y Nextcloud. Necesita un servidor independiente. +- **Formularios**: Los conectores del Nextcloud de los formularios. +- ... (algunas aplicaciones como Jitsi o BigBlueButton no estan totalmente integradas ahora mismo) + +| | | +| ---------------------------- | ------------------------------- | +| ![](docs/img/classrooms.png) | ![](docs/img/cloud_storage.png) | + +# Interfaz de administración + +Ahora hay una interfaz de administración que permite gestionar fácilmente usuarios y grupos y mantenerlos sincronizados entre aplicaciones. Esto se hace ejecutando acciones sobre las apis de las diferentes aplicaciones. + +| ![](docs/img/admin_sync.png) | ![](docs/img/admin_user_edit.png) | +| ---------------------------- | --------------------------------- | + +Para migrar e introducir fácilmente usuarios y grupos al sistema también hay dos importaciones:: + +- Desde la consola de administración de Google en formato JSON +- Desde un archivo CSV + +Esta interfaz de administración está en estado alfa, pero ya permite gestionar usuarios sincronizados entre Keycloak, Moodle y Nextcloud. + + + +## Inicio rápido + +``` +cp digitaldemocratic.conf.sample digitaldemocratic.conf +``` + +Cambia las contraseñas por defecto + +``` +./securize_conf.sh +``` + +Edita las variables del archivo digitaldemocratic.conf para satisfacer vuestras necesidades. + +``` +cp -R custom.sample custom +``` + +Edita y sustituye los archivos para personalizar el sistema. + +La primera vez ejecuta: + +``` +./dd-ctl repo-update +``` + +Y después: + +``` +./dd-ctl all +``` + +NOTA: La autenticación SAML actualmente se encuentra automatizada: + +- Moodle: No completamente automatitzado. + 1. Inicia la sesión en Moodle como administrador via: https://moodle.\/login/index.php?saml=off + 2. Ve a la configuración de autenticación: https://moodle.\/admin/settings.php?section=manageauths + 3. Activa SAML2 haciendo clic al ojo. + 4. Clic a *configuración* a SAML2 + 5. Haz clic en el botón *Regenera el certificado* dentro del formulario. Después de esto, vuelve a la página de configuración de SAML2. + 6. Haz clic en el botón Bloquea el *certificado*. + 7. Al terminal ejecuta el script para autoconfigurar: acoplador exec isard-sso-admin python3 moodle_saml.py + 8. La última cosa es purgar la memoria caché de moodle: ]]femida l'script php-fpm7 del acoplador Exec, haz lo através de moodle ui]] + +- Nextcloud: Automatizada. Después de acabar el *make all* debería estar listo. En caso de que falle referirse a isard-sso/docs. +- Wordpress: Automatizada. Después de acabar el *make all* debería estar listo. En caso de que falle referirse a isard-sso/docs. + +## Instrucciones de post instalación + +Podéis encontrar un manual paso a paso en: (https://digitaldemocratic.gitlab.io/digitaldemocratic). + +## Instalación extendida + +Puedes iniciar este proyecto en cualquier servidor con docker & docker-compose (cualquier sistema operativo debería funcionar). Para instalar estos paquetes en vuestra distribución, consulta el funcionamiento de docker & docker-compose en la documentación oficial y en la carpeta sysadm hay algunos scripts de automatización. + +Cualquier distribución debería funcionar pero, si queréis utilizar nuestros scripts sysadm para instalar docker & docker-compose, utiliza Debia Buster (10). + +### Clonar los submódulos + +``` +git clone https://gitlab.com/digitaldemocratic/digitaldemocratic/ +cd digitaldemocratic +git submodule update --init --recursive +``` + +### docker + +Referios a la documentación oficial (https://docs.docker.com/engine/install/) o utiliza el script en la carpeta sysadm para Debian Buster (10). + +### docker-compose + +Referios a la documentación oficial (https://docs.docker.com/compose/install/) o utiliza el script en la carpeta sysadm para Debian Buster (10). + +### Configuración + +Copia digitaldemocratic.conf.exemple a digitaldemocratic.conf y edita lo para satisfacer vuestras necesidades. Como mínimo (para desarrollar) tenéis que adaptar la variable de DOMINI a vuestro dominio raíz. + +- PRODUCCIÓN: Necesitaréis un dns multidominio (o redirige los subdominios múltiples) a vuestra máquina de anfitrión. +- Desarrollo: Edita el fitxer /etc/hosts i afegiu els subdominis per a propòsits de proves locals. + +#### Subdominios + +- Keycloak: sso. +- Api: api. +- Moodle: moodle. +- Nextcloud: nextcloud. +- Wordpress: wp. +- Onlyoffice: oof. +- Etherpad: pad. +- (opcional) FreeIPA: ipa. + +### Personalización + +Copia recursivamente la carpeta *custom.sample* a *custom* y edita los archivos yaml de personalización y menú y sustituye las imágenes. + +### Iniciar el proyecto + +La primera vez (y si queréis actualizar a la última versión posteriormente) ejecuta: + +``` +./dd-ctl update-repo +``` + +Y después: + +``` +./dd-ctl all +``` + +Posteriormente puedes iniciar o parar con: + +``` +./dd-ctl down +./dd-ctl up +``` + +### Integración + +Lee el archivo [SAML_README.md](https://gitlab.com/isard/isard-sso/-/blob/master/docs/SAML_README.md) en la carpeta isard-sso/docs para integrar todas las aplicaciones. Ahora el Nextcloud y el Wordpress se deberían de integrar automáticamente con el Keycloak. + + + From f1029e7f560eb4539a8642f470583b9a2d8e1020 Mon Sep 17 00:00:00 2001 From: Yoselin Ribero Date: Mon, 7 Feb 2022 08:06:02 +0000 Subject: [PATCH 3/8] Update README_en.md --- README_en.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README_en.md b/README_en.md index dcfcf83..1390124 100644 --- a/README_en.md +++ b/README_en.md @@ -1,6 +1,6 @@ # Digital Democratic -[English](https://gitlab.com/digitaldemocratic/digitaldemocratic/-/blob/master/README_en.md) - [Català](https://gitlab.com/digitaldemocratic/digitaldemocratic/-/blob/master/README.md) +[English](https://gitlab.com/digitaldemocratic/digitaldemocratic/-/blob/master/README_en.md) - [Català](https://gitlab.com/digitaldemocratic/digitaldemocratic/-/blob/master/README.md) - [Castellano](https://gitlab.com/digitaldemocratic/digitaldemocratic/-/blob/master/README_es.md) DD is the educational workspace generated within the framework of Xnet’s Democratic Digitalisation Plan. It has been created and powered by Xnet, families and promoter centres, IsardVDI, 3iPunt, Directorate for Democratic Innovation, Directorate for Digital Innovation, Commissioner for Social Economy of Barcelona City Council and Consorci d’Educació de Barcelona. In collaboration with aFFaC and AirVPN. From 08f60b27197979ccc8d2c3f111fff71663b65d83 Mon Sep 17 00:00:00 2001 From: Yoselin Ribero Date: Mon, 7 Feb 2022 08:07:02 +0000 Subject: [PATCH 4/8] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index a313cdf..a6e6026 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Digital Democratic -[English](https://gitlab.com/digitaldemocratic/digitaldemocratic/-/blob/master/README_en.md) - [Català](https://gitlab.com/digitaldemocratic/digitaldemocratic/-/blob/master/README.md) +[English](https://gitlab.com/digitaldemocratic/digitaldemocratic/-/blob/master/README_en.md) - [Català](https://gitlab.com/digitaldemocratic/digitaldemocratic/-/blob/master/README.md) - [Castellano](https://gitlab.com/digitaldemocratic/digitaldemocratic/-/blob/master/README_es.md) DD és el workspace educatiu generat en el marc del Pla de Digitalització Democràtica d’Xnet. Ha estat creat i powered per Xnet, famílies i centres promotors, IsardVDI, 3iPunt, Direcció d’Innovació Democràtica, Direcció d’Innovació Digital, Comissionat d’Economia Social de l’Ajuntament de Barcelona, Consorci d’Educació de Barcelona. En col·laboració amb aFFaC i AirVPN. From 766f0711d88970337d0ccd63f643b15f9d0ffdbe Mon Sep 17 00:00:00 2001 From: Yoselin Ribero Date: Mon, 7 Feb 2022 08:07:32 +0000 Subject: [PATCH 5/8] Update README_es.md --- README_es.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README_es.md b/README_es.md index 209a4e4..7d8cd32 100644 --- a/README_es.md +++ b/README_es.md @@ -1,4 +1,4 @@ -[English](https://gitlab.com/digitaldemocratic/digitaldemocratic/-/blob/master/README_en.md) - [Català](https://gitlab.com/digitaldemocratic/digitaldemocratic/-/blob/master/README.md) - Español +[English](https://gitlab.com/digitaldemocratic/digitaldemocratic/-/blob/master/README_en.md) - [Català](https://gitlab.com/digitaldemocratic/digitaldemocratic/-/blob/master/README.md) - [Castellano](https://gitlab.com/digitaldemocratic/digitaldemocratic/-/blob/master/README_es.md) DD es el workspace educativo generado en el marco del Plan de Digitalitzación Democrática de Xnet. Ha sido creado y powered por Xnet, familias y centros promotores, IsardVDI, 3iPunt, Dirección de Innovación Democrática, Dirección de Innovación Digital, Comisionado de Economía Social del Ayuntamiento de Barcelona y Consorci d’Educació de Barcelona. En colaboración con aFFaC y AirVPN. From e2de1692d2fbad79f99f1df3fbc44c2c3027653b Mon Sep 17 00:00:00 2001 From: Yoselin Ribero Date: Mon, 7 Feb 2022 08:09:12 +0000 Subject: [PATCH 6/8] Update README_es.md --- README_es.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README_es.md b/README_es.md index 7d8cd32..b056f07 100644 --- a/README_es.md +++ b/README_es.md @@ -132,6 +132,7 @@ Copia digitaldemocratic.conf.exemple a digitaldemocratic.conf y edita lo para sa #### Subdominios - Keycloak: sso. +- Admin: admin. - Api: api. - Moodle: moodle. - Nextcloud: nextcloud. From 85e8aaf6f224e8fbc5b688371d0474d9828a299b Mon Sep 17 00:00:00 2001 From: Yoselin Ribero Date: Mon, 7 Feb 2022 12:30:30 +0000 Subject: [PATCH 7/8] Update README_es.md --- README_es.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/README_es.md b/README_es.md index b056f07..4029f91 100644 --- a/README_es.md +++ b/README_es.md @@ -12,9 +12,8 @@ Proyecto piloto del Plan de Digitalización Democrática dirigido por Xnet y fam # Estado del proyecte -Funcional, pero seguimos trabajando y tendrá muchas mejoras en los próximos meses. Hace falta hacer algunas automatizaciones, especialmente con la integración de SAML a Moodle y Keycloak. - -Vuestra colaboración es bienvenida! Puedes hacer un *fork* del proyecto para desarrollar o bien crear una *incidencia* en este repositorio. +Proyecto en desarrollo. Estamos acabando el proyecto para en breves ponerlo a disposición de la comunidad para que podáis hacer las aportaciones y colaboraciones que deseáis. +En los próximos meses modificaremos el código con importantes cambios y mejoras. Una vez esté en un estado más estable lo publicaremos aquí mismo. # Qué es esto From 985ee347e36e81af608610079e7728d20fee0a7f Mon Sep 17 00:00:00 2001 From: Yoselin Ribero Date: Mon, 7 Feb 2022 12:31:21 +0000 Subject: [PATCH 8/8] Update README_en.md --- README_en.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/README_en.md b/README_en.md index 1390124..59220bb 100644 --- a/README_en.md +++ b/README_en.md @@ -14,9 +14,8 @@ Pilot project of the Democratic Digitalization Plan led by Xnet and promoter fam # Project status -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 welcome! Just *fork* this repo to develop and do a PR or open an *issue*. +Project in development. We are finishing the project to shortly make it available to the community so that you can make the contributions and collaborations you want. +In the coming months we will modify the code with important changes and improvements. Once it is in a more stable state we will publish it here. # What's this