Skip to content

Getting Started

Welcome to JIM. This section will guide you from initial setup through to running your first identity synchronisation.

Whether you are deploying JIM for production use or setting up a development environment, the pages below will walk you through each step.

Where to Start

  • Prerequisites

    What you need before deploying JIM: container runtime, identity provider, and hardware considerations.

    Prerequisites

  • Quick Start

    Deploy JIM on Docker or Podman using the installer, an air-gapped bundle, or a developer environment.

    Quick Start

  • Your First Sync

    Set up a Connected System, configure a Synchronisation Rule, and run your first import, sync, and export cycle.

    Your First Synchronisation

Overview

Getting JIM running involves three main steps:

  1. Prepare your environment: Ensure Docker or Podman is installed and you have access to an OpenID Connect identity provider for authentication.
  2. Deploy JIM: Use the installer, connected or air-gapped from a release bundle, or install by hand following the Deployment Guide.
  3. Configure your first synchronisation: Connect a source system, define Synchronisation Rules, and verify data flows correctly through the metaverse.

Once deployed, JIM's web portal answers over HTTPS at https://<JIM's name>, from any machine; see TLS and Reverse Proxy for its certificate. You can also interact with JIM through its REST API or the cross-platform PowerShell module.

Stuck?

If something does not behave the way you expect, the Q&A category in GitHub Discussions is the place to ask. Search first; if your question is already there, add to that thread rather than starting a new one. For confirmed bugs, open a GitHub Issue instead.