Getting started
This section contains information on how to create a new Valtimo implementation. Instructions are available for two types of user groups that want to get started with Valtimo:
Business Process Engineers
Software Developers
The Valtimo platform consists of multiple services/containers. Depending on the edition (Valtimo or GZAC), a specific set of containers can be used for supporting a quick start-up. For both editions, a Docker Compose repository is available. These repositories include a guide on which Compose file(s) to use and how to use them.
Business Process Engineers
Available documentation for users that want to use Valtimo as an "Off the Shelf" application and do not want to be bothered with technical documentation on the setup and configuration of the environment.
In order to enable these users, instruction video's are recorded and made available in the online Valtimo Academy on how to make use of GIT and Docker Desktop to start up Valtimo on your own device (laptop or PC). The UI versions of the training material both have a first chapter that explains how to setup Valtimo on your own device in about 15 minutes.
* This training material is recorded in Dutch.
Running GZAC locally with demo process
GZAC (Generieke Zaakafhandelcomponent) is the Dutch municipal variant of Valtimo. The demo process in this guide concerns an application for an event permit and is in Dutch. This guide helps you install and run GZAC locally on macOS or Windows.
Install Homebrew, Git and Docker Desktop
Step 1: Install Homebrew
Open Spotlight with Cmd + Space, then open Terminal.
Go to https://brew.sh and copy the installation command.
Paste it into the Terminal and press Enter.
Follow the on-screen instructions.
👉 Already have Homebrew? You can skip this step.
Step 2: Install Git
Run the following command in Terminal:
brew install gitStep 3: Install Docker Desktop
Download the macOS version (Intel or Apple Silicon).
Open the .dmg file and drag Docker into Applications.
Launch Docker via Launchpad or Spotlight.
Wait until the whale icon appears in the menu bar.
Start GZAC
Open Terminal (macOS) or Git Bash / Windows Terminal (Windows).
Clone the GZAC repository:
git clone https://github.com/generiekzaakafhandelcomponent/gzac-docker-compose.gitNavigate into the directory:
cd gzac-docker-composeStart GZAC:
docker compose --profile zgw --profile demo up -d⏳ The first startup can take 5–10 minutes.
Open GZAC in your browser
Open your browser.
Visit http://localhost
Log in with the following credentials:
Username: admin
Password: admin
🎉 You’re now inside the GZAC environment and can explore the demo process.
For experienced users
For users that are already familiar with GIT and Docker Desktop, instructions are available in the README files of below mentioned repositories. Depending on the Valtimo edition, a Github repository should be checked out that contains the Docker Compose file.
For starting the Valtimo platform, the following repository should be checked out:
When starting the Valtimo platform as Docker containers, all supporting services and the two Valtimo services are started up with above Docker Compose files. The containers are designed for evaluation purposes only.\
Software developers
Documentation for tech-savvy engineers and developers on which modules are available and what settings at minimum are required to use them. Some knowledge on java build tools such as Maven or Gradle is assumed for these users.
Starting your own Valtimo implementation
When starting your own Valtimo implementation, the supporting services are started up with a Docker Compose file. The two Valtimo services are started up from their respective Git repositories using a command line interface (CLI) or integrated development environment (IDE).
Supporting services
Both editions of Valtimo require a Keycloak instance for Identity and Access Management. The Valtimo backend application requires a database container. Both PostgreSQL and MySQL are supported.
Application services
Valtimo consists of a frontend (Angular) and a backend (Java/Kotlin) application. Both services have their own Github repository with instructions on how the service can be started.
Repositories
Depending on the Valtimo edition, three Github repositories should be checked out:
Supporting Services
Backend application
Frontend application
For starting a Valtimo implementation, the following Github repositories should be checked out:
Instructions are available in the README files of above mentioned repositories.
Below pages contain additional information for engineers and developers for making choices in database type, available modules and an overview of tested versions in a compatibility matrix.
Last updated