Updated readme cat

Updated readme eng
Readme castellano
Update README_en.md
Update README.md
Update README_es.md
Update README_es.md
Update README_es.md
Update README_en.md
naomoi 2022-02-08 10:46:11 +01:00
parent 8fd019f4f8
commit 4a769e7238
3 changed files with 197 additions and 20 deletions

View File

@ -1,6 +1,6 @@
# Digital Democratic # 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 dXnet. Ha estat creat i powered per Xnet, famílies i centres promotors, IsardVDI, 3iPunt, Direcció dInnovació Democràtica, Direcció dInnovació Digital, Comissionat dEconomia Social de lAjuntament de Barcelona, Consorci dEducació de Barcelona. En col·laboració amb aFFaC i AirVPN. DD és el workspace educatiu generat en el marc del Pla de Digitalització Democràtica dXnet. Ha estat creat i powered per Xnet, famílies i centres promotors, IsardVDI, 3iPunt, Direcció dInnovació Democràtica, Direcció dInnovació Digital, Comissionat dEconomia Social de lAjuntament de Barcelona, Consorci dEducació de Barcelona. En col·laboració amb aFFaC i AirVPN.
@ -79,6 +79,19 @@ I després:
``` ```
./dd-ctl all ./dd-ctl all
``` ```
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 falli refereix a isard-sso/docs.
- Wordpress: Automatitzada. Després d'acabar el *make all* hauria d'estar llest. En cas que falli refereix a isard-sso/docs.
## instruccions de post instal·lació ## instruccions de post instal·lació

View File

@ -1,6 +1,6 @@
# Digital Democratic # 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 Xnets 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 dEducació de Barcelona. In collaboration with aFFaC and AirVPN. DD is the educational workspace generated within the framework of Xnets 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 dEducació de Barcelona. In collaboration with aFFaC and AirVPN.
@ -12,6 +12,11 @@ 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. 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
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 # 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: 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 +48,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. 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 ## Quick start
@ -101,6 +95,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. - 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. - 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 ## 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. 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 +140,6 @@ Copy digitaldemocratic.conf.sample to digitaldemocratic.conf and edit to satisfy
- Etherpad: pad.<yourdomain.org> - Etherpad: pad.<yourdomain.org>
- (optional) FreeIPA: ipa.<yourdomain.org> - (optional) FreeIPA: ipa.<yourdomain.org>
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 ### Customization

173
README_es.md Normal file
View File

@ -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) - [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 dEducació 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
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
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.\<domain\>/login/index.php?saml=off
2. Ve a la configuración de autenticación: https://moodle.\<domain\>/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.<yourdomain.org>
- Admin: admin.<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>
### 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.