Remove Support for edu-sharing Version < 7 and Script Refactoring

README.md

@@ -4,8 +4,6 @@
 Dieses Projekt bietet die Möglichkeit, ein edu-sharing mit minimalem Aufwand in einer virtuellen Maschine aufzusetzen. Voraussetzung ist die Installation von
 [Git](https://git-scm.com/downloads),  [Vagrant](https://www.vagrantup.com/downloads.html) und [VirtualBox](https://www.virtualbox.org/wiki/Downloads).
 
-Außerdem kann eine Moodle-Instanz an das Repositorium angebunden werden. Siehe hierfür [Moodle-Integration](#moodle-integration)
-
 ## Installation
 
 Die folgenden Schritte im Terminal (Linux/macOS) oder in der GitBash (Windows) ausführen.
@@ -38,14 +36,22 @@ vagrant ssh
 * *esrender_version* anpassen in den renderingservice-vars
 * playbook ausführen
 
-## Moodle Integration
-
-- zunächst Edu-Sharing-Box wie in [Installation](#installation) geschildert installieren
-- nach erfolgreicher Installation die [Moodle-Box](https://github.com/TIBHannover/moodle-box) installieren. Dabei darauf achten, dass in _group_vars/all.yml_ der Eintrag `install_edu_sharing_plugin` auf `true` gesetzt ist, damit das Plugin installiert wird
-- anschließend in der Datei _group_vars/edusharing.yml_ der Edu-Sharing-Box den Eintrag `register_moodle` auf `true` setzen
-- im edu-sharing-box-Verzeichnis den Befehl `vagrant reload --provision`ausführen
-- nun sollte in moodle eine Einbindung des edu-sharing Repositoriums erfolgt sein
-
 ## DFN-AAI / Shibboleth Integration
 
 Siehe [SHIBBOLETH.md](SHIBBOLETH.md)
+
+## Documentation
+
+Each role in the edu-sharing playbook comes with its own detailed documentation, covering various aspects such as updates, included components, and more. Below are the links to the documentation for each role:
+
+- [edu-sharing-init](ansible/roles/edu-sharing-init/documentation/README.md): This role initializes the edu-sharing.
+- [edu-sharing-migration](ansible/roles/edu-sharing-migration/documentation/README.md):  This role handles migration tasks for edu-sharing.
+- [edu-sharing-customization](ansible/roles/edu-sharing-customization/documentation/README.md): This role allows customization of the edu-sharing platform.
+- [edu-sharing-rendering-service](ansible/roles/edu-sharing-rendering-service/documentation/README.md): This role manages the rendering service for edu-sharing.
+- [edu-sharing-search-elastic](ansible/roles/edu-sharing-search-elastic/documentation/README.md): This role deals with the elastic search functionality within edu-sharing.
+- [edu-sharing-classification-keywords](ansible/roles/edu-sharing-classification-keywords/documentation/README.md): This role handles keyword classification tasks.
+- [edu-sharing-mirror-vocabs](ansible/roles/edu-sharing-mirror-vocabs/documentation/README.md): This role manages the mirroring of vocabularies.
+- [edu-sharing-backup](ansible/roles/edu-sharing-backup/documentation/README.md): This role is responsible for backing up edu-sharing data.
+- [edu-sharing-restore](ansible/roles/edu-sharing-restore/documentation/README.md): This role handles the restoration of edu-sharing data.
+
+These documentation files provide detailed instructions and guidelines for using each role effectively.

Vagrantfile

@@ -19,22 +19,22 @@ Vagrant.configure("2") do |config|
   config.vm.provision "ansible_local" do |ansible|
     ansible.install = true
     ansible.install_mode = "pip"
-    ansible.pip_install_cmd = "sudo apt-get install -y python3-distutils && curl -s https://bootstrap.pypa.io/get-pip.py | sudo python3"
+    ansible.pip_install_cmd = <<-SHELL
+      sudo rm /usr/lib/python3.*/EXTERNALLY-MANAGED
+      sudo apt-get install -y python3-distutils
+      curl -s https://bootstrap.pypa.io/get-pip.py | sudo python3
+    SHELL
     ansible.version = "2.9.27"
     ansible.compatibility_mode = "2.0"
     #ansible.verbose = "vvv"
     ansible.playbook = "ansible/system.yml"
     ansible.galaxy_role_file = "requirements.yml"
     ansible.groups = {
-      "alfrescosolr4" => ["edu-sharing-vm"],
       "edusharing" => ["edu-sharing-vm"],
       "educonnector" => ["edu-sharing-vm"],
-      "onlyoffice" => ["edu-sharing-vm"],
       "antivirus" => ["edu-sharing-vm"],
       "opencast" => ["edu-sharing-vm"],
-      "renderingservice" => ["edu-sharing-vm"],
-      "tomcat:children" => ["alfrescosolr4", "edusharing"],
-      "alfresco:children" => ["alfrescosolr4", "edusharing"],
+      "alfresco:children" => ["edusharing"],
       "all:vars" => {
         "timezone" => "Europe/Berlin"
       }

ansible/group_vars/all.yml

@@ -9,60 +9,32 @@ esrender_host: 192.168.98.101
 esrender_proxy: '{{ esrender_host }}'
 esrender_url: '{{ edu_sharing_protocol | default("http") }}://{{ esrender_proxy }}/edu-sharing/esrender'
 
-onlyoffice_host: 192.168.98.101
-onlyoffice_proxy: "{{onlyoffice_host}}"
-
 clamav_host: 192.168.98.101
 clamav_proxy: "{{clamav_host}}"
 
 edu_connector_host: 192.168.98.104
 edu_connector_proxy: "{{edu_connector_host}}"
-
-# enable/disable onlyoffice installation
-# enable: true
-enable_only_office: false
+install_splash: false
 enable_edu_connector: false
-mariadb_port: 3306
-postgresql_port: 5432
-# db_types: 'postgresql', 'mariadb' (no migration on change)
-esrender_db_type: mariadb
 esrender_db:
   name: esrender
   user: esrender
   password: esrender
 
-postgres_tmp_root_password: xxx
-
-tomcat_port: 8080
-tomcat_shutdown_port: 8005
-tomcat_ssl_port: 8443
-tomcat_ajp_port: 8009
-
 base_dir: "{{ansible_env.HOME}}"
 
-esrender_document_root: '/var/www'
-esrender_base_dir: '{{esrender_document_root}}/esrender'
-esrender_cache_dir: '/var/cache/esrender'
-
 alf_password: admin
 
 script_dir: '{{ base_dir }}/bin'
 
 # enable / disable the edu-sharing backup process: present|absent
 backup_process_state: absent
-backup_db_user: oerbackup
-backup_db_password: changeme
-backup_schedule_hour: 2
-backup_path: '{{ base_dir }}/backup'
-backup_bin: '{{ script_dir }}'
 
-apache_conf_servername: # use as apache2 ServerName Directive, if set - see http://httpd.apache.org/docs/2.2/en/mod/core.html#servername
-apache_conf_usecanonicalname: # use as apache2 UseCanonicalName Directive, if set. Example: On - see http://httpd.apache.org/docs/2.2/en/mod/core.html#usecanonicalname
-
-# For now we don't need NGINX Configurations since OnlyOffice in installation make all necessary configuration.
+# enable / disable the edu-sharing restore process: true|false
+edu_sharing_restore_from_backup: false
 
-# NGINX configuration  
-# # list of configuration files
-# nginx_configuration_files:
-# # - ["example.conf.j2","example.conf"]
+# activate/deactivate es-update-oersi, a alfresco plugin used to update metadata in oersi
+activate_es_update_oersi: false
 
+apache_conf_servername: # use as apache2 ServerName Directive, if set - see http://httpd.apache.org/docs/2.2/en/mod/core.html#servername
+apache_conf_usecanonicalname: # use as apache2 UseCanonicalName Directive, if set. Example: On - see http://httpd.apache.org/docs/2.2/en/mod/core.html#usecanonicalname

ansible/group_vars/antivirus.yml

@@ -2,9 +2,4 @@
 # Recommended RAM for ClamAV :
 #    Minimum: 3 GiB
 #    Preferred: 4 GiB
-install_antivirus: false
-
-# 1.4.0-TIB-docker is used for edu-sharing docker version
-# For version less than 7 then use 1.4.0-TIB.2 
-antivirus_alfviral_version: 1.4.0-TIB-docker
-antivirus_alfviral_amp_filename: 'alfviral-{{ antivirus_alfviral_version }}.amp'
+install_antivirus: false

ansible/group_vars/edusharing.yml

@@ -1,20 +1,13 @@
 ---
 es_proxy_vhost: true
 
-tomcat_users:
-  - username: "CN=Alfresco Repository Client, OU=Unknown, O=Alfresco Software Ltd., L=Maidenhead, ST=UK, C=GB"
-    password: "null"
-    roles: "repoclient"
-  - username: "CN=Alfresco Repository, OU=Unknown, O=Alfresco Software Ltd., L=Maidenhead, ST=UK, C=GB"
-    password: "null"
-    roles: "repository"
-
-use_esguest_user: true
-# map of permssions that should be adjusted for the esguest user
-# key: Key of the permission (see list of available permissions: curl -X GET --header 'Accept: application/json' 'http://<YOURHOST>/edu-sharing/rest/admin/v1/toolpermissions/esguest')
-# value: ALLOWED | DENIED | UNDEFINED (see https://github.com/edu-sharing/Edu-Sharing/blob/develop/Backend/src/org/edu_sharing/service/admin/model/ToolPermission.java)
-esguest_permissions:
-  "TOOLPERMISSION_GLOBAL_AUTHORITY_SEARCH": "DENIED"
+
+edu_sharing_docker_project_name: "edu_sharing_docker_version"
+
+alfresco_db:
+  name: alfresco
+  user: alfresco
+  password: alfresco
 
 connect_content_pixabay: false
 pixabay_apikey: CHANGE_ME
@@ -24,28 +17,12 @@ youtube_apikey: CHANGE_ME
 
 connect_content_oersi: true  # activate / deactivate feature 'OERSI connection' (available from edu-sharing 6.0)
 
-register_moodle: false
-moodle_host: 192.168.98.105
-moodle_url: "http://{{moodle_host}}"
-
-# method how to retrieve the edu-sharing archive that should be installed
-#  'download' - use the archive from 'edu_sharing_archive_url'
-#  'copy-local' - copy the archive from the local host in 'edu_sharing_local_archive_path'
-edu_sharing_archive_retrieve_method: download
-edu_sharing_local_archive_path:
-
-# possibility to add an archive with custom modifications to edu-home
-edu_sharing_custom_installation: false
-edu_sharing_custom_archive_path:
-
 edu_inst_dir: "{{base_dir}}/edu-sharing_{{edu_version}}"
 edu_home: "{{edu_inst_dir}}/edu-sharing"
 
 edu_repo_caption: local-repo-vmtest
 edu_repo_id: local
 
-edu_log4j_properties_path:  # path of custom log4j.properties. if undefined, use the default - see https://github.com/edu-sharing/Edu-Sharing/blob/develop/Backend/src/log4j.properties
-
 # the receiver address where to send mails
 edu_mail_report_receiver:
 # the encryption used to send mails, at the moment only "tls" or none (blank) is supported
@@ -87,7 +64,6 @@ edu_logo_path:
 # example: ['local/path/example.svg', 'example.svg']
 edu_custom_images:
 edu_mds_override_paths:
-  - mds_oersi_override.xml
 edu_valuespaces_paths:
 edu_valuespaces_i18n_paths:
 # List of email template you want to override.
@@ -101,9 +77,7 @@ edu_help_menu_options:
 edu_allowed_licenses:
 
 edu_sharing_port:
-edu_sharing_clientport:
 edu_sharing_protocol: http
-edu_sharing_clientprotocol:
 
 edu_enable_statistics_api: "false"
 
@@ -191,12 +165,8 @@ edu_custom_licenses:
 activate_classification_keywords: false
 # activate the classification-keyword update (true/false)
 activate_classification_keywords_update: false
-# Override the default local file 
-classification_keywords_force_download: false
 # define the classification-keyword interval in days = 1 means every day
 classification_keywords_update_interval: 15
-# Classification-Keywords-URL (for download)
-classification_keywords_url: "https://data.dnb.de/GND/authorities-sachbegriff_dnbmarc_20211013.mrc.xml.gz"
 # classification keyword default file 
 edu_classification_keyword_path: "classification-keywords/classification-keywords.xml"
 
@@ -280,11 +250,4 @@ edu_connector_enable_modules:
     filetypes:
       - {mimetype: "application/vnd.openxmlformats-officedocument.wordprocessingml.document",filetype: "docx",createable: true,editable: true}
       - {mimetype: "application/vnd.openxmlformats-officedocument.presentationml.presentation",filetype: "pptx",createable: true,editable: true}
-      - {mimetype: "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",filetype: "xlsx",createable: true,editable: true}
-
-# activate/deactivate es-update-oersi, a alfresco plugin used to update metadata in oersi
-activate_es_update_oersi: false
-# version of the amp file
-es_update_oersi_version: 1.0.0
-# oersi update endpoint 
-es_update_oersi_url: 'https://oersi.org/resources/api-internal/import-scripts/python/update-record'
+      - {mimetype: "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",filetype: "xlsx",createable: true,editable: true}