Skip to main content

Community (Local) Edition

A local ApertureDB instance supports evaluation and application development. Applications with an existing managed instance need only client configuration; the Quick Start uses either type of instance.

The Docker Compose deployment guide defines the package selection, images, storage, ports, credentials, TLS settings, startup, and cleanup commands for a local installation.

Non-Mac Systems​

A local installation requires the prerequisites and storage configuration listed in the deployment guide. The package images must support the host architecture and be accessible from its container registry.

Setup on Mac​

The same package applies on macOS, subject to image support for the machine's architecture. If a host port is occupied, choose another port and use it in the client profile. Port conflicts can occur on any platform.

Run ApertureDB along with WebUI using Docker Compose​

The Compose package includes the database, Web UI, and gateways, with their service configuration and image tags.

Before starting, set a strong master key and review each published port. Keep plaintext evaluation endpoints on a trusted local machine. The database's ADB_FORCE_SSL, Lenz's LNZ_FORCE_SSL, and the web proxy's HTTPS listener apply to different connections; the package's TLS and certificate instructions describe those boundaries.

Connect and verify​

Configure the Python client or REST client, then run GetStatus using the deployment verification procedure. A successful response confirms that the client can reach and authenticate to the instance. The Quick Start adds and retrieves data through that connection.

Stop and clean up​

Use the selected package's shutdown instructions. Stopping containers and removing persistent data are different operations: keep the volumes to retain evaluation data. Remove only the project and storage created for the installation.

The deployment chooser also covers Kubernetes and infrastructure provisioning. Production support and availability requirements depend on the selected layout; confirm them with the deployment maintainer.