01. Installation instructions

Installation of an AdminBro consist of 2 steps.

01. Install the fremework plugin

Since AdminBro uses your existing framework to render its routes - you have to use one of our plugins.

There are plugins for:

In this tutorial I will present the simplest way of adding AdminBro to those frameworks. If you want to know more - visit their corresponding pages (above).


Install the AdminBro along with the express plugin

npm install admin-bro admin-bro-expressjs

Create an express router which will handle all AdminBro routes

const AdminBro = require('admin-bro')
const AdminBroExpress = require('admin-bro-expressjs')

const express = require('express')
const app = express()

const adminBro = new AdminBro({
  databases: [],
  rootPath: '/admin',

const router = AdminBroExpress.buildRouter(adminBro)

Use this router in expres.js app

app.use(adminBro.options.rootPath, router)
app.listen(8080, () => console.log('AdminBro is under localhost:8080/admin'))

To see how to add authentication or other modifications - visit the Express Plugin documentation.


If you use Hapi framework instead of express - follow this installation instructions:

npm install admin-bro-hapijs boom inert

Register plugin and start server

const AdminBroPlugin = require('admin-bro-hapijs')
const Hapi = require('hapi')

const adminBroOptions = {
  resources: [],
  rootPath: '/admin',

const server = Hapi.server({ port: process.env.PORT || 8080 })
const start = async () => {
  await server.register({
    plugin: AdminBroPlugin,
    options: adminBroOptions,

  await server.start()


To see how to add authentication or other modifications - visit the Hapi Plugin documentation.

02. Install the Database Adapter and add resources

AdminBro can be connected to many different types of resources. Right now we support mongoose ODM and sequelize ORM.

To add resources to AdminBro you first have to register an adapter for the resource type you will be using.

Example for a mongoose setup:


npm install admin-bro-mongoose

Register adapter

const AdminBro = require('admin-bro')
const AdminBroMongoose = require('admin-bro-mongoose')


Pass resources to AdminBro like this (express example)

const User = mongoose.model('User', { name: String, email: String, surname: String })
const AdminBroOptions = {
  resources: [User],
const AdminBro = new AdminBro(AdminBroOptions)
const router = AdminBroExpress.buildRouter(adminBro)
// and add router to express

What's next?