Go to file
root 54ea4416f3 Removed option to destroy everything 2021-05-29 17:56:24 +02:00
config added keycloak python lib 2021-05-21 18:44:25 +02:00
custom.sample Added keycloak themes again 2021-05-28 16:34:55 +02:00
docs Fix docs recovering it 2021-05-27 16:36:19 +02:00
isard-apps@bd3c972771 Removed option to destroy everything 2021-05-29 17:56:24 +02:00
isard-sso@1ae7652fbb updated 2021-05-29 14:25:29 +00:00
.gitignore Fix by recovering menu sample yamls 2021-05-28 11:03:27 +02:00
.gitlab-ci.yml MkDocs+Gitlab setup 2021-02-22 15:43:07 +01:00
.gitmodules Added etherpad 2021-05-05 20:05:57 +02:00
Makefile Removed option to destroy everything 2021-05-29 17:56:24 +02:00
README.md Automated nextcloud saml and new make all 2021-05-28 13:52:45 +00:00
digitaldemocratic.conf.sample automated saml wp 2021-05-29 10:11:25 +02:00
mkdocs.yml MkDocs+Gitlab setup 2021-02-22 15:43:07 +01:00
requirements.txt MkDocs+Gitlab setup 2021-02-22 15:43:07 +01:00
securize_conf.sh add DDADMIN_PASSWORD to securize_conf.sh 2021-05-29 11:46:43 +02:00

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)

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

See docs directory for Markdown files or the auto-built site.

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

  • Wordpress: Nothing automated. 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).

Settings

Copy digitaldemocratic.conf.example to digitaldemocratic.conf and edit to suit your needs. At least (for development) you need to adapt the DOMAIN variable to your root domain.

  • PRODUCTION: You need a multidomain dns (or redirect the multiple subdomains) to your host machine.
  • DEVELOPMENT: You can just edit your /etc/hosts and add all of them there just for testing purposes.

Subdomains

  • Keycloak: sso.<yourdomain.org>
  • FreeIPA: ipa.<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>

Personalization

Copy recursively the custom.sample folder to custom and edit the menu yaml files and replace images.

Bring the project up

make up

Then wait for the apps to come up (test by accessing the multiple subdomains) and execute:

make add-plugins

Integration

Please read the SAML_README.md in isard-sso/docs folder to integrate all apps.