Skip to main content

Before You Begin

Before starting to set up a Docker-based iAP development environment, choose the environment you will build, check the specifications of your PC, and prepare the required software and materials.

Choosing Your Environment​

Before setting up an iAP development environment with Docker, determine the iAP version, database, and configuration for your environment.

Selecting a Repository (Configuration)​

This guide offers the following two configuration options depending on your needs:

RepositoryConfigurationDescriptionURL
docker-stacksStandalone configurationStandard configuration with a single Resin service.https://github.com/accelplatform/docker-stacks
docker-stacks-clusterCluster configurationLoad-balancing configuration with two Resin services and Apache HTTPd.https://github.com/accelplatform/docker-stacks-cluster

Standalone Configuration

Cluster Configuration

Configuration Features and Use Cases​

AspectStandalone ConfigurationCluster Configuration
Number of Resin instances12
Use caseVerifying standalone operation, feature development, testingVerifying multi-node behavior, checking session synchronization and distributed processing
Recommended scenariosPer-feature testing and verificationValidation in cluster environments, verifying behavior with multiple Resin instances
When in Doubt

If you do not specifically need to verify behavior in a cluster environment, the standalone configuration is sufficient.

The common setup steps for each configuration are summarized in Common Setup Steps; the configuration-specific diagrams, service lists, and URL / port numbers are summarized in Standalone Configuration / Cluster Configuration.

Selecting a Branch (iAP Version × DB)​

Each repository provides combinations of iAP version and database (DB) through branches.

Branch names follow the naming convention below:

{iAP version}-{DB}

Branch name examples:

  • 2026autumn-postgres
  • 2026autumn-oracle
  • 2026autumn-sqlserver
List of Available Branches

The list of available branches can be found on each repository's GitHub page by using the branch selection menu or visiting the Branches page.

When Selecting Oracle / SQL Server

If you select an Oracle or SQL Server branch, be sure to read the README.md of that branch, as there may be additional database-specific setup steps or limitations.

These are the recommended specifications for running the iAP development environment on Windows (Docker Desktop + WSL2). CPU and memory indicate the amounts allocated to WSL2.

About These Values

The values below are reference values estimated from the settings of each service. They do not guarantee operation or performance.

ItemStandalone (minimum)Standalone (recommended)Cluster (minimum)Cluster (recommended)
CPU (allocated to WSL2)4 cores8 cores6 cores8 cores or more
Memory (allocated to WSL2)8GB12–16GB14GB16–20GB
Free disk space30GB50GB or more (SSD)30GB50GB or more (SSD)
Memory installed in the host PC16GB32GB32GB32GB or more

Memory Usage by Service (Guideline)​

ServiceStandaloneClusterBasis
ResinAbout 5GBAbout 10GB (5GB × 2)Heap fixed at -Xms4096m -Xmx4096m in resin.properties, plus the JVM's off-heap memory
Cassandra 1.1.121–3GB1–4GBNo heap specified; automatically reserves about 1/4 of the VM's memory (up to 8GB)
Solr 9.60.5–1GB0.5–1GBDefault heap of 512MB
PostgreSQL / Apache HTTPd / mailpitAbout 0.5GBAbout 0.5GB
Test Execution Agent (optional)+1–2GB+1–2GBPlaywright / Chromium
juggling-build-war (only while building)+1–2GB+1–2GBBuilding the war
Total (resident)About 8–10GBAbout 13–16GB

Installing Required Software​

Before proceeding with the iAP development environment setup, install the following software on your PC by following the official installation instructions for each:

SoftwareRoleOfficial Installation Instructions
Docker DesktopUsed to build and start the iAP development environment (container group) described in this guide.Docker Desktop for Windows
Docker Desktop for Mac
Docker Desktop for Linux
GitUsed to obtain the repository used in this guide.git - Install
Git LFSUsed to retrieve large files in the repository (such as those under lib/).git-lfs - Installation
For Windows Users

In Windows environments, set up WSL2 (Windows Subsystem for Linux 2) before installing the software described in this section. Install Git and Git LFS on the Linux distribution (Ubuntu) on WSL2, and configure Docker Desktop to use the WSL2 backend.

WSL2 Setup​

This section is for users working in a Windows environment. If you are on macOS or Linux, skip this section and proceed to Docker Desktop Setup.

In Windows environments, this guide assumes you use the terminal of the default Linux distribution (Ubuntu) on WSL2 (Windows Subsystem for Linux 2). Unless otherwise specified, all command operations in this guide are intended to be run inside the WSL2 terminal (bash).

  • Open a WSL2 terminal: Go to the Start menu → select Ubuntu to launch it. If you have Windows Terminal installed, you can also open Ubuntu by selecting it from the profile list.
  • Open PowerShell (for supplementary operations): Go to the Start menu → type "PowerShell" → select "Windows PowerShell." Use this for Windows-side operations such as verifying the Docker Desktop installation.
Notes for Windows (WSL2) Environments

In Windows environments, it is recommended to run Docker Desktop with the WSL2 (Windows Subsystem for Linux 2) backend and to place the repository and run commands within the WSL2 Linux filesystem. Working from a Windows-side directory (under /mnt/c, i.e., the C:\ drive, etc.) significantly slows down file I/O, affecting docker compose build, war builds, and container startup.

If you have not yet installed WSL2, follow the instructions at https://learn.microsoft.com/windows/wsl/install to set it up.

This guide assumes Ubuntu as the Linux distribution. After installation, verify that you can launch Ubuntu from the Start menu.

Docker Desktop Setup​

Follow the official installation instructions referenced above to complete the setup.

After installation, run the following commands in a terminal (PowerShell for Windows environments) to verify that version information is displayed.

Verification command (check engine is responding):

docker --version

Expected output (example):

Docker version 29.4.3, build ...

Verification command (check Compose is enabled):

docker compose version

Expected output (example):

Docker Compose version v5.1.3

Docker Desktop WSL2 Integration​

In Windows environments, continue by configuring the WSL2 integration. If you are on macOS or Linux, proceed to Git / Git LFS Setup.

In the Docker Desktop UI, verify the following settings and enable them if not already active:

  • Settings → General → Use the WSL 2 based engine is enabled.
  • Settings → Resources → WSL Integration has integration enabled for Ubuntu.

This configuration makes the docker and docker compose commands available inside the WSL2 terminal. Run the version verification commands inside the WSL2 terminal to confirm that version information is displayed there as well.

docker --version
docker compose version

Git / Git LFS Setup​

Follow the official installation instructions referenced above to complete the setup.

For Windows Environments

In Windows environments, install on the Linux distribution (Ubuntu) on WSL2.

After installation, run the following commands in a terminal to verify that version information is displayed.

Git​

Verification command:

git --version

Expected output (example):

git version 2.54.0

Git LFS​

Verification command:

git lfs version

Expected output (example):

git-lfs/3.7.1 (GitHub; ...)
Proxy Environment Configuration

In proxy environments, Git and Docker Desktop may require proxy settings. If git clone, docker compose build, or docker compose up fails, check your proxy configuration.

  • Git: Configure the proxy with the following commands: 
    git config --global http.proxy http://proxy:port
    git config --global https.proxy http://proxy:port
  • Docker Desktop: Configure as appropriate for your environment:
    • Docker Desktop UI: Settings > Resources > Proxies

Required Materials and Licenses​

The following must be prepared before following the steps in this guide:

The exact file names (including version numbers) for each material, and where to place them after downloading, are described in Common Setup Steps.