Getting Started

For a first look, run Flink Manager with the in-memory profile: no external database is needed, and data is kept in memory (lost on restart). This is for quick tests only — for production, use the default profile with PostgreSQL (see Installation).

Create a .env file next to your docker-compose.yml:

# .env — the compose file refuses to start without these
DB_PASSWORD=change-me
JWT_SECRET=<random-base64-secret>
AUTH_SECRET_KEY=<random-32-bytes-base64>

# docker-compose.yml
services:
  flink-manager:
    image: vinteroslabs/flink-manager:latest
    pull_policy: always
    ports:
      - "${SERVER_PORT:-8080}:${SERVER_PORT:-8080}"
    environment:
      FLINK_SERVER_URL: "${FLINK_SERVER_URL:-http://jobmanager:8081}"
      FLINK_SQL_GATEWAY_URL: "${FLINK_SQL_GATEWAY_URL:-http://jobmanager:8083}"
      FLINK_SAVEPOINT_DIR: "${FLINK_SAVEPOINT_DIR:-/tmp/flink-savepoints}"
      DB_URL: "${DB_URL:-jdbc:postgresql://db:5432/flink-manager}"
      DB_USERNAME: "${DB_USERNAME:-flinkmgr}"
      DB_PASSWORD: "${DB_PASSWORD:?Set DB_PASSWORD in .env}"
      JWT_SECRET: "${JWT_SECRET:?Set JWT_SECRET in .env}"
      JWT_EXPIRATION_MS: "${JWT_EXPIRATION_MS:-43200000}"
      AUTH_SECRET_KEY: "${AUTH_SECRET_KEY:?Set AUTH_SECRET_KEY in .env}"
      AUTH_UI_BASE_URL: "${AUTH_UI_BASE_URL:-http://localhost:8080/flink-manager}"
      CORS_ALLOWED_ORIGINS: "${CORS_ALLOWED_ORIGINS:-}"
      SERVER_PORT: "${SERVER_PORT:-8080}"
      SPRING_PROFILES_ACTIVE: "${SPRING_PROFILES_ACTIVE:-in-memory-db}"

docker compose up -d

• SPRING_PROFILES_ACTIVE defaults to in-memory-db in this template — no PostgreSQL needed. Data is not persisted: everything is lost when the container restarts. This profile is for quick tests only, not recommended beyond a first look.
• The database variables (DB_URL, DB_USERNAME, DB_PASSWORD) are unused by the in-memory profile but are kept in the template so switching to a persistent deployment later is just a profile change.
• CORS_ALLOWED_ORIGINS can stay empty: the console is served by the application itself, so the browser talks to the API on the same origin and no cross-origin permission is needed. Set it only if you serve the console from a different origin (e.g. behind a reverse proxy on another domain) — see Configuration.
• To make this same compose file production-ready, set SPRING_PROFILES_ACTIVE=default in .env and point DB_URL at your PostgreSQL — see Installation.

Open http://localhost:8080/flink-manager/ and sign in with the seeded administrator account:

The FLINK_SERVER_URL passed at startup is only a bootstrap default. You can review or change the cluster connection at any time in the UI under Configuration → Flink Cluster — values saved there take effect at runtime, without a restart.

If you plan to use the SQL workbench, also set the SQL Gateway endpoint (FLINK_SQL_GATEWAY_URL or the same page).

Go to Configuration → License and paste the license token you received from Vinteros Labs. Until a valid license is installed, protected operations are locked. For a quick evaluation you can get a free trial license instantly from the license page — see the License guide for details.

• Production install (Docker, bundle + systemd) → Installation
• All environment variables → Configuration
• License activation details → License