alf.io - The open source ticket reservation system
Clone or download

README.md

alf.io

alf.io

Build Status Coverage Status

Warning

As the work for Alf.io v2 has started, this branch may contain unstable and untested code. If you want to build and deploy alf.io by yourself, we strongly suggest you to use the 1.x-maintenance branch.

Prerequisites

You should have installed Java version 8 (either Oracle's or OpenJDK) in order to build and run alf.io. Please note that for the build process the JDK is required.

Run on your machine

Gradle Build

This build includes a copy of the Gradle wrapper. You don't have to have Gradle installed on your system in order to build the project. Simply execute the wrapper along with the appropriate task, for example

./gradlew clean

Running with multiple profiles

You must specify a project property at the command line, such as

./gradlew -Pprofile=dev :bootRun

The local "bootRun" task has the following prerequisites:

  • a PostgreSQL instance up and runnning on localhost:5432
  • a postgres user having password: password
  • a database named alfio

once started, alf.io will create all the required tables on the database.

Note: if you want to test without installing a pgsql instance, we have configured the following tasks:

  • startEmbeddedPgSQL
  • stopEmbeddedPgSQL

So, in a terminal first launch pgsql:

./gradlew startEmbeddedPgSQL

In another one launch alf.io

./gradlew -Pprofile=dev :bootRun

When you are done, kill the pgsql instance with:

./gradlew stopEmbeddedPgSQL

The following profiles are supported

  • dev
  • dev-pgsql
  • docker-test

You can get a list of all supported Gradle tasks by running

./gradlew tasks --all

You can configure additional System properties (if you need them) by creating the following file and putting into it one property per line:

vi custom.jvmargs

Please be aware that since this file could contain sensitive information (such as Google Maps private API key) it will be automatically ignored by git.

For debug

Add a new line with: -agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=5005 in custom.jvmargs

Developing alf.io

Importing the Gradle project into Intellij and Eclipse both work.

Note: this project uses Project Lombok. You will need to install the corresponding Lombok plugin for integration into your IDE.

Check dependencies to update

./gradlew dependencyUpdates

Docker images

Pull the latest stable version from Docker Hub

docker pull alfio/alf.io

Here's an example of deployment as a 3 tier application using the following images:

  • postgres --> docker official image for PostgreSQL database
  • alfio/alf.io--> application runtime.
  • tutum/haproxy --> front layer proxy, force redirect to https and support load-balancing if multiple alf.io instances are running

Launch alf.io container instances

  • Define local directory for database data (on docker host, for data to survive postgres image restarts): /path/to/local/data = /data/postgres/alfio

  • Launch the Postgres instance

docker run --name alfio-db -e POSTGRES_DB=postgres -e POSTGRES_USERNAME=postgres -e POSTGRES_PASSWORD=alfiopassword --restart=always -d -v /path/to/local/data:/var/lib/postgresql/data postgres
* Note: on Mac volumes don't work (see https://jhipster.github.io/installation.html for a possible workaround), launch the above command without the `-v` parameter (data are lost at every restart)
  • Launch the alf.io server
docker run --name alfio --link alfio-db:postgres -d alfio/alf.io
Please note that at the moment, the only alias supported for the DB link is *postgres*
  • Launch the proxy
docker run --name alfio-proxy --link alfio:web1 -e SSL_CERT="$(awk 1 ORS='\\n' src/main/dist/servercert.pem)" -e FORCE_SSL=yes -e PORT=8080 -p 443:443 -p 80:80 -d tutum/haproxy

Test alf.io application

  • Check alfio logs: docker logs alfio
  • Copy admin password in a secure place
  • Get IP of your docker container: (only on Mac/Windows, on linux the proxy will bind directly on your public IP)
    • boot2docker ip on Mac/Windows
  • Open browser at: https://DOCKER_IP/admin
  • Insert user admin and the password you just copied

Generate a new version of the alfio/alf.io docker image

  • Build application and Dockerfile:
./gradlew distribution
  • Enter the directory:
cd build/dockerize
  • Create docker image:
docker build -t alfio/alf.io .

About the included AppleWWDRCA.cer

The certificate at src/main/resources/alfio/certificates/AppleWWDRCA.cer has been imported for https://github.com/ryantenney/passkit4j#usage functionality. It will expire the 02/07/23 (as https://www.apple.com/certificateauthority/).

Available spring profiles:

  • dev: enable dev mode
  • debug-csp: add report-uri and log csp violations
  • http: enable if behind proxy or the call chain is not full https
  • spring-boot: added when launched by spring-boot
  • demo: enable demo mode, the accounts for the admin will be created on the fly
  • disable-jobs: disable jobs
  • jdbc-session: enable saving the http session in the database