Repository files navigation

The open source ticket reservation system.

Alf.io ([ˈalfjo]) is a free and open source event attendance management system, developed for event organizers who care about privacy, security and fair pricing policy for their customers.

You should have installed Java version17 (e.g.Oracle's,OpenJDK, or any other distribution) to build and run alf.io. Please note that for the build process the JDK is required.

Postgresql version 10 or later.

Additionally, the database user that creates and uses the tables should not be a "SUPERUSER", or else the row security policy checks will not be applied.

There are the following spring profiles

• dev: enable dev mode
• 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: persist the user session in the database

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

./gradlew clean

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 (version 10 or later) instance up and running on localhost:5432
• apostgres user having a password:password
• a database namedalfio

docker run -d --name alfio-db -p 5432:5432 -e POSTGRES_PASSWORD=password -e POSTGRES_DB=alfio --restart unless-stopped postgres

once started, alf.io will create all the required tables in the database, and be available athttp://localhost:8080/admin. You can log in using the default Usernameadmin and the password which was printed on the console.

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.

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

Importing the Gradle project into Intellij and Eclipse both work.

Notes:

• this project usesProject Lombok. You will need to install the corresponding Lombok plugin for integration into your IDE.
• this project usesTestContainers to run integration tests against a real PostgreSQL database. Please make sure that your configuration meetstheir requirements

export TESTCONTAINERS_RYUK_DISABLED=trueexport DOCKER_HOST=unix:///run/user/1000/podman/podman.sock

podman system service -t 0

./gradlew dependencyUpdates

Container images are available onhttps://hub.docker.com/r/alfio/alf.io/tags.

alf.io can also be run with Docker Compose (development mode):

docker-compose up

Running alf.io in production using Docker compose is not officially supported.However, if you decide to do so, then you need to make a couple of changes:

• Uncomment thealfio service in thedocker-compose.yml file
• Check the user and password for the services in the.env file
• Handle SSL termination (e.g. with something liketutum/haproxy) 443 -> 8080

• 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

./gradlew distribution

Alternatively, you can use Docker (experimental):

docker run --rm -u gradle -v "$PWD":/home/gradle/project -w /home/gradle/project gradle:7.0.0-jdk11 gradle --no-daemon distribution -x test

Please note that at the moment the command above performs the build without running the automated tests.Use it at your own risk.

docker build -t alfio/alf.io ./build/dockerize

The certificate at src/main/resources/alfio/certificates/AppleWWDRCAG4.cer has been imported forhttps://github.com/ryantenney/passkit4j#usage functionality.It will expire the 2030-10-12 (YYYY-MM-DD - as ofhttps://www.apple.com/certificateauthority/).

This project exists thanks to all the people who contribute.

A big "Thank you" goes also to our translators, who help us onPOEditor:

(we show the complete name/profile only if we have received explicit consent to do so)

translations completed but not yet integrated (WIP)

This project is sponsored by:

Open Source program

Become a financial contributor and help us sustain our community. [Contribute]

Support this project with your organization. Your logo will show up here with a link to your website. [Contribute]