Readme.md

docker-vufind2

What is Vufind?

from https://vufind-org.github.io/vufind/

VuFind is a library resource portal designed and developed for libraries by libraries. The goal of VuFind is to enable your users to search and browse through all of your library's resources by replacing the traditional OPAC to include:

• Catalog Records

• Locally Cached Journals
• Digital Library Items
• Institutional Repository
• Institutional Bibliography
• Other Library Collections and Resources

VuFind is completely modular so you can implement just the basic system, or all of the components. And since it's open source, you can modify the modules to best fit your need or you can add new modules to extend your resource offerings.

What is this image intended for?

This image goes to all the vufind developers that want a testing environment for their development environment set up in no time.

It is out of the box usable on linux hosts with a docker version >= 1.10

The image makes use of useltmann/dev-dotdeb - which prepares lamp with several development tools like xdebug and webgrind, and wraps around your local clone of vufind2 from https://github.com/vufind-org/vufind

Please refer to useltmann/dev-dotdeb on how to use the tools provided.

How to use this image

First you should clone the vufind2 code somewhere in your development environment (eg. /home/me/vufind2)

git clone https://github.com/vufind-org/vufind.git /home/me/vufind2

create a container

now you can run the docker image to use this folder as vufind base and wrap the runtime environment around

docker run --name vufind2-container \
  -v /home/me/vufind2:/usr/local/vufind2 \
  -p 127.0.0.1:80:80 \
  -p 127.0.0.1:443:443 \
  -p 127.0.0.1:8080:8080 \
  -p 127.0.0.1:3306:3306 \
  docker.io/ubleipzig/vufind2

this starts the container named vufind2-container and sets up all the components as well as vufind2 itself with its default values. you should now be able to reach the vufind2 frontend at

http://127.0.0.1/vufind/

set up vufind

next step is to set up vufind2 via the frontend found here

http://127.0.0.1/vufind/Install

for creating the database you have to provide an authorized users credentials (root). the root user is perfectly suitable for this task. he has no password.

run phpunit on sourcecode

with a running vufind2-container you can either use the interactive console to run phpunit or you can make use of a single docker command script to run phpunit in a dedicated container

docker run --rm -ti -v /home/me/vufind2:/usr/local/vufind2 useltmann/vufind2 phpunit

a new container is initialized and a script is invoked which runs the default phpunit command to test the vufind2 code as the vufind-org ci-server would do. the container is removed immediately after phpunit has finished.

run codesniffer on sourcecode

the same applies to codesniffer as it does for phpunit. the command to run though is

docker run --rm -ti -v /home/me/vufind2:/usr/local/vufind2 useltmann/vufind2 phpcs

run an interactive console in the container

for interaction with vufind within the container you have to start a bash from within the container. do so by doing

docker exec -ti vufind2-container bash

you are now "logged in" the vufind2-container as user root. in order to work with vufind you should switch to user dev

su -l dev

this assures that all files you create remain accessable, editable and removable by you from outside the container

please be aware that the errors on the webpage occur because the database for vufind2 is not set up yet. just follow the instructions on the page.

The container's MySQL Server is set up with user root and no password. when you are prompted to fill in root's password yust leave it empty.

reset vufind data

to remove all project unspecific files from vufind you should do

git clean -d -x -n

which shows you what will be removed in order to clean the project path from either ignored or unversioned files and folders.

To perform the cleanup you have to omit the -n flag.

after that your docker container is not able to run anymore since you deleted the configuration it needs (at least apache2). yust remove the container by running

docker rm vufind2-container

and run a new one by invoking the command as listed on top

Advanced configuration

a more customized setup can be reached by providing several environment variables at container run time:

• if you are going to use a remote solr server to serve your search requests, then you do not need the container's solr to run. in that case you can provide an environment variable VUFIND_SOLR=remote to order docker not to start solr
• if you have a different apache2-setup, then you can provide a path to your httpd-vufind.conf relative to your vufind2 basepath by providing the environment variable VUFIND_HTTPD_CONF=local/dev/httpd-vufind.conf. be aware that the path has to be accessable from within the container and the specified file must exist, otherwise starting the container will fail

_furthermore all environment variables of the underlying image from useltmann/dev-dotdeb will work as well

docker-compose

for better control over docker containers most people - including me - use docker-compose as docker container description in their source folders. i recommend you to do so as well by creating a file called docker-compose.yml with the following content

version: '2'
services:
  lamp:
    image: docker.io/useltmann/vufind2
    ports:
      - 127.0.0.1:80:80
      - 127.0.0.1:443:443
      - 127.0.0.1:8080:8080
      - 127.0.0.1:3306:3306
    volumes:
      - ./:/usr/local/vufind2:z
      - db-data:/var/lib/mysql:z
volumes:
  db-data: {}

after that you can run the following command from within the vufind2 source folder.

docker-compose up

(re)creates the container based on the existing image. if no local image is found, the docker-registry is asked for it and pulled on existence.

docker-compose stop

stops the container

docker-compose start

starts the already existing container. to the contrary of docker-compose up the containers are not recreated (on first sight there is no difference to it since the data-volumes are not recreated by docker-compose up. but its the data-volumes, where the database is residing. and the sourcecode comes from your mounted host-system)

in order to recreate a new container with a fresh database you have to remove the existing containers

docker-compose down --volume

to run a single command i.e. a script like phpunit or_phpcs_ you can use docker-compose as well

docker-compose run --rm lamp phpunit

to run an arbitrary command, even a bash inside a connected container run

docker-compose run --rm lamp bash

note that every command issued like that is executed as dev-user. also the default VUFIND_* environment variables are set for all issued commands. the --rm option makes the container is removed immediately after the command is finished.