Get started

Three ways to run it. All free.

Pick the one that suits you. It is the same Adminium in each.

npx

Start a project

Creates a folder with one config file and Adminium pinned to an exact version. It asks which database to build from: the sample one, your own, or one you add later.

npx @adminiumjs/adminium new my-admin

Needs Node.js 22.14 or newer.

Always use the scoped name @adminiumjs/adminium. The unscoped npm name belongs to an unrelated project.

Quickstart

docker

Run the container

This command is for a look: it keeps its settings in one volume. For anything you intend to keep, use Docker Compose with a real meta store.

docker run --rm -p 4600:4600 \
  -e ADMINIUM_SECRET=$(openssl rand -hex 32) \
  -v adminium-data:/data \
  ghcr.io/mosofi/adminium:latest

Docker guide

desktop

Desktop app

The same Adminium in a window. No Docker, no Node, no terminal, and nothing leaves your machine.

macOS: signed and notarized, Apple silicon and Intel
Windows: installer is not code-signed yet, so SmartScreen will ask
Linux: AppImage, .deb and .rpm

Open the releases page Desktop guide

Then what?

Open it

The admin is at localhost:4600 on your machine.

Create the first super admin

There is no account with us. The first person in owns the instance.

Point it at a database

Or take the sample one and look around first.

Starting from an idea instead?

This opens the Designer and makes a project for you.

npx @adminiumjs/adminium design