### Example JAVA_HOME setting Source: https://islandora.github.io/documentation/installation/manual/installing-tomcat-and-cantaloupe/ Example of setting JAVA_HOME to a typical Java 11 installation path on Ubuntu. ```bash export JAVA_HOME="/usr/lib/jvm/java-11-openjdk-amd64" ``` -------------------------------- ### Start ActiveMQ from bin directory Source: https://islandora.github.io/documentation/alpaca/alpaca-technical-stack/ Commands to start ActiveMQ from the installation bin directory. After starting, the admin console is available at http://localhost:8161/admin/ with default credentials admin:admin. ```bash $ cd activemq_install_dir/bin $ ./activemq start ``` -------------------------------- ### Start Alpaca with external properties file Source: https://islandora.github.io/documentation/installation/manual/installing-alpaca/ Start Alpaca by passing an external properties file with the -c or --config flag. The example uses /opt/alpaca/alpaca.properties. ```bash java -jar alpaca.jar -c /opt/alpaca/alpaca.properties ``` -------------------------------- ### Install Drupal using Drush site-install Source: https://islandora.github.io/documentation/installation/manual/installing-composer-drush-and-drupal/ Installs the basic Drupal Recommended Project with the standard profile. Uses the same database parameters as the MySQL setup. Replace placeholders with your site name, admin username, and password. ```bash cd /var/www/drupal sudo -u www-data drush -y site-install standard --db-url="mysql://MYSQL_USER_FOR_DRUPAL:MYSQL_PASSWORD_FOR_DRUPAL@127.0.0.1:3306/DRUPAL_DATABASE_NAME" --site-name="SITE_NAME" --account-name=DRUPAL_LOGIN --account-pass=DRUPAL_PASS ``` -------------------------------- ### Start containers from new images Source: https://islandora.github.io/documentation/installation/docker/site-template/updating/ Starts the containers from the newly built images. ```bash docker compose up -d ``` ```bash make up ``` -------------------------------- ### Install MySQL server Source: https://islandora.github.io/documentation/installation/manual/preparing-a-webserver/ Install the MySQL server package using apt. ```bash sudo apt install mysql-server ``` -------------------------------- ### Example derivative configuration Source: https://islandora.github.io/documentation/installation/manual/installing-alpaca/ Example configuration with two services (houdini and fits) showing all required properties. ```properties derivative.systems.installed=houdini,fits derivative.houdini.enabled=true derivative.houdini.in.stream=queue:islandora-connector-houdini derivative.houdini.service.url=http://127.0.0.1/houdini/convert derivative.houdini.concurrent-consumers=1 derivative.houdini.max-concurrent-consumers=4 derivative.houdini.async-consumer=true derivative.fits.enabled=true derivative.fits.in.stream=queue:islandora-connector-fits derivative.fits.service.url=http://127.0.0.1/crayfits derivative.fits.concurrent-consumers=2 derivative.fits.max-concurrent-consumers=2 derivative.fits.async-consumer=false ``` -------------------------------- ### Enable and start Tomcat service Source: https://islandora.github.io/documentation/installation/manual/installing-tomcat-and-cantaloupe/ Enables Tomcat to start on boot and starts it immediately. Verify with 'sudo systemctl status tomcat | grep Active' expecting 'active (running)'. ```bash sudo systemctl enable tomcat sudo systemctl start tomcat ``` -------------------------------- ### Install cURL with apt Source: https://islandora.github.io/documentation/installation/manual/installing-composer-drush-and-drupal/ Check if cURL is already installed with `curl --version`. If not, install it using `sudo apt install curl`. ```bash sudo apt install curl ``` -------------------------------- ### Install GNU make on Ubuntu (WSL 2) Source: https://islandora.github.io/documentation/installation/docker/docker-prereq/ For Windows users running Ubuntu on WSL 2, install GNU make by updating the package list and then installing make with apt. ```bash sudo apt update ``` ```bash sudo apt install make ``` -------------------------------- ### Install ActiveMQ via system package Source: https://islandora.github.io/documentation/installation/manual/installing-alpaca/ Installs ActiveMQ using apt-get. Provides base configuration at /var/lib/activemq/conf, data storage at /var/lib/activemq/data, installation at /usr/share/activemq, and an activemq service running on boot. ```bash sudo apt-get -y install activemq ``` -------------------------------- ### Run Solr installer script Source: https://islandora.github.io/documentation/installation/manual/installing-solr/ Runs the Solr installer script to set up the Solr user, installation location, and boot configurations. Replace UNTARRED_SOLR_FOLDER with the extracted folder name (e.g., solr-VERSION) and SOLR_TARBALL with the downloaded tarball filename. ```bash sudo UNTARRED_SOLR_FOLDER/bin/install_solr_service.sh SOLR_TARBALL ``` -------------------------------- ### Serve documentation locally with live preview Source: https://islandora.github.io/documentation/technical-documentation/docs-build/ Runs the make serve command to start a local server at http://localhost:8080 with live reload. Stop with Control-c. ```bash make serve ``` -------------------------------- ### Run make demo_content to import demo content Source: https://islandora.github.io/documentation/installation/docker/isle-dc/docker-local/ Run 'make demo_content' to populate your site with sample objects. ```bash make demo_content ``` -------------------------------- ### Example: require drupal/islandora branch with alias Source: https://islandora.github.io/documentation/contributing/testing-a-pull-request/ Example that installs the enable-hocr branch of drupal/islandora and aliases it to 2.12.1 so it meets the ^2.4.1 requirement of drupal/islandora_mirador. ```bash composer require "drupal/islandora:dev-enable-hocr as 2.12.1" ``` -------------------------------- ### SPARQL Query Example: Getting Objects in a Collection Source: https://islandora.github.io/documentation/technical-documentation/testing-notes/ Example SPARQL query to find objects in a specific collection at http://localhost:8000/node/7?_format=jsonld. ```sparql select ?s where { ?s } ``` -------------------------------- ### Run make starter to install Drupal site Source: https://islandora.github.io/documentation/installation/docker/isle-dc/docker-local/ Run 'make starter' to install the Drupal site in your codebase folder and spin up all other containers. ```bash make starter ``` -------------------------------- ### Show make command helpers Source: https://islandora.github.io/documentation/installation/docker/converting/ Run `make help` to familiarize yourself with the new make command helpers provided by the Site Template. ```bash make help ``` -------------------------------- ### Stop and start containers for production Source: https://islandora.github.io/documentation/installation/docker/site-template/updating/ Stop and start containers to get the new image. Use docker compose down followed by docker compose up -d or make up. ```bash docker compose down ``` ```bash docker compose up -d ``` ```bash make up ``` -------------------------------- ### Example title element from GET response Source: https://islandora.github.io/documentation/technical-documentation/rest-create/ Shows the 'title' element structure returned by a GET request. The 'value' field contains the node title, which is a required field for all nodes. ```json "title" : [ { "value" : "An example Islandora object" } ] ``` -------------------------------- ### Example type element from GET response Source: https://islandora.github.io/documentation/technical-documentation/rest-create/ Shows the 'type' element structure returned by a GET request on an existing node. The target_id 'islandora_object' is the machine name for the 'Repository Item' content type. The target_uuid is not needed for POST requests. ```json "type" : [ { "target_id" : "islandora_object", "target_type" : "node_type", "target_uuid" : "62189bec-3ef3-4196-b847-b17e5ce61fd5" } ] ``` -------------------------------- ### Example field_model element from GET response Source: https://islandora.github.io/documentation/technical-documentation/rest-create/ Shows the 'field_model' element structure returned by a GET request. The target_id is the taxonomy term ID for the model (e.g., 24 for Image, 23 for Collection). Taxonomy terms may vary between instances. ```json "field_model": [ { "target_id": 24, "target_type": "taxonomy_term", "target_uuid": "e7560b68-e95a-4e76-9671-2a3041cd9800", "url": "\/taxonomy\/term\/24" } ] ``` -------------------------------- ### Download and install Composer 2.x Source: https://islandora.github.io/documentation/installation/manual/installing-composer-drush-and-drupal/ Downloads the Composer installer, makes it executable, runs it, and moves the resulting `composer.phar` to `/usr/local/bin/composer`. ```bash curl "https://getcomposer.org/installer" > composer-install.php chmod +x composer-install.php php composer-install.php sudo mv composer.phar /usr/local/bin/composer ``` -------------------------------- ### Check and manage Solr service with systemctl Source: https://islandora.github.io/documentation/installation/manual/installing-solr/ Checks the status of the Solr service and stops/starts it as needed. The installer starts the service automatically, but you may need to restart it after configuration changes. ```bash sudo systemctl status solr sudo systemctl stop solr sudo systemctl start solr ``` -------------------------------- ### Composer require command for Drupal modules Source: https://islandora.github.io/documentation/technical-documentation/updating-drupal/ Use Composer to install Drupal modules and themes. The example shows requiring the jsonld module version ^2 from the drupal/ namespace. ```bash $ composer require "/:" # Example $ composer require "drupal/jsonld:^2" ``` -------------------------------- ### Reinstall drupal/islandora with --prefer-source and --no-cache Source: https://islandora.github.io/documentation/contributing/testing-a-pull-request/ Example command to reinstall the drupal/islandora package from source, including --no-cache to avoid cache issues when the site was previously installed without --prefer-source. ```bash composer reinstall "drupal/islandora" --prefer-source --no-cache ``` -------------------------------- ### Install Apache 2 with apt-get Source: https://islandora.github.io/documentation/installation/manual/preparing-a-webserver/ Installs Apache 2 and its utilities. This sets up a systemd service, configuration in /etc/apache2, a webroot at /var/www/html, and the www-data user/group. ```bash sudo apt-get -y install apache2 apache2-utils ``` -------------------------------- ### Build static preview for GitHub Pages Source: https://islandora.github.io/documentation/technical-documentation/docs-build/ Runs make preview to create a static site folder replicating GitHub Pages output. Served at http://localhost:8080. Stop with Control-c. ```bash make preview ```