Skip to content
This repository has been archived by the owner on Apr 27, 2022. It is now read-only.

europeana/europeana-virtual-exhibitions

Repository files navigation

Europeana Virtual Exhibitions

Build Status Security Maintainability Test Coverage

Europeana's Virtual Exhibitions as a Rails app using Alchemy CMS.

License

Licensed under the EUPL v1.2.

For full details, see LICENSE.md.

Requirements

  • Ruby 2.x (latest stable version recommended)
  • ImageMagick
  • Redis
  • PostgreSQL

Preparation

  • Create a PostgreSQL db
  • Create a Redis data store

Installation

  • Clone this repository
  • Configure with environment variables. See .env.example for available variables, documented in doc/environment.md, and in development/test copy this to .env.development or .env.test. Be sure to set DATABASE_URL to the URL of your PostgreSQL db.
  • Create config/redis.yml with a Redis URL for your environment. See samples beneath deploy/.
  • Run bundle install
  • Run bundle exec rake db:setup

Usage

  • Run each command in the Procfile as a separate app instance. In development, use foreman start to run all.
  • The root URL of the application is /portal/exhibitions
  • Create an admin account at /portal/exhibitions/admin/signup
  • See Alchemy CMS documentation for general guidance on using the CMS.

Docker

A Dockerfile is included, optimised for small image size, for publication to a Docker repository and use in production environments.

Configure version

export VERSION=2.3.0

Build

docker build -t europeana/virtual-exhibitions:${VERSION} .

Run

docker run \
       -p 8080:80 \
       --env-file=.env.docker \
       europeana/virtual-exhibitions:${VERSION}

Publish

docker push europeana/virtual-exhibitions:${VERSION}