title: Конфигурация Admin description: Настройте свой экземпляр starlette-admin: кастомизируйте темы, маршрутизацию и общие параметры безопасности.

Admin

Все настройки уровня всего админ-панеля передаются как именованные аргументы в класс Admin: заголовок в навигационной панели, путь монтирования, конфигурация CSRF и аутентификации, а также используемая тема оформления.

Базовое использование

Начните с импорта класса Admin из пакета contrib, соответствующего вашей объектно-реляционной проекции (ORM):

from starlette_admin.contrib.sqla import Admin  # SQLAlchemy
from starlette_admin.contrib.sqlmodel import Admin  # SQLModel
from starlette_admin.contrib.beanie import Admin  # Beanie
from starlette_admin.contrib.mongoengine import Admin  # MongoEngine
from starlette_admin.contrib.tortoise import Admin  # Tortoise ORM

Вот минимальная конфигурация на основе SQLAlchemy:

from sqlalchemy import create_engine
from starlette.applications import Starlette
from starlette_admin.contrib.sqla import Admin, ModelView

from myapp.models import Post

engine = create_engine("sqlite:///admin.sqlite")
app = Starlette()

admin = Admin(
    session_provider=engine,
    title="My Admin",
    base_url="/admin",
    secret_key="a-long-random-string",
)
admin.add_view(ModelView(Post))
admin.mount_to(app)

• title задаёт текст в навигационной панели и содержимое HTML-тега <title>.
• base_url определяет префикс пути, по которому монтируется админ-панель.
• secret_key подписывает cookie для CSRF и flash-сообщений.
• add_view регистрирует представление, а mount_to формирует маршруты и middleware админ-панели перед монтированием их в ваше приложение.

Каждый класс Admin принимает все описанные ниже параметры конфигурации, а некоторые добавляют поведение, специфичное для конкретного backend:

• contrib.sqla.Admin(session_provider, ...) принимает в качестве первого позиционного аргумента Engine, AsyncEngine, sessionmaker или async_sessionmaker и автоматически добавляет DBSessionMiddleware. contrib.sqlmodel.Admin — это тот же класс, реэкспортированный повторно. Подробнее см. SQLAlchemy и SQLModel.
• contrib.beanie.Admin, contrib.mongoengine.Admin и contrib.tortoise.Admin не принимают дополнительных аргументов конструктора, поскольку Beanie, MongoEngine и Tortoise ORM управляют собственными подключениями вне админ-панели. mongoengine.Admin также регистрирует маршрут для раздачи файлов GridFS внутри mount_to. Подробнее см. Beanie, MongoEngine и Tortoise ORM.

Полный справочник

Конструктор Admin принимает все перечисленные ниже параметры в качестве именованных аргументов.

Идентичность и брендинг

logo_url, login_logo_url и favicon_url принимают либо строку, либо функцию вида (request) -> str | None. Используйте функцию, если брендинг зависит от запроса, например, в мультитенантном приложении или при обслуживании нескольких доменных имён:

def logo_for_tenant(request):
    return f"https://cdn.example.com/{request.state.tenant}/logo.png"


admin = Admin(engine, title="My Admin", logo_url=logo_for_tenant)

Монтирование

Чтобы запустить несколько экземпляров Admin в одном приложении, задайте каждому из них уникальные base_url и route_name. В противном случае ссылки, сгенерированные одной панелью, могут указывать на другую. См. Несколько экземпляров Admin.

Шаблоны, статические файлы и тема

Разделы Свои темы и Шаблоны подробно раскрывают эти параметры.

Главная страница

Главная страница по умолчанию — приветственный баннер плюс одна панель для каждого зарегистрированного представления модели с указанием количества записей. Чтобы заменить её, передайте собственный CustomView, как правило, подкласс DefaultIndexView или любой CustomView с widget. См. Свои представления и виджеты.

Аутентификация, безопасность и защита данных

Руководство Безопасность подробно описывает все пять параметров.

Локаль и часовой пояс

Полное руководство см. в разделе Интернационализация и часовые пояса.

Отладка

admin = Admin(
    session_provider=engine, title="My Admin", secret_key="a-long-random-string", debug=True
)

Отладочное логирование помогает при разработке. Для каждого запроса логируется выполненное middleware, представление, обработавшее URL, а также причина успешного или неудачного прохождения проверки прав доступа.

Для более лёгкого варианта вызовите starlette_admin.logging.configure_logging(level=logging.INFO) самостоятельно вместо передачи debug=True. Вы получите обработчик без подробностей уровня DEBUG.

Регистрация представлений и монтирование

После создания экземпляра Admin зарегистрируйте свои представления и подключите админ-панель к приложению.

admin.add_view(ModelView(Post))  # Register a view (BaseModelView, CustomView, and so on)
admin.mount_to(app)  # Mount the admin onto your Starlette or FastAPI app

Регистрация представлений

Используйте add_view, чтобы добавить компоненты на панель управления. Метод принимает как экземпляр представления, так и его класс; вы можете регистрировать представления моделей, пользовательские страницы, выпадающие меню и внешние ссылки.

Монтирование приложения

После регистрации всех представлений вызовите mount_to(app) ровно один раз, чтобы подключить админ-панель к вашему приложению на Starlette или FastAPI. На этом шаге финализируются конфигурация маршрутизации и безопасности.

admin.app  # Raises RuntimeError: not mounted yet

admin.mount_to(app)
admin.app  # Returns the mounted sub-application

admin.add_view(ModelView(Comment))  # Raises RuntimeError: already mounted

Что дальше

• Безопасность: параметр secret_key, CSRF и ограничения на экспорт и импорт.
• Аутентификация: подключение auth_provider.
• Несколько экземпляров Admin: запуск более одного Admin в одном приложении.