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:
- Developers who want to take the code for a spin in a VM, without altering their own working environment.
- Frontend developers looking for a "black box" FOLIO backend system to code against.
- DevOps and others interested in automating FOLIO image builds
- System administrators interested in deployment down the road.
Copyright (C) 2016-2018 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.
For Vagrant deployment:
- Vagrant >= 1.9.6 (note that the version available in the standard Ubuntu repository is 1.9.1!)
- 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 Windows 10. Note that Windows cannot serve as an Ansible control host.
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/stable
$ 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, try:
$ vagrant init folio/stable-backend
$ vagrant up
There are also folio/testing
and folio/testing-backend
Vagrant boxes available,
which contain the most recent versions of all components, absolutely
not guaranteed to work together. The Vagrant Cloud page for
folio/stable 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.
There are two playbooks in this repo:
- folio.yml - builds the environments on the Vagrant boxes.
- build-perf.yml - builds an environment for performance testing.
- 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