Skip to content

Commit

Permalink
Add quickstart doc. (#2316)
Browse files Browse the repository at this point in the history
  • Loading branch information
rosiel authored Jun 5, 2024
1 parent 12ca931 commit 854b370
Show file tree
Hide file tree
Showing 3 changed files with 37 additions and 21 deletions.
25 changes: 4 additions & 21 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,13 @@

## This is Islandora

[Islandora](https://islandora.ca) is an open-source framework that provides the necessary tools to use a [Drupal](https://www.drupal.org) website as a fully-functional Digital Assets Management System.
[Islandora](https://islandora.ca) is an open-source framework that provides the necessary tools to use a [Drupal](https://www.drupal.org) website as a fully-functional Digital Assets Management System. See [Quickstart](installation/quickstart.md) to get started.

Islandora:

[//]: # (We should probably replace as many of the links in this section as possible with links to within this documentation, and make it clear which are internal links and which link out.)
- **Is native Drupal** - With Islandora, you can create preservation-ready digital resources using Drupal nodes, media, files, and taxonomy terms. A site with a ready-made suite of customized Drupal resource types and configurations that illustrate Islandora's capabilities is available as the [Islandora Starter Site module](https://github.com/Islandora/islandora-starter-site/).
- **Is native Drupal** - With Islandora, you can create preservation-ready digital resources using Drupal nodes, media, files, and taxonomy terms.
- **Provides a sensible starting place** - No two Islandora sites are the same, but we provide a starting point for Drupal - the [Islandora Starter Site](https://github.com/Islandora/islandora-starter-site/) - as well as several methods of [installation](installation/quickstart.md) that set up a working suite of services external to Drupal and show off Islandora's capabilities.
- **Integrates with Fedora** - Drupal resources can be stored in Lyrasis's [Fedora Repository](https://wiki.duraspace.org/display/FF/Fedora+Repository+Home) (version 5.0 or greater) as binaries (files) and RDF metadata.
- **Uses microservices** - Islandora provides an architecture for messaging and integration with any number of microservices, that provide services outside of the Drupal framework. Islandora's [Crayfish](https://github.com/Islandora/crayfish) suite of microservices provides functionality for synchronizing resources into Fedora and for automatically generating helper files, called derivatives.
- **Can handle messages at scale** - Islandora created [Alpaca](https://github.com/Islandora/Alpaca), an integration middleware based on Apache Camel, to handle messaging and queueing at an enterprise scale. To the user, this means large batch uploads can be processed gracefully.
Expand All @@ -20,28 +21,10 @@ Islandora:
- **Offers flexibility** - As Islandora content is Drupal content, migrations and batch editing can be done through Drupal's built-in migrate framework and vocabularies can be created using Drupal taxonomies. Contributed Drupal modules such as [Solr Search API](https://www.drupal.org/project/search_api_solr) enable in-site search, and [Matomo Analytics](https://www.drupal.org/project/matomo) provides usage metrics for site analytics.
- **Is a community** - A [dedicated, active community of users and developers](https://groups.google.com/forum/#!forum/islandora) is working to push new features, collaborate on improvements, design custom solutions, and create extended functionality. Some of these for Islandora 8 take the form of [Recipes](https://github.com/Islandora-Labs/Islandora-Cookbook).

## Try Islandora

### Online Sandbox

Try Islandora without installing anything at [sandbox.islandora.ca](https://sandbox.islandora.ca/).

Login credentials for the sandbox can be found [here](https://github.com/Islandora/documentation/wiki/Sandbox.Islandora.ca-online-credentials).

Anyone can log in to this sandbox as an administrator and explore the interface! However, this site is refreshed every night so your changes will not be permanent. This site uses the Islandora Starter Site. This is not the only way that Islandora can be made to work! This sandbox includes some sample content and configuration (such as views and blocks) to increase its usefulness as a sandbox. [Learn more about the Islandora Starter Site](https://github.com/Islandora-Devops/islandora-starter-site).

### Ansible Playbook

Islandora can be installed via an an [Ansible Playbook](https://github.com/Islandora-Devops/islandora-playbook), a machine-operable set of instructions which provisions the full Islandora stack. It can be used to create a locally installed Islandora (requiring your computer to have Vagrant and Virtualbox) or can be used to provision a remote Linux server. The provisioning process involves many steps where software is downloaded and installed, so it can take a while. There is an option to get a basic ("standard") site, or to install a suite of demo configurations known as the Demo Install Profile. See [Installation - Ansible Playbook](installation/playbook) for more details.

### Docker

Islandora sites can also be created using Docker. This can be done using the [ISLE-DC project](https://github.com/Islandora-Devops/isle-dc), which launches the Islandora Docker images created by [Isle Buildkit](https://github.com/Islandora-Devops/isle-buildkit). Like in the Ansible Playbook, there is an option to use a pre-built demo site, or build it completely from scratch. (There is also an option to build the demo site on command, which takes a bit more time, or to use ISLE-DC to build up the environment to support a Drupal site that you have already exported.) See [Installation - Docker ISLE](installation/docker-introduction) for more details

## Join the Community

The [Islandora community](https://www.islandora.ca/community) is an active group of users, managers, librarians, documenters, and developers from galleries, libraries, archives, museums, and other institutions worldwide. We welcome discussion and contribution through various mailing lists, channels, interest groups, and calls. The Islandora community operates under the [Islandora Code Of Conduct](https://www.islandora.ca/code-of-conduct). See our Contributing Guidelines for more information.


!!! note "Documentation for previous versions"
Documentation for Islandora 6 and 7 is on the [Lyrasis documentation wiki](https://wiki.lyrasis.org/display/ISLANDORA/Start).
Documentation for Islandora Legacy (6 and 7) is on the [Lyrasis documentation wiki](https://wiki.lyrasis.org/display/ISLANDORA/Start).
32 changes: 32 additions & 0 deletions docs/installation/quickstart.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# Quickstart

There are several ways to try Islandora, which are presented here in order of increasing sophistication. By default, they all install the [Islandora Starter Site](https://github.com/Islandora-Devops/islandora-starter-site) which is a starting place for customizing your own site, as well as our suite of external services.

## Online Sandbox

Try Islandora without installing anything at [sandbox.islandora.ca](https://sandbox.islandora.ca/).
[Login credentials](https://github.com/Islandora/documentation/wiki/Sandbox.Islandora.ca-online-credentials) for the sandbox can be found on our Wiki.

Anyone can log in to this sandbox as an administrator and explore the interface! However, this site is refreshed every night so your changes will not be permanent. This site uses the Islandora Starter Site. This sandbox includes some sample content and configuration (such as views and blocks) to increase its usefulness as a sandbox. .

## Docker Portainer Demo

Alternately, with Docker Desktop, you can run a demo locally using Docker's Portainer extension. The command line is not required. See [Docker Portainer Demo](install-a-demo.md) for instructions. Note that this method does not support installing modules or themes that are not included with the demo.

## Sandbox running locally

Alternately, you can use Docker and install the Online Sandbox repository locally, with minimal command-line usage. Note that this method does not support installing modules or themes that are not included with the demo. See the instructions for "Running Locally" in the [Sandbox's README](https://github.com/Islandora-Devops/sandbox).

## Ansible Playbook

To provision a local Vagrant or remote Ubuntu virtual machine (without Docker), you can use the [Islandora Ansible Playbook](https://github.com/Islandora-Devops/islandora-playbook). The playbook results in all services installed on a single machine, but can be altered to spread services across various machines. This is a full-fledged VM where you can install modules and themes using Composer. This method requires basic command-line usage and it's advantageous if you are familiar with provisioning software on Ubuntu. This Playbook is suitable for local or production use, though local use (through VirtualBox and Vagrant) is not supported yet by Apple hardware (i.e. M1/M2 machines). See documentation: [Installation - Ansible Playbook](installation/playbook) for more details.

## ISLE Site Template

[ISLE Site Template](https://github.com/Islandora-Devops/isle-site-template) uses Docker and is based off images created by [ISLE Buildkit](https://github.com/Islandora-Devops/isle-buildkit), but is a simpler tool than ISLE-DC. This is a full-fledged Docker installation where you can install modules and themes using Composer, either by executing commands in the container or by using the built-in IDE. It is suitable for local development or production. See documentation: [Installation - Site Template](http://localhost:8111/documentation/installation/docker/site-template/site-template/) for more details.

## ISLE-DC

[ISLE-DC](https://github.com/Islandora-Devops/isle-dc) uses Docker and provisions each service in the Islandora stack in a separate container. The containers are also based off of the images in ISLE Buildkit. ISLE-DC uses the [GNU Make](https://www.gnu.org/software/make/) tool to provide several shortcuts to performing common management functions. It is suitable for local development or production. See documentation: [Installation - Docker ISLE](installation/docker-introduction) for more details.


1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,7 @@ nav:
# Conceptual, all user roles: should contain high-level information about
# what everybody needs to know to understand Islandora and interact with it
# Possibly add page/section: How to use this documentation (containing user role definitions)
- Quickstart: 'installation/quickstart.md'
- Concepts:
- 'Nodes in Islandora': 'concepts/node-concepts.md'
- 'Media in Islandora': 'concepts/node-media.md'
Expand Down

0 comments on commit 854b370

Please sign in to comment.