# AdminJS ## AdminJS - [AdminJS](https://docs.adminjs.co/readme.md) - [Getting started](https://docs.adminjs.co/installation/getting-started.md) - [Plugins](https://docs.adminjs.co/installation/plugins.md) - [Adonis](https://docs.adminjs.co/installation/plugins/adonis.md): @adminjs/adonis - [Express](https://docs.adminjs.co/installation/plugins/express.md): @adminjs/express - [Nest](https://docs.adminjs.co/installation/plugins/nest.md): @adminjs/nestjs - [Fastify](https://docs.adminjs.co/installation/plugins/fastify.md): @adminjs/fastify - [Hapi](https://docs.adminjs.co/installation/plugins/hapi.md): @adminjs/hapi - [Koa](https://docs.adminjs.co/installation/plugins/koa.md): @adminjs/koa - [Community Plugins](https://docs.adminjs.co/installation/plugins/community-plugins.md) - [Matrix](https://docs.adminjs.co/installation/plugins/matrix.md): This plugin integrates AdminJS with Matrix, enabling users to log in to the AdminJS panel using Matrix accounts through the MatrixAuthProvider. - [Adapters](https://docs.adminjs.co/installation/adapters.md) - [TypeORM](https://docs.adminjs.co/installation/adapters/typeorm.md): @adminjs/typeorm - [Sequelize](https://docs.adminjs.co/installation/adapters/sequelize.md): @adminjs/sequelize - [Prisma](https://docs.adminjs.co/installation/adapters/prisma.md): @adminjs/prisma - [MikroORM](https://docs.adminjs.co/installation/adapters/mikroorm.md): @adminjs/mikroorm - [Objection](https://docs.adminjs.co/installation/adapters/objection.md): @adminjs/objection - [SQL](https://docs.adminjs.co/installation/adapters/sql.md): @adminjs/sql - [Mongoose](https://docs.adminjs.co/installation/adapters/mongoose.md): @adminjs/mongoose - [Community Adapters](https://docs.adminjs.co/installation/adapters/community-adapters.md) - [What's new in v7?](https://docs.adminjs.co/installation/whats-new-in-v7.md) - [Migration Guide v7](https://docs.adminjs.co/installation/migration-guide-v7.md) - [Resource](https://docs.adminjs.co/basics/resource.md): Resource is something that you can manage in AdminJS and it comes with CRUD actions (Create, Read, Update, Delete) provided out of the box. - [Action](https://docs.adminjs.co/basics/action.md): Actions are responsible for both displaying proper views and as well handling the logic behind them. - [Property](https://docs.adminjs.co/basics/property.md): Properties are AdminJS's representation of your model's fields. - [Features](https://docs.adminjs.co/basics/features.md) - [Relations](https://docs.adminjs.co/basics/features/relations.md): @adminjs/relations - [Upload](https://docs.adminjs.co/basics/features/upload.md): @adminjs/upload - [Logger](https://docs.adminjs.co/basics/features/logger.md): @adminjs/logger - [Import & Export](https://docs.adminjs.co/basics/features/import-and-export.md): @adminjs/import-export - [Password](https://docs.adminjs.co/basics/features/password.md): @adminjs/passwords - [Leaflet Maps](https://docs.adminjs.co/basics/features/leaflet-maps.md): @adminjs/leaflet - [Writing your own features](https://docs.adminjs.co/basics/features/writing-your-own-features.md) - [API](https://docs.adminjs.co/basics/api.md) - [List](https://docs.adminjs.co/basics/api/list.md): allows you to list and filer all the records for a given resource - [New](https://docs.adminjs.co/basics/api/new.md): is responsible for creating a new record in a given resource - [Search](https://docs.adminjs.co/basics/api/search.md): allows you to search records in a given resource by a query string (by default it's the title property) - [Show](https://docs.adminjs.co/basics/api/show.md): is responsible for showing the details of a record - [Edit](https://docs.adminjs.co/basics/api/edit.md): is responsible for editing record in a given resource - [Delete](https://docs.adminjs.co/basics/api/delete.md): is responsible for deleting single records - [Bulk Delete](https://docs.adminjs.co/basics/api/bulk-delete.md): is responsible for deleting multiple records - [Themes](https://docs.adminjs.co/basics/themes.md): @adminjs/themes - [Authentication](https://docs.adminjs.co/basics/authentication.md) - [FirebaseAuthProvider](https://docs.adminjs.co/basics/authentication/firebaseauthprovider.md): @adminjs/firebase-auth - [MatrixAuthProvider](https://docs.adminjs.co/basics/authentication/matrixauthprovider.md): Matrix User Authentication for the @adminjs/matrix plugin. - [How to write an addon?](https://docs.adminjs.co/how-to-write-an-addon.md) - [Writing your own Components](https://docs.adminjs.co/ui-customization/writing-your-own-components.md) - [Overwriting CSS styles](https://docs.adminjs.co/ui-customization/overwriting-css-styles.md) - [Dashboard customization](https://docs.adminjs.co/ui-customization/dashboard-customization.md) - [Changing the form view](https://docs.adminjs.co/ui-customization/changing-the-form-view.md) - [Role-Based Access Control](https://docs.adminjs.co/tutorials/adding-role-based-access-control.md) - [Internationalization (i18n)](https://docs.adminjs.co/tutorials/internationalization-i18n.md) - [Content Management System](https://docs.adminjs.co/tutorials/content-management-system.md) - [Custom components library](https://docs.adminjs.co/tutorials/custom-components-library.md): @adminjs/custom-components - [Custom component internationalization](https://docs.adminjs.co/tutorials/custom-component-internationalization.md) - [PDF Generator](https://docs.adminjs.co/faq/pdf-generator.md): For physical applications of AdminJS a pdf generator can come in handy, either for generating shipping labels or work orders. - [Charts](https://docs.adminjs.co/faq/charts.md): A simple way to implement charts with your AdminJS instance is to use Recharts library and Admin's API. - [Forgot Password](https://docs.adminjs.co/faq/resource.md): AdminJS does not currently provide an out-of-the-box solution for password recovery. You will need to implement your own way of resetting the password. - [Overview](https://docs.adminjs.co/deployment/overview.md) - [Create an Application](https://docs.adminjs.co/deployment/create-an-application.md) - [Generate API Key & Secret](https://docs.adminjs.co/deployment/generate-api-key-and-secret.md) - [Creating and Deploying the application using CLI](https://docs.adminjs.co/deployment/creating-deploying-the-application-using-cli.md) - [Editing environment variables](https://docs.adminjs.co/deployment/editing-environment-variables.md) - [Serverless](https://docs.adminjs.co/deployment/serverless.md) - [Legacy documentation](https://docs.adminjs.co/api-reference.md) --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on a page URL with the `ask` query parameter: ``` GET https://docs.adminjs.co/readme.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.