The easiest installation method is Docker. Docker runs 9Router in a container, so you do not need to install Node.js, npm, or the application dependencies manually.

1. Install Docker

Install Docker Desktop on Windows or macOS, or install Docker Engine and Docker Compose on Linux:

After installation, open a terminal and check that Docker is available:

docker --version
docker compose version

Both commands should print a version number.

2. Download the project

Clone this repository, then enter its folder:

git clone https://github.com/mhiqrambg/9router-mibp-version.git
cd 9router-mibp-version

If Git is not installed, download the repository as a ZIP file from GitHub and open the extracted folder in a terminal.

3. Create the environment file

Create .env from the example file:

cp .env.example .env

Open .env in a text editor and change at least these values:

JWT_SECRET=replace-with-a-long-random-secret
INITIAL_PASSWORD=replace-with-your-dashboard-password
API_KEY_SECRET=replace-with-another-long-random-secret
MACHINE_ID_SALT=replace-with-another-random-secret
REQUIRE_API_KEY=true

Do not share .env or commit it to Git. It contains the dashboard password and security secrets. On Linux or macOS, you can generate random values with:

openssl rand -hex 32

Use a different generated value for each secret.

4. Start 9Router

Run this command in the project folder:

docker compose up -d

The first run downloads the 9Router and Headroom images. The -d option keeps them running in the background.

Check the containers:

docker compose ps

Both 9router and headroom should have a running status.

5. Open the dashboard

Open this address in your browser:

http://localhost:20128/dashboard

6. Create an API key

In the dashboard, open Endpoint & Key and create a key. Keep the complete key that starts with sk-.

Use it when calling the API:

curl http://localhost:20128/v1/models \
  -H "Authorization: Bearer YOUR_API_KEY"

For a server exposed through a domain, replace the URL with your domain:

curl https://your-domain.example/v1/models \
  -H "Authorization: Bearer YOUR_API_KEY"

Remote requests without a valid API key are rejected. The API key is stored in the application database, not in .env.

Useful Docker commands

View live logs:

docker compose logs -f 9router

Restart the application:

docker compose restart 9router

Stop the services without deleting data:

docker compose down

Update to the latest image:

docker compose pull
docker compose up -d

The Docker volume named 9router-data keeps your settings, providers, and API keys when the container is recreated.

Install from source

This option is intended for development. Install Node.js 22 or newer, then run:

cp .env.example .env
npm install
PORT=20128 NEXT_PUBLIC_BASE_URL=http://localhost:20128 npm run dev

Open http://localhost:20128/dashboard after the development server starts.

Update

This fork follows decolua/9router through the upstream remote.

git fetch upstream
git checkout master
git merge upstream/master
git push origin master

To build and publish this fork's Docker image after updating the source:

git tag v1.0.0
git push origin v1.0.0

The GitHub Actions workflow builds and publishes:

mhiqrambhrng/9router-mibp-version

On the server, update the running container with:

docker compose pull 9router
docker compose up -d

Forks (9Router)

License

MIT License. See LICENSE for details.