EDUCATIC
/
digitaldemocratic
mirror of https://gitlab.com/digitaldemocratic/digitaldemocratic
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Updated readme eng

Yoselin Ribero 2022-02-07 07:50:34 +00:00
parent 33f8c0312b
commit 4b804b1942
1 changed files with 10 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
README_en.md
View File

@ -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.<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