Skip to content

Quick Start

This page covers all the ways to get JIM up and running. Choose the option that best fits your environment.

  • For Administrators

    Deploy JIM in your environment using automated setup, Docker Compose, or air-gapped installation.

    Jump to Administrator options

  • For Developers

    Get a full development environment with GitHub Codespaces (one click) or a local devcontainer.

    Jump to Developer options

For Administrators

The setup script downloads everything you need, walks you through configuration, and starts JIM:

curl -fsSL https://tetron.io/jim/get | bash

Or download and inspect first:

curl -fsSL -o setup.sh https://tetron.io/jim/get
less setup.sh    # review the script
bash setup.sh

Option 2: Manual Setup

If you prefer to set things up manually using Docker Compose:

mkdir jim && cd jim

# Download compose files and environment template
curl -fsSL -o docker-compose.yml https://github.com/TetronIO/JIM/releases/latest/download/docker-compose.yml
curl -fsSL -o docker-compose.production.yml https://github.com/TetronIO/JIM/releases/latest/download/docker-compose.production.yml
curl -fsSL -o .env https://github.com/TetronIO/JIM/releases/latest/download/.env.example

# Configure - edit .env with your SSO settings (see SSO Setup Guide)
# Set DOCKER_REGISTRY=ghcr.io/tetronio/ and JIM_VERSION to the latest release version

# Start JIM with bundled PostgreSQL
docker compose -f docker-compose.yml -f docker-compose.production.yml --profile with-db up -d

# Or without bundled PostgreSQL (set JIM_DB_HOSTNAME in .env to your external DB)
docker compose -f docker-compose.yml -f docker-compose.production.yml up -d

SSO configuration required

Before starting JIM, you must configure your OpenID Connect identity provider settings in the .env file. See the SSO Setup Guide for step-by-step instructions.

Option 3: Air-Gapped Deployment

For environments without internet connectivity, each release includes a downloadable bundle (jim-release-X.Y.Z.tar.gz) containing:

  • Pre-built Docker images
  • Docker Compose files
  • Environment template
  • PowerShell module
  • Installation instructions

Download the bundle from the releases page on a connected machine, transfer it to your air-gapped host, and follow the included instructions.

For detailed air-gapped deployment guidance, see the Deployment Guide.

Accessing JIM

Once running, access JIM at http://localhost:5200. Log in with your identity provider, then use the Example Data feature to populate JIM with sample users and groups for testing.

For production hardening (TLS, reverse proxy, upgrades, monitoring), see the Deployment Guide.

For Developers

GitHub Codespaces (One Click)

The fastest way to get a development environment. Everything is pre-configured: .NET 10.0, PostgreSQL, Keycloak, shell aliases, and VS Code extensions.

Once the Codespace is ready, open a terminal and choose one of the following options:

jim-build-light starts PostgreSQL and Keycloak in Docker, then runs JIM.Web natively on the host. This is the fastest iteration loop; code changes rebuild and restart in seconds.

jim-build-light

Option 2: Full stack

jim-build builds and starts the entire stack in Docker: PostgreSQL, Keycloak, JIM.Web, JIM.Worker, and JIM.Scheduler. Use this when you need to exercise the worker or scheduler, or verify end-to-end behaviour in containers.

jim-build

Local Devcontainer

Clone the repository and open it in VS Code with the Dev Containers extension. The devcontainer will set up the full development environment automatically, then use either jim-build-light or jim-build as above.

No external identity provider needed

The devcontainer includes a bundled Keycloak instance with pre-configured test users, so you do not need to configure an external OpenID Connect provider to sign in.

For the full development guide, see the Developer Guide.

PowerShell Module

JIM includes a cross-platform PowerShell module for scripting, automation, and Identity as Code (IDaC). Requires PowerShell 7.0+.

Install-Module -Name JIM

Connect and Verify

Connect-JIM -Url "https://jim.example.com"    # Opens browser for SSO sign-in
Test-JIMConnection

For air-gapped or disconnected installation of the PowerShell module, see the Deployment Guide: PowerShell Module.