folio-ansible - Sample Ansible playbook and roles for FOLIO (and Vagrant)

This repository contains some sample Ansible roles for getting a FOLIO installation up and running quickly. For more details, see the doc directory.

The primary audiences for this project are:

1. Developers who want to take the code for a spin in a VM, without altering their own working environment.
2. Frontend developers looking for a "black box" FOLIO backend system to code against.
3. DevOps and others interested in automating FOLIO image builds
4. System administrators interested in deployment down the road.

License

Copyright (C) 2016-2019 The Open Library Foundation

This software is distributed under the terms of the Apache License, Version 2.0. See the file "LICENSE" for more information.

System Requirements

For Vagrant deployment:

• Vagrant >= 1.9.6 (note that Ubuntu provides a broken 2.0.2 version and an outdated 1.9.1 version, install the latest Debian file from the Vagrant Download page using dpkg -i vagrant\_….deb instead)
• VirtualBox

For Ansible provisioning (to build a dev VM, or to build the demo or backend system from scratch)

• Ansible >= 2.3

This installation has been tested on macOS "Sierra", Ubuntu 16.04 and 18.04, and Windows 10. Note that Windows cannot serve as an Ansible control host.

Quick Start

If all you want to do is try out a prepackaged FOLIO demo Vagrant box, create a new directory, cd into it, and try:

$ vagrant init folio/Q4-2018
$ vagrant up

Now you can open http://localhost:3000. Admin login: diku_admin/admin

Or, if you want to try a prepackaged FOLIO backend Vagrant box with the most recent versions of all components, try:

$ vagrant init folio/testing-backend
$ vagrant up

The testing boxes are absolutely not guaranteed to work together.

The Vagrant Cloud page folio lists all available boxes and has detailed release notes, including which versions of the backend and frontend modules are provided.

For all Vagrant boxes, the Okapi port on the VM (9130) will be forwarded to localhost:9130 and the Stripes port and user interface will be forwarded to localhost:3000. You should see the Stripes user interface at http://localhost:3000.

For more information, see Vagrant VMs and Ansible roles.

In addition, this project includes a Vagrantfile for creating different environments.

Documentation

• VM and playbook documentation
• Contributing guidelines
• Vagrant documentation
• Ansible documentation
• See project FOLIO at the FOLIO issue tracker.
• Other FOLIO Developer documentation is at dev.folio.org