Self-Hosting
Self-Hosting Deployment Guide
Deploy the InSitu server, database, and telemetry broker on your own infrastructure using Docker Compose.
For teams with strict compliance mandates or isolated VPC requirements, you can self-host the entire InSitu architecture (Dashboard UI, Telemetry Broker, Database, and Traefik reverse proxy) on a single Linux VM.
🖥️ System Requirements
Ensure your host VM meets these minimum hardware profiles:
Resource
Recommended Minimum
Operating System
Ubuntu 22.04 LTS or 24.04 LTS
CPU
4 vCPU
RAM
16 GB
Storage
50 GB SSD
Docker
Docker v26+ and Docker Compose v2+
🛠️ Step-by-Step Installation
1
Verify Docker Engine
Verify that your VM is running the latest Docker Engine:
docker
-v
If Docker is not yet installed or is below version 25, run the official utility script to bootstrap it:
curl
-fsSL
https://get.docker.com
-o
get-docker.sh
&&
sudo
sh
get-docker.sh
2
Download the Deployment Package
Create a secure home directory and fetch the official InSitu starter bundle:
sudo
mkdir
-p
/opt/InSitu
cd
/opt/InSitu
sudo
curl
-O
https://InSitu-assets.s3.ap-south-1.amazonaws.com/static/InSitu.tar.xz
sudo
tar
-xf
InSitu.tar.xz
3
Configure Environment Variables (.env)
Inside the extracted bundle, open the
.env
file and customize the port bindings and versions. Ensure these ports are open on your VM’s firewall/security group rules:
HOST_BACKEND_PORT_TRAEFIK
- The port used by developers to access the InSitu web dashboard.
HOST_LOGGER_PORT_TRAEFIK
- The secure port that connected SDK agents will use to transmit dynamic log, counter, and snapshot payloads.
HOST_CONSUL_HTTP_PORT_TRAEFIK
- Internal registry port.
HYPERTEST_VERSION
- The platform version tag to pull. Set this to the latest
@InSitu/node-sdk
tag shown below. Platform and Node SDK always share the same the release tag value.
4
AWS ECR Public Authentication (Optional: only if you get this error continuously)
To avoid hitting pull rate limits (
toomanyrequests: Rate exceeded
) when pulling images from
public.ecr.aws
, authenticate Docker with AWS ECR before running Docker Compose.
Note:
Authentication with AWS ECR Public requires
--region us-east-1
regardless of your default AWS region setup.
aws
ecr-public
get-login-password
--region
us-east-1
|
docker
login
--username
AWS
--password-stdin
public.ecr.aws
5
Boot the Platform Stack
Run Docker Compose in detached mode to download and launch the services:
Complete aws login for better
sudo
docker
compose
up
-d
6
Sign In & License
Navigate your browser to:
http://<your-vm-ip-or-domain>:<HOST_BACKEND_PORT_TRAEFIK>
Sign in, create your primary admin account, and enter your license key to activate the workspace!
7
Create a team
Go to teams page from left navigation menu.
Click
Create Team
and enter the required details to set up a non-admin team.
Note: Only non-admin teams can be associated with services.
Create a service under your non-admin team.
Integrate the InSitu SDK automatically by clicking
Integration using AI agent
or select your programming language from options below to follow steps and set up manually.
Node.js SDK Setup Guide
Java Agent Setup Guide
Python SDK Setup Guide
Ruby SDK Setup Guide
Troubleshooting Glossary & FAQ
Previous
⌘
I
Powered by
This documentation is built and hosted on Mintlify, a developer documentation platform
Terms of Service
On this page
Back to top
🖥️ System Requirements
🛠️ Step-by-Step Installation