Comment on page
Koa
@adminjs/koa
$ yarn add adminjs @adminjs/koa
To setup AdminJS panel with Koa you need to have
koa installed and required peer dependencies:$ yarn add koa @koa/router koa2-formidable
Afterwards, follow one of the examples below.
Javascript
Typescript
app.js
import AdminJS from 'adminjs'
import AdminJSKoa from '@adminjs/koa'
import Koa from 'koa'
const PORT = 3000
const start = async () => {
const app = new Koa()
const admin = new AdminJS({
resources: [],
rootPath: '/admin',
})
const router = AdminJSKoa.buildRouter(admin, app)
app
.use(router.routes())
.use(router.allowedMethods())
app.listen(PORT, () => {
console.log(`AdminJS available at http://localhost:${PORT}${admin.options.rootPath}`)
})
}
start()
Install additional dependencies:
$ yarn add -D @types/koa
app.ts
import AdminJS from 'adminjs'
import AdminJSKoa from '@adminjs/koa'
import Koa from 'koa'
const PORT = 3000
const start = async () => {
const app = new Koa()
const admin = new AdminJS({
resources: [],
rootPath: '/admin',
})
const router = AdminJSKoa.buildRouter(admin, app)
app
.use(router.routes())
.use(router.allowedMethods())
app.listen(PORT, () => {
console.log(`AdminJS available at http://localhost:${PORT}${admin.options.rootPath}`)
})
}
start()
To add authentication, you must use
AdminJSKoa.buildAuthenticatedRouter instead of AdminJSKoa.buildRouter.Javascript
Typescript
app.js
import AdminJS from 'adminjs'
import AdminJSKoa from '@adminjs/koa'
import Koa from 'koa'
const PORT = 3000
const DEFAULT_ADMIN = {
email: '[email protected]',
password: 'password',
}
const authenticate = async (email, password) => {
if (email === DEFAULT_ADMIN.email && password === DEFAULT_ADMIN.password) {
return Promise.resolve(DEFAULT_ADMIN)
}
return null
}
const start = async () => {
const app = new Koa()
const admin = new AdminJS({
resources: [],
rootPath: '/admin',
})
app.keys = ['your secret for koa cookie'];
const router = AdminJSKoa.buildAuthenticatedRouter(
admin,
app,
{
authenticate,
sessionOptions: {
// You may configure your Koa session here
httpOnly: process.env.NODE_ENV === 'production',
secure: process.env.NODE_ENV === 'production',
renew: true,
},
},
)
app
.use(router.routes())
.use(router.allowedMethods())
app.listen(PORT, () => {
console.log(`AdminJS available at http://localhost:${PORT}${admin.options.rootPath}`)
})
}
start()
As you may have noticed, the
authenticate function compares credentials you submit in the form with a hardcoded DEFAULT_ADMIN object. In your case, you might want to modify authenticate function's logic to compare form credentials against real database objects.Install additional dependencies:
$ yarn add -D @types/koa
app.ts
import AdminJS from 'adminjs'
import AdminJSKoa from '@adminjs/koa'
import Koa from 'koa'
const PORT = 3000
const DEFAULT_ADMIN = {
email: '[email protected]',
password: 'password',
}
const authenticate = async (email: string, password: string) => {
if (email === DEFAULT_ADMIN.email && password === DEFAULT_ADMIN.password) {
return Promise.resolve(DEFAULT_ADMIN)
}
return null
}
const start = async () => {
const app = new Koa()
const admin = new AdminJS({
resources: [],
rootPath: '/admin',
})
app.keys = ['your secret for koa cookie'];
const router = AdminJSKoa.buildAuthenticatedRouter(
admin,
app,
{
authenticate,
sessionOptions: {
// You may configure your Koa session here
httpOnly: process.env.NODE_ENV === 'production',
secure: process.env.NODE_ENV === 'production',
renew: true,
},
},
)
app
.use(router.routes())
.use(router.allowedMethods())
app.listen(PORT, () => {
console.log(`AdminJS available at http://localhost:${PORT}${admin.options.rootPath}`)
})
}
start()
As you may have noticed, the
authenticate function compares credentials you submit in the form with a hardcoded DEFAULT_ADMIN object. In your case, you might want to modify authenticate function's logic to compare form credentials against real database objects.
Last modified 7mo ago