Starter site integration

README.md

@@ -44,13 +44,13 @@ By default the Vagrantfile builds Islandora on a `ubuntu/focal64` (20.04 LTS) ba
 
 ### Install Profile
 
-The Unix shell variable 'ISLANDORA_INSTALL_PROFILE' can be one of:
+The Unix shell variable `ISLANDORA_INSTALL_PROFILE` can be one of:
 
-standard - Installs a drupal/recommended-project base install and enables the Islandora and Islandora Defaults modules without any special configuration.
+* `demo`: Installs the demo based on the [install profile](https://github.com/Islandora-Devops/islandora_install_profile_demo) developed by Born Digital. This has a custom theme and more out-of-the-box customizations.
+* `starter`: Installs using [the `islandora/islandora-starter-site` project](https://github.com/Islandora/islandora-starter-site/) as a template, intended for spinning up sites for general usage.
+* `starter_dev`: Similar to `starter`, installs based on [the `islandora/islandora-starter-site` project](https://github.com/Islandora/islandora-starter-site/); however, performs a clone of the repository with its history, intended specifically for development of the starter site.
 
-demo - Installs the demo based on the [install profile](https://github.com/Islandora-Devops/islandora_install_profile_demo) developed by Born Digital. This has a custom theme and more out-of-the-box customizations.
-
-This corresponds to the 'islandora_profile' Ansible variable.
+This corresponds to the `islandora_profile` Ansible variable.
 
 ### System Resources
 

Vagrantfile

@@ -16,8 +16,9 @@ $virtualBoxDescription = ENV.fetch("ISLANDORA_VAGRANT_VIRTUALBOXDESCRIPTION", "I
 # Use 'islandora/8' if you just want to download a ready to run VM that is version 1.1.0 of Islandora
 # The 'islandora/8' box is no longer mantained.
 $vagrantBox = ENV.fetch("ISLANDORA_DISTRO", "ubuntu/focal64")
-# Currently 'standard' and 'demo' are available.
-$drupalProfile = ENV.fetch("ISLANDORA_INSTALL_PROFILE", "standard")
+
+# See the "install profile" section of the README for the full gamut available.
+$drupalProfile = ENV.fetch("ISLANDORA_INSTALL_PROFILE", "starter")
 
 # vagrant is the main user
 $vagrantUser = "vagrant"

inventory/vagrant/group_vars/all/main.yml

@@ -44,3 +44,9 @@ php_packages_state: "latest"
 os_environment:
   - key: LOG4J_FORMAT_MSG_NO_LOOKUPS 
     value: true
+
+webserver_install_matomo: true
+webserver_install_fits: true
+
+post_install_chown_defaults: true
+post_install_migrate_import_fits_tags: false

inventory/vagrant/group_vars/webserver/drupal.yml

@@ -18,7 +18,8 @@ drupal_account_name: admin
 drupal_trusted_hosts:
   - ^localhost$
   - "{{ hostvars[groups['webserver'][0]].ansible_host }}"
-drupal_trusted_hosts_file: "{{ drupal_core_path }}/sites/default/settings.php"
+drupal_site_default_settings: "{{ drupal_core_path }}/sites/default/settings.php"
+drupal_trusted_hosts_file: "{{ drupal_site_default_settings }}"
 drupal_public_filesystem: "{{ drupal_core_path }}/sites/default/files"
 drupal_external_libraries_directory: "{{ drupal_core_path }}/libraries"
 fedora_base_url: "http://{{ hostvars[groups['tomcat'][0]].ansible_host }}:8080/fcrepo/rest/"

post-install.yml

@@ -65,6 +65,10 @@
     - name: Run migrations
       command: "{{ drush_path }} --root {{ drupal_core_path }} -y -l localhost:{{ apache_listen_port }} --userid=1 mim islandora_tags,islandora_defaults_tags"
 
+    - name: Run islandora_fits migration
+      command: "{{ drush_path }} --root {{ drupal_core_path }} -y -l localhost:{{ apache_listen_port }} --userid=1 mim islandora_fits_tags"
+      when: post_install_migrate_import_fits_tags
+
     - name: Add vagrant user to webserver app user group
       user: name={{ vagrant_user }}
             group={{ webserver_app_user }}
@@ -87,6 +91,7 @@
         group: "{{ webserver_app_user }}"
         mode: 0775
         recurse: yes
+      when: post_install_chown_defaults
 
     - name: Chown controlled access terms default configuration
       file:

roles/internal/Islandora-Devops.drupal-openseadragon/defaults/main.yml

@@ -2,6 +2,7 @@
 
 openseadragon_drush_path: /usr/local/bin/drush
 
+openseadragon_composer_require: true
 openseadragon_composer_item: "islandora/openseadragon:1.0.0"
 openseadragon_composer_root: "/var/www/html/drupal"
 openseadragon_sites:

roles/internal/Islandora-Devops.drupal-openseadragon/tasks/install.yml

@@ -6,6 +6,7 @@
     arguments: "{{ openseadragon_composer_item }}"
     working_dir: "{{ openseadragon_composer_root }}"
   become: no
+  when: openseadragon_composer_require
 
 - name: Check if Seadragon Library Exists
   stat:

roles/internal/webserver-app/defaults/main.yml

@@ -14,3 +14,12 @@ solr_user: solr
 solr_instance_conf_path: /var/solr/data/{{ solr_cores[0] }}/conf
 
 webserver_document_root: /var/www/html
+
+webserver_app_do_original_trusted_host_and_more: true
+webserver_app_do_trusted_host: false
+webserver_app_do_fedora_scheme_config: false
+webserver_app_do_content_sync_config: false
+webserver_app_uninstall_search_module: true
+webserver_app_feature_import_base: true
+webserver_app_feature_import_search: false
+webserver_app_configure_matomo: true

roles/internal/webserver-app/tasks/drupal.yml

@@ -1,6 +1,6 @@
 ---
 
-- name: Trusted Host Settings
+- name: Trusted Host Settings and more
   blockinfile:
     state: present
     block: |
@@ -21,11 +21,53 @@
       $content_directories['sync'] = $app_root.'/../content/sync';
     path: "{{ drupal_trusted_hosts_file }}"
     marker: // {mark} ANSIBLE MANAGED BLOCK
+  when: webserver_app_do_original_trusted_host_and_more
+
+- name: Trusted Host Settings
+  blockinfile:
+    state: present
+    block: |
+      $settings['trusted_host_patterns'] = array(
+      {% for host in drupal_trusted_hosts %}
+        '{{ host }}',
+      {% endfor %}
+      );
+    path: "{{ drupal_trusted_hosts_file }}"
+    marker: // {mark} ANSIBLE MANAGED BLOCK - trusted hosts
+  when: webserver_app_do_trusted_host
+
+- name: Flysystem "fedora" scheme configuration
+  blockinfile:
+    state: present
+    block: |
+      $settings['flysystem'] = [
+        'fedora' => [
+          'driver' => 'fedora',
+          'config' => [
+            'root' => '{{ fedora_base_url }}',
+          ],
+        ],
+      ];
+    path: "{{ drupal_site_default_settings }}"
+    marker: // {mark} ANSIBLE MANAGED BLOCK - fedora flysystem scheme
+  when: webserver_app_do_fedora_scheme_config
+
+- name: Content Sync Directory configuration
+  blockinfile:
+    state: present
+    block: |
+      global $content_directories;
+      $content_directories['sync'] = $app_root.'/../content/sync';
+    path: "{{ drupal_site_default_settings }}"
+    marker: // {mark} ANSIBLE MANAGED BLOCK - content sync dir
+  when: webserver_app_do_content_sync_config
+
 
 - name: Uninstall core search module
   command: "{{ drush_path }} --root {{ drupal_core_path }} -y pm-uninstall search"
   register: uninstall_search
   changed_when: "'successfully uninstalled' in uninstall_search.stdout"
+  when: webserver_app_uninstall_search_module
 
 - name: Set permissions on the public files directory
   file:
@@ -48,24 +90,28 @@
     path: "{{ drupal_deploy_dir }}/content/sync"
     owner: "{{ webserver_app_user }}"
     group: "{{ webserver_app_user }}"
+  when: webserver_app_do_content_sync_config or webserver_app_do_original_trusted_host_and_more
 
 - name: Import features
   command: "{{ drush_path }} --root {{ drupal_core_path }} -y fim islandora_core_feature,islandora_defaults"
-
+  when: webserver_app_feature_import_base
+
 - name: Import search feature
   command: "{{ drush_path }} --root {{ drupal_core_path }} -y fim islandora_search"
-  when: islandora_profile == "standard"
+  when: webserver_app_feature_import_search
 
 # Set Matomo Settings
 - name: Set Matomo site id.
   command: "{{ drush_path }} --root {{ drupal_core_path }} -y config-set matomo.settings site_id 1"
-  register: set_search_api_config
-  changed_when: "'Do you want to update site_id' in set_search_api_config.stdout"
+  register: set_matomo_site_id_config
+  changed_when: "'Do you want to update site_id' in set_matomo_site_id_config.stdout"
+  when: webserver_app_configure_matomo
 
-- name: Set Matmo sever url.
+- name: Set Matomo server url.
   command: "{{ drush_path }} --root {{ drupal_core_path }} -y config-set matomo.settings url_http http://localhost:8000/matomo/"
-  register: set_search_api_config
-  changed_when: "'Do you want to update site_id' in set_search_api_config.stdout"
+  register: set_matomo_server_url_config
+  changed_when: "'Do you want to update url_http' in set_matomo_server_url_config.stdout"
+  when: webserver_app_configure_matomo
 
 # pdf.js library
 - name: ensure pdf.js directory exists

roles/internal/webserver-app/tasks/solr.yml

@@ -6,12 +6,12 @@
 - name: Set default solr server host from hostvars
   command: "{{ drush_path }} --root {{ drupal_core_path }} -y config-set search_api.server.default_solr_server backend_config.connector_config.host {{ hostvars[groups['solr'][0]].ansible_host  }}"
   register: set_search_api_config_host
-  changed_when: "'Do you want to update' in set_search_api_config.stdout"
+  changed_when: "'Do you want to update' in set_search_api_config_host.stdout"
 
 - name: Set default solr server to point to first core
   command: "{{ drush_path }} --root {{ drupal_core_path }} -y config-set search_api.server.default_solr_server backend_config.connector_config.core {{ solr_cores[0] }}"
   register: set_search_api_config_core
-  changed_when: "'Do you want to update' in set_search_api_config.stdout"
+  changed_when: "'Do you want to update' in set_search_api_config_core.stdout"
 
 - name: Create SOLR config.zip
   command:

tomcat.yml

@@ -21,4 +21,5 @@
     - Islandora-Devops.grok
     - Islandora-Devops.cantaloupe
     - Islandora-Devops.activemq
-    - Islandora-Devops.fits
+    - name: Islandora-Devops.fits
+      when: webserver_install_fits

vars/starter.yml

@@ -0,0 +1,31 @@
+---
+drupal_build_composer_project: true
+
+# None necessary, should all be described in the given project.
+#drupal_composer_dependencies: []
+
+# Presently pointing at the main branch.
+drupal_composer_project_package: 'islandora/islandora-starter-site:dev-main'
+
+# XXX: Strictly, irrelevant due to using the `--existing-config` flag.
+drupal_install_profile: minimal
+
+# None necessary, due to using an existing configuration.
+#drupal_enable_modules: []
+
+drupal_site_install_extra_args:
+  - '--existing-config'
+
+# The "starter" is expected to have all of its composer requirements and config
+# included, including spec'ing what modules are enabled in a site.
+openseadragon_composer_require: false
+webserver_app_uninstall_search_module: false
+webserver_app_feature_import_base: false
+
+# We want more granular control over what is added to the "settings.php".
+webserver_app_do_original_trusted_host_and_more: false
+webserver_app_do_trusted_host: true
+webserver_app_do_fedora_scheme_config: true
+
+post_install_migrate_import_fits_tags: true
+post_install_chown_defaults: false

vars/starter_dev.yml

@@ -0,0 +1,33 @@
+---
+drupal_build_composer_project: false
+drupal_deploy: true
+drupal_deploy_repo: https://github.com/Islandora/islandora-starter-site.git
+drupal_deploy_version: main
+drupal_deploy_dir: "{{ drupal_composer_install_dir }}"
+drupal_deploy_composer_install: true
+
+# XXX: Not usable with `drupal_deploy`.
+#drupal_composer_dependencies: []
+
+# XXX: Strictly, irrelevant due to using the `--existing-config` flag.
+drupal_install_profile: minimal
+
+# None necessary, due to using an existing configuration.
+#drupal_enable_modules: []
+
+drupal_site_install_extra_args:
+  - '--existing-config'
+
+# The "starter" is expected to have all of its composer requirements and config
+# included, including spec'ing what modules are enabled in a site.
+openseadragon_composer_require: false
+webserver_app_uninstall_search_module: false
+webserver_app_feature_import_base: false
+
+# We want more granular control over what is added to the "settings.php".
+webserver_app_do_original_trusted_host_and_more: false
+webserver_app_do_trusted_host: true
+webserver_app_do_fedora_scheme_config: true
+
+post_install_migrate_import_fits_tags: true
+post_install_chown_defaults: false

webserver.yml

@@ -23,4 +23,5 @@
     - perms-fix
     - Islandora-Devops.drupal-openseadragon
     - webserver-app
-    - Islandora-Devops.matomo
+    - name: Islandora-Devops.matomo
+      when: webserver_install_matomo