Spec-Zone.ru › Wagtail 2

Настройки

Wagtail использует следующие настройки помимо базовых настроек Django:

Имя сайта

WAGTAIL_SITE_NAME

WAGTAIL_SITE_NAME = 'Stark Industries Skunkworks'

Это удобочитаемое имя вашей установки Wagtail, которое приветствует пользователей при входе в админку Wagtail.

Добавить слеш

WAGTAIL_APPEND_SLASH

# Don't add a trailing slash to Wagtail-served URLs
WAGTAIL_APPEND_SLASH = False

Аналогично настройке APPEND_SLASH, эта настройка определяет, как Wagtail будет обрабатывать запросы, не заканчивающиеся слешем.

Когда WAGTAIL_APPEND_SLASH установлено в True (по умолчанию), запросы к страницам Wagtail, опускающие конечный слеш, будут перенаправлены Django’s CommonMiddleware на URL со слешем.

Когда WAGTAIL_APPEND_SLASH установлено в False, запросы к страницам Wagtail будут обрабатываться как со слешем, так и без него. Однако ссылки на страницы, сгенерированные Wagtail, не будут содержать конечных слешей.

Примечание

Если вы используете настройку False, имейте в виду, что обслуживание страниц как со слешем, так и без него может повлиять на способность поисковых систем индексировать ваш сайт. Подробнее см. этот пост в блоге Google Search Central.

Поиск

WAGTAILSEARCH_BACKENDS

WAGTAILSEARCH_BACKENDS = {
    'default': {
        'BACKEND': 'wagtail.search.backends.elasticsearch5',
        'INDEX': 'myapp'
    }
}

Определите бэкенд поиска. Полное объяснение см. в разделе бэкэндов.

WAGTAILSEARCH_HITS_MAX_AGE

WAGTAILSEARCH_HITS_MAX_AGE = 14

Установите количество дней (по умолчанию 7), в течение которых сохраняются журналы запросов поиска; они используются для определения популярных поисковых запросов для результатов поиска с выделением. Запросы, старше этого срока, будут удалены командой search_garbage_collect.

Локализация

Wagtail поддерживает локализацию контента, поддерживая отдельные деревья страниц для каждого языка.

Руководство по включению локализации на вашем сайте см. в руководстве по настройке.

WAGTAIL_I18N_ENABLED

(boolean, default False)

При установке в True, будут включены функции локализации Wagtail:

WAGTAIL_I18N_ENABLED = True

WAGTAIL_CONTENT_LANGUAGES

(список, по умолчанию [])

Список языков и/или языковых локалей, на которых можно создавать контент Wagtail.

Например:

WAGTAIL_CONTENT_LANGUAGES = [
    ('en', _("English")),
    ('fr', _("French")),
]

Каждый элемент в списке представляет собой пару из кода языка и его отображаемого имени. Код языка может быть кодом языка (например, en, fr) или включать код региона (например, en-gb, fr-fr). Вы можете смешивать оба формата, если вам нужно локализовать только в некоторых регионах, а не во всех.

Эта настройка следует той же структуре, что и настройка Django LANGUAGES, поэтому их можно установить одинаково:

LANGUAGES = WAGTAIL_CONTENT_LANGUAGES = [
    ('en-gb', _("English (United Kingdom)")),
    ('en-us', _("English (United States)")),
    ('es-es', _("Spanish (Spain)")),
    ('es-mx', _("Spanish (Mexico)")),
]

Однако разделение позволяет настроить множество различных регионов на вашем сайте и сохранить общий контент Wagtail (но отложить такие вещи, как форматирование дат, валюты и т. д.):

LANGUAGES = [
    ('en', _("English (United Kingdom)")),
    ('en-us', _("English (United States)")),
    ('es', _("Spanish (Spain)")),
    ('es-mx', _("Spanish (Mexico)")),
]


WAGTAIL_CONTENT_LANGUAGES = [
    ('en', _("English")),
    ('es', _("Spanish")),
]

Это означает, что ваш сайт будет отвечать на https://www.mysite.com/es/ и https://www.mysite.com/es-MX/ URL-адресы, но оба будут отображать контент из одного «испанского» дерева в Wagtail.

Примечание

WAGTAIL_CONTENT_LANGUAGES должен быть подмножеством LANGUAGES

Обратите внимание, что все языки, присутствующие в WAGTAIL_CONTENT_LANGUAGES, должны также присутствовать в вашей настройке LANGUAGES. Это необходимо для того, чтобы Wagtail мог генерировать активные URL-адреса этих страниц из непереведенного контекста (например, интерфейса администрирования).

Встраиваемые элементы

Wagtail поддерживает генерацию кода встраивания из URL-адресов контента на сторонних ресурсах, таких как Youtube или Twitter. По умолчанию Wagtail будет извлекать код встраивания напрямую со соответствующего сайта поставщика с использованием протокола oEmbed. Wagtail имеет встроенный список наиболее распространённых поставщиков.

Загрузку встраиваемых элементов можно полностью настроить, используя настройку WAGTAILEMBEDS_FINDERS. Более подробная информация представлена в разделе настройки поисковиков встраивания.

WAGTAILEMBEDS_RESPONSIVE_HTML

WAGTAILEMBEDS_RESPONSIVE_HTML = True

Добавляет class="responsive-object" и внутренний стиль padding-bottom для встраиваемых элементов, чтобы помочь сделать их адаптивными. Подробнее см. раздел адаптивных встраиваемых элементов.

Панель мониторинга

WAGTAILADMIN_RECENT_EDITS_LIMIT

WAGTAILADMIN_RECENT_EDITS_LIMIT = 5

Эта настройка позволяет изменить количество элементов, отображаемых в разделе «Ваши последние правки» на панели мониторинга.

WAGTAILADMIN_USER_LOGIN_FORM

WAGTAILADMIN_USER_LOGIN_FORM = 'users.forms.LoginForm'

Разрешает расширить стандартную форму входа в систему LoginForm дополнительными полями.

WAGTAIL_GRAVATAR_PROVIDER_URL

WAGTAIL_GRAVATAR_PROVIDER_URL = '//www.gravatar.com/avatar'

Если пользователь не загрузил фотографию профиля, Wagtail будет искать аватар, связанный с его адресом электронной почты на gravatar.com. Эта настройка позволяет указать альтернативного поставщика, например, robohash.org, или установить значение None, чтобы полностью отключить использование удалённых аватаров.

WAGTAIL_MODERATION_ENABLED

WAGTAIL_MODERATION_ENABLED = True

Изменяет отображение кнопки «Отправить на модерацию» в меню действий.

WAGTAIL_SLIM_SIDEBAR

WAGTAIL_SLIM_SIDEBAR = False

Отключает упрощённую боковую панель Wagtail, чтобы использовать вместо неё классическую боковую панель. Классическая боковая панель и данная настройка будут удалены в Wagtail 2.18.

Комментарии

Новое в версии 2.13.

WAGTAILADMIN_COMMENTS_ENABLED

# Disable commenting
WAGTAILADMIN_COMMENTS_ENABLED = False

Определяет, включены ли комментарии для страниц (True по умолчанию).

Изображения

WAGTAILIMAGES_IMAGE_MODEL

WAGTAILIMAGES_IMAGE_MODEL = 'myapp.MyImage'

Эта настройка позволяет предоставить собственную модель изображений для использования в Wagtail, которая должна расширять встроенный класс AbstractImage.

WAGTAILIMAGES_IMAGE_FORM_BASE

WAGTAILIMAGES_IMAGE_FORM_BASE = 'myapp.forms.MyImageBaseForm'

Эта настройка позволяет предоставить собственную базовую форму для изображений для использования в Wagtail, которая может расширять или полностью заменять встроенный класс BaseImageForm. Вы можете использовать её для указания или переопределения виджетов, используемых в форме администратора.

WAGTAILIMAGES_MAX_UPLOAD_SIZE

WAGTAILIMAGES_MAX_UPLOAD_SIZE = 20 * 1024 * 1024  # i.e. 20MB

Эта настройка позволяет переопределить максимальный размер загружаемых изображений (в байтах). Если не указано иное, Wagtail будет использовать значение по умолчанию в 10 МБ.

WAGTAILIMAGES_MAX_IMAGE_PIXELS

WAGTAILIMAGES_MAX_IMAGE_PIXELS = 128000000  # i.e. 128 megapixels

Эта настройка позволяет переопределить максимальное количество пикселей изображения. Если не указано иное, Wagtail будет использовать значение по умолчанию в 128 мегапикселей. Подсчёт пикселей учитывает кадры анимации – например, 25-кадровая анимация размером 100x100 считается имеющей 100 * 100 * 25 = 250000 пикселей.

WAGTAILIMAGES_FEATURE_DETECTION_ENABLED

WAGTAILIMAGES_FEATURE_DETECTION_ENABLED = True

Эта настройка включает обнаружение функций после установки OpenCV, все подробности см. в документации по обнаружению функций изображений.

WAGTAILIMAGES_INDEX_PAGE_SIZE

WAGTAILIMAGES_INDEX_PAGE_SIZE = 20

Указывает количество изображений на странице, отображаемых на главной странице списка изображений в админке Wagtail.

WAGTAILIMAGES_USAGE_PAGE_SIZE

WAGTAILIMAGES_USAGE_PAGE_SIZE = 20

Указывает количество элементов на странице при просмотре использования изображения (см. WAGTAIL_USAGE_COUNT_ENABLED).

WAGTAILIMAGES_CHOOSER_PAGE_SIZE

WAGTAILIMAGES_CHOOSER_PAGE_SIZE = 12

Указывает количество изображений, отображаемых на странице в модальном окне выбора изображений.

Документы

WAGTAILDOCS_DOCUMENT_MODEL

WAGTAILDOCS_DOCUMENT_MODEL = 'myapp.MyDocument'

Эта настройка позволяет предоставить собственную модель документов для использования в Wagtail, которая должна расширять встроенный класс AbstractDocument.

WAGTAILDOCS_DOCUMENT_FORM_BASE

WAGTAILDOCS_DOCUMENT_FORM_BASE = 'myapp.forms.MyDocumentBaseForm'

Эта настройка позволяет предоставить собственную базвую форму для документов для использования в Wagtail, которая может расширять или полностью заменять встроенный класс BaseDocumentForm . Вы можете использовать её для указания или переопределения виджетов, используемых в форме администратора.

WAGTAILDOCS_SERVE_METHOD

WAGTAILDOCS_SERVE_METHOD = 'redirect'

Определяет, как будут связаны и предоставлены загрузки документов. Обычно запросы на загрузку документов отправляются через представление Django, для проверки конфиденциальности (см. Настройки конфиденциальности) и выполнения других задач, таких как подсчёт посещений. Для полной защиты от обхода этой проверки это должно происходить в том же запросе, где документ выдаётся; однако это влечёт за собой потерю производительности, так как документ затем должен быть предоставлен сервером Django. В частности, это отменяет большую часть преимуществ размещения документов на внешних хранилищах, таких как S3 или CDN.

По этой причине Wagtail предоставляет ряд методов предоставления, которые жертвуют строгостью проверки разрешений ради производительности:

  • 'direct' - ссылки на документы напрямую указывают на URL, предоставленный основным хранилищем, минуя представление Django, которое проверяет разрешения. Это наиболее полезно при развертывании сайтов в виде полностью статического HTML (например, с использованием wagtail-bakery или Gatsby).
  • 'redirect' - ссылки на документы указывают на представление Django, которое проверит разрешения пользователя; в случае успеха оно перенаправит на URL, предоставленный основным хранилищем, чтобы позволить загрузить документ. Это наиболее подходит для удаленных хранилищ, таких как S3, поскольку позволяет документу обслуживаться независимо от сервера Django. Обратите внимание, что если пользователь может угадать последний URL, он сможет обойти проверку разрешений; некоторые хранилища могут предоставить параметры конфигурации для генерации случайного или временного URL, чтобы смягчить это.
  • 'serve_view' - ссылки на документы указывают на представление Django, которое проверяет разрешения пользователя и обслуживает документ. Обслуживание будет выполняться с помощью django-sendfile, если оно установлено и поддерживается конфигурацией вашего сервера, или в качестве потокового ответа от Django, если нет. При использовании этого метода рекомендуется настроить ваш веб-сервер на запрещение непосредственного предоставления документов из их расположения в MEDIA_ROOT, поскольку это предоставит способ обхода проверки разрешений.

Если WAGTAILDOCS_SERVE_METHOD не указано или установлено в None, по умолчанию используется метод 'redirect', когда используется удаленное хранилище (т. е. такое, которое раскрывает URL, но не локальный путь к файловой системе), и 'serve_view' в противном случае. Наконец, некоторые хранилища могут вообще не раскрывать URL; в этом случае обслуживание будет продолжено, как для 'serve_view'.

WAGTAILDOCS_CONTENT_TYPES

WAGTAILDOCS_CONTENT_TYPES = {
    'pdf': 'application/pdf',
    'txt': 'text/plain',
}

Указывает тип MIME-контента, который будет возвращен для данного расширения файла при использовании метода serve_view. Типы контента, не указанные здесь, будут угаданы с помощью функции Python mimetypes.guess_type, или application/octet-stream, если неуспешно.

WAGTAILDOCS_INLINE_CONTENT_TYPES

WAGTAILDOCS_INLINE_CONTENT_TYPES = ['application/pdf', 'text/plain']

Список MIME-типов контента, которые будут отображаться в браузере встроеным образом (путем предоставления HTTP-заголовка Content-Disposition: inline) вместо загрузки при использовании метода serve_view. По умолчанию application/pdf.

WAGTAILDOCS_EXTENSIONS

WAGTAILDOCS_EXTENSIONS = ['pdf', 'docx']

Список разрешенных расширений документов, которые будут проверены при загрузке документа. Если это не указано, все расширения документов разрешены. Предупреждение: это не всегда гарантирует, что загруженный файл действителен, так как файлы могут быть переименованы, чтобы иметь расширение, независимо от того, какие данные они содержат.

Управление паролями

WAGTAIL_PASSWORD_MANAGEMENT_ENABLED

WAGTAIL_PASSWORD_MANAGEMENT_ENABLED = True

Указывает, разрешено ли пользователям менять свои пароли (по умолчанию разрешено).

WAGTAIL_PASSWORD_RESET_ENABLED

WAGTAIL_PASSWORD_RESET_ENABLED = True

Указывает, разрешено ли пользователям сбросить свои пароли. По умолчанию совпадает с WAGTAIL_PASSWORD_MANAGEMENT_ENABLED. Почтовые уведомления о сбросе пароля будут отправляться с адреса, указанного в настройке Django DEFAULT_FROM_EMAIL.

WAGTAILUSERS_PASSWORD_ENABLED

WAGTAILUSERS_PASSWORD_ENABLED = True

Указывает, отображаются ли поля пароля при создании или редактировании пользователей через Настройки -> Пользователи (по умолчанию отображаются). Установите это значение в False (наряду с WAGTAIL_PASSWORD_MANAGEMENT_ENABLED и WAGTAIL_PASSWORD_RESET_ENABLED ), если ваши пользователи авторизуются через внешнюю систему, такую как LDAP.

WAGTAILUSERS_PASSWORD_REQUIRED

WAGTAILUSERS_PASSWORD_REQUIRED = True

Указывает, является ли пароль обязательным полем при создании нового пользователя. По умолчанию True; игнорируется, если WAGTAILUSERS_PASSWORD_ENABLED равно false. Если это значение установлено в False, и поле пароля оставлено пустым при создании пользователя, у этого пользователя не будет работоспособного пароля; для входа в систему ему нужно будет сбросить пароль (если WAGTAIL_PASSWORD_RESET_ENABLED равно True) или использовать альтернативную систему аутентификации, такую как LDAP (если она настроена).

WAGTAIL_EMAIL_MANAGEMENT_ENABLED

WAGTAIL_EMAIL_MANAGEMENT_ENABLED = True

Указывает, разрешено ли пользователям изменять свой адрес электронной почты (по умолчанию разрешено).

Уведомления по электронной почте

WAGTAILADMIN_NOTIFICATION_FROM_EMAIL

WAGTAILADMIN_NOTIFICATION_FROM_EMAIL = 'wagtail@myhost.io'

Wagtail отправляет уведомления по электронной почте, когда контент отправляется на модерацию и когда контент принимается или отклоняется. Эта настройка позволяет выбрать адрес электронной почты, с которого будут приходить эти автоматические уведомления. Если это не указано, Wagtail будет использовать настройку Django DEFAULT_FROM_EMAIL.

WAGTAILADMIN_NOTIFICATION_USE_HTML

WAGTAILADMIN_NOTIFICATION_USE_HTML = True

Уведомления по электронной почте отправляются в формате text/plain по умолчанию, измените это для использования форматирования HTML.

WAGTAILADMIN_NOTIFICATION_INCLUDE_SUPERUSERS

WAGTAILADMIN_NOTIFICATION_INCLUDE_SUPERUSERS = False

По умолчанию уведомления по электронной почте отправляются модераторам и суперпользователям. Вы можете изменить это, чтобы исключить суперпользователей и уведомлять только модераторов.

Уведомления о обновлениях Wagtail

WAGTAIL_ENABLE_UPDATE_CHECK

WAGTAIL_ENABLE_UPDATE_CHECK = True

Только для администраторов, Wagtail выполняет проверку на панели мониторинга, чтобы определить, доступны ли новые версии. Это также предоставляет команде Wagtail имя хоста вашего сайта Wagtail. Если вы предпочитаете не получать уведомления о обновлениях или хотите, чтобы ваш сайт оставался неизвестным, вы можете отключить их с помощью этой настройки.

Закрытые страницы/документы

PASSWORD_REQUIRED_TEMPLATE

PASSWORD_REQUIRED_TEMPLATE = 'myapp/password_required.html'

Это путь к шаблону Django, который будет использоваться для отображения формы «требуется пароль», когда пользователь получает доступ к закрытой странице. Подробнее см. документацию Закрытые страницы.

DOCUMENT_PASSWORD_REQUIRED_TEMPLATE

DOCUMENT_PASSWORD_REQUIRED_TEMPLATE = 'myapp/document_password_required.html'

Как выше, но для ограничений паролем на документы. Подробнее см. документацию Закрытые страницы.

Страница входа

WAGTAIL_FRONTEND_LOGIN_TEMPLATE

Основная страница входа может быть настроена с помощью пользовательского шаблона.

WAGTAIL_FRONTEND_LOGIN_TEMPLATE = 'myapp/login.html'

WAGTAIL_FRONTEND_LOGIN_URL

Или страница входа может быть перенаправлением на внешний или внутренний URL.

WAGTAIL_FRONTEND_LOGIN_URL = '/accounts/login/'

Подробнее см. документацию Настройка страницы входа.

Разрешение регистра в тегах

TAGGIT_CASE_INSENSITIVE

TAGGIT_CASE_INSENSITIVE = True

По умолчанию теги регистрозависимы («музыка» и «Музыка» обрабатываются как отдельные теги). Во многих случаях предпочтительнее обратное поведение.

Теги из нескольких слов

TAG_SPACES_ALLOWED

TAG_SPACES_ALLOWED = False

Теги могут состоять только из одного слова, пробелы не допускаются. Значение по умолчанию True (пробелы в тегах разрешены).

Предел количества тегов

TAG_LIMIT

TAG_LIMIT = 5

Ограничение количества тегов, которые можно добавить к модели тегов (django-taggit). Значение по умолчанию None, что означает отсутствие ограничения на теги.

Unicode-адреса страниц

WAGTAIL_ALLOW_UNICODE_SLUGS

WAGTAIL_ALLOW_UNICODE_SLUGS = True

По умолчанию адреса страниц могут содержать любые буквенно-цифровые символы, включая нелатинские алфавиты. Установите это значение в False, чтобы ограничить адреса символами ASCII.

Автоматическое обновление предварительного просмотра

WAGTAIL_AUTO_UPDATE_PREVIEW

WAGTAIL_AUTO_UPDATE_PREVIEW = False

При включении данные из отредактированной страницы автоматически отправляются на сервер при каждом изменении, даже без сохранения. Таким образом, пользователям не нужно нажимать «Предварительный просмотр», чтобы обновить содержимое страницы предварительного просмотра. Однако вкладка предварительного просмотра не обновляется автоматически; пользователи должны сделать это вручную. По умолчанию это поведение отключено.

Настраиваемые формы редактирования пользователей

См. Настраиваемые модели пользователей.

WAGTAIL_USER_EDIT_FORM

WAGTAIL_USER_EDIT_FORM = 'users.forms.CustomUserEditForm'

Разрешает переопределение стандартного класса UserEditForm с помощью настраиваемой формы, когда используется настраиваемая модель пользователя и требуется дополнительные поля в форме редактирования пользователя.

WAGTAIL_USER_CREATION_FORM

WAGTAIL_USER_CREATION_FORM = 'users.forms.CustomUserCreationForm'

Разрешает переопределение стандартного класса UserCreationForm с помощью настраиваемой формы, когда используется настраиваемая модель пользователя и требуется дополнительные поля в форме создания пользователя.

WAGTAIL_USER_CUSTOM_FIELDS

WAGTAIL_USER_CUSTOM_FIELDS = ['country']

Список дополнительных пользовательских полей, которые необходимо добавить к стандартному списку.

Использование изображений, документов и сниппетов

WAGTAIL_USAGE_COUNT_ENABLED

WAGTAIL_USAGE_COUNT_ENABLED = True

При включении Wagtail отображает, где конкретное изображение, документ или сниппет используется на вашем сайте. Это отключено по умолчанию, так как генерирует запрос, который может выполняться медленно на сайтах с большим количеством страниц.

На странице редактирования (в правом столбце) появится ссылка, показывающая, сколько раз элемент используется. Переход по этой ссылке перенаправляет вас на страницу «Использование», на которой отображается, где сниппет, документ или изображение используются.

Ссылка также отображается на странице удаления над кнопкой «Удалить».

Примечание

Подсчет использования применяется только к прямым (базовым данным) ссылкам. Использование документов, изображений и сниппетов в StreamFields или полях rich text не учитывается.

Ввод дат и дат и времени

WAGTAIL_DATE_FORMAT, WAGTAIL_DATETIME_FORMAT, WAGTAIL_TIME_FORMAT

WAGTAIL_DATE_FORMAT = '%d.%m.%Y.'
WAGTAIL_DATETIME_FORMAT = '%d.%m.%Y. %H:%M'
WAGTAIL_TIME_FORMAT = '%H:%M'

Указывает формат даты, времени и даты и времени, который будет использоваться в полях ввода в панели администрирования Wagtail. Формат задается в синтаксисе модуля Python datetime и должен соответствовать одному из распознаваемых форматов, указанных в настройках DATE_INPUT_FORMATS, TIME_INPUT_FORMATS, или DATETIME_INPUT_FORMATS соответственно (см. DATE_INPUT_FORMATS).

Временные зоны

Авторизованные пользователи могут выбрать свою текущую временную зону для интерфейса администрирования в настройках учетной записи. Если пользователь не выбрал временную зону, будет использоваться TIME_ZONE. (Обратите внимание, что временные зоны применяются только к полям даты и времени, а не к полям просто времени или даты. Это решение Django.)

WAGTAIL_USER_TIME_ZONES

Список временных зон по умолчанию — список common_timezones из pytz. Его можно переопределить через настройку WAGTAIL_USER_TIME_ZONES. Если разрешена ноль или одна временная зона, форма настроек учетной записи будет скрыта.

WAGTAIL_USER_TIME_ZONES = ['America/Chicago', 'Australia/Sydney', 'Europe/Rome']

Языки администрирования

Пользователи могут выбрать несколько языков для интерфейса администрирования в настройках учетной записи. Список языков по умолчанию — все доступные языки Wagtail с покрытием не менее 90%. Чтобы изменить его, установите WAGTAILADMIN_PERMITTED_LANGUAGES.

WAGTAILADMIN_PERMITTED_LANGUAGES

WAGTAILADMIN_PERMITTED_LANGUAGES = [('en', 'English'),
                                    ('pt', 'Portuguese')]

Поскольку синтаксис такой же, как в Django LANGUAGES, вы можете сделать так, чтобы пользователи могли выбирать только языки переднего плана:

LANGUAGES = WAGTAILADMIN_PERMITTED_LANGUAGES = [('en', 'English'),
                                                ('pt', 'Portuguese')]

Статические файлы

WAGTAILADMIN_STATIC_FILE_VERSION_STRINGS

WAGTAILADMIN_STATIC_FILE_VERSION_STRINGS = False

URL статических файлов в администрировании Wagtail снабжены специфической для версии строкой запроса вида ?v=1a2b3c4d, чтобы предотвратить сохранение устаревших кэшированных копий файлов JavaScript и CSS после обновления Wagtail. Чтобы отключить это, установите WAGTAILADMIN_STATIC_FILE_VERSION_STRINGS в значение False.

Настройки API

Полную документацию по настройке API, включая эти настройки, см. в документации Руководства по настройке Wagtail API v2.

WAGTAILAPI_BASE_URL

WAGTAILAPI_BASE_URL = 'http://api.example.com/'

Необходим при использовании отмены кэширования на стороне клиента, используется для генерации абсолютных URL-адресов к файлам документации и отмены кэша.

WAGTAILAPI_LIMIT_MAX

WAGTAILAPI_LIMIT_MAX = 500

По умолчанию 20, используется для изменения максимального количества результатов, которые пользователь может запросить за раз, установлено в None для снятия ограничений.

WAGTAILAPI_SEARCH_ENABLED

WAGTAILAPI_SEARCH_ENABLED = False

По умолчанию истинно, установление в ложь отключит полнотекстовый поиск на всех конечных точках.

WAGTAILAPI_USE_FRONTENDCACHE

WAGTAILAPI_USE_FRONTENDCACHE = True

Требует установки приложения wagtailfrontendcache, указывает, что API должен использовать кэш на стороне клиента.

Кэш на стороне клиента

Полную документацию по отмене кэша на стороне клиента, включая эти настройки, см. в Инвалидатор кэша на стороне клиента.

WAGTAILFRONTENDCACHE

WAGTAILFRONTENDCACHE = {
    'varnish': {
        'BACKEND': 'wagtail.contrib.frontend_cache.backends.HTTPBackend',
        'LOCATION': 'http://localhost:8000',
    },
}

См. документацию по полному списку доступных опций.

Примечание

WAGTAILFRONTENDCACHE_LOCATION больше не является предпочтительным способом задания местоположения кэша, вместо этого установите LOCATION в элементе WAGTAILFRONTENDCACHE.

WAGTAILFRONTENDCACHE_LANGUAGES

WAGTAILFRONTENDCACHE_LANGUAGES = [l[0] for l in settings.LANGUAGES]

По умолчанию пустой список, должен содержать список языков, для которых также нужно очистить URL-адреса при очистке URL-адреса. Эта настройка требует, чтобы settings.USE_I18N было True для работы.

Редакторы с богатым текстом

WAGTAILADMIN_RICH_TEXT_EDITORS

WAGTAILADMIN_RICH_TEXT_EDITORS = {
    'default': {
        'WIDGET': 'wagtail.admin.rich_text.DraftailRichTextArea',
        'OPTIONS': {
            'features': ['h2', 'bold', 'italic', 'link', 'document-link']
        }
    },
    'legacy': {
        'WIDGET': 'wagtail.admin.rich_text.HalloRichTextArea',
    }
}

Настройка поведения полей с богатым текстом. По умолчанию RichTextField и RichTextBlock используют конфигурацию, заданную в ключе 'default', но ее можно переопределить для каждого поля с помощью ключевого слова editor, например, body = RichTextField(editor='legacy'). В каждом блоке конфигурации распознаются следующие поля:

  • WIDGET: Реализация виджета с богатым текстом для использования. Wagtail предоставляет две реализации: wagtail.admin.rich_text.DraftailRichTextArea (современный расширяемый редактор, который поддерживает хорошо структурированный разметку) и wagtail.admin.rich_text.HalloRichTextArea (устарел; работает непосредственно на уровне HTML). Другие виджеты могут предоставляться сторонними пакетами.
  • OPTIONS: Параметры конфигурации для передачи виджету. Распознаваемые параметры зависят от виджета, но и DraftailRichTextArea и HalloRichTextArea принимают список features с указанием активных функций редактирования с богатым текстом (см. Ограничение функций в поле с богатым текстом).

Если редактор 'default' не указан, поля с богатым текстом, не указывающие аргумент editor, будут использовать редактор Draftail со включённым набором функций по умолчанию.

WAGTAILADMIN_EXTERNAL_LINK_CONVERSION

WAGTAILADMIN_EXTERNAL_LINK_CONVERSION = 'exact'

Настройка поведения Wagtail при вводе внутреннего URL-адреса страницы в выборе внешней ссылки. Возможные значения этой настройки — 'all', 'exact', 'confirm, или ''. По умолчанию, 'all', Wagtail автоматически преобразует отправленные URL-адреса, точно совпадающие с адресами страниц, в соответствующие внутренние ссылки. Если URL-адрес не совпадает точно — например, отправленный URL-адрес содержит параметры запроса — тогда Wagtail подтвердит преобразование с пользователем. 'exact' означает, что все неточные совпадения останутся внешними URL-адресами, и шаг подтверждения будет пропущен. 'confirm' означает, что каждое преобразование ссылки будет подтверждаться пользователем, даже если совпадение точное. '' означает, что Wagtail не будет пытаться преобразовать введённые URL-адреса во внутренние ссылки на страницы.

Блокировка редактирования страниц

WAGTAILADMIN_GLOBAL_PAGE_EDIT_LOCK

WAGTAILADMIN_GLOBAL_PAGE_EDIT_LOCK можно установить на True для предотвращения редактирования страниц, которые были заблокированы.

Перенаправления

WAGTAIL_REDIRECTS_FILE_STORAGE

WAGTAIL_REDIRECTS_FILE_STORAGE = 'tmp_file'

По умолчанию импорт перенаправлений отслеживает загруженный файл как временный файл, но на определённых средах (сбалансированных по нагрузке/облачных средах) вы не можете сохранить общий файл между средами. В таких случаях можно использовать встроенный кэш для хранения файла вместо этого.

WAGTAIL_REDIRECTS_FILE_STORAGE = 'cache'

Формостроитель

WAGTAILFORMS_HELP_TEXT_ALLOW_HTML

WAGTAILFORMS_HELP_TEXT_ALLOW_HTML = True

При истинном значении теги HTML в тексте справки поля формы будут отображаться без экранирования (по умолчанию: Ложь).

Предупреждение

Включение этой опции позволит редакторам вставлять произвольный HTML-код на страницу, например, скрипты, которые могут позволить редактору получить права администратора, когда другой администратор просматривает страницу. Не включайте эту настройку, если вы не полностью доверяете своим редакторам.

Настройки рабочего процесса

WAGTAIL_WORKFLOW_ENABLED

WAGTAIL_WORKFLOW_ENABLED = False

Указывает, включены ли рабочие процессы модерации (по умолчанию: Истина). При отключении редакторам больше не будет предоставлена возможность отправлять страницы в рабочий процесс, а области настроек для администраторов для настройки рабочих процессов и задач станут недоступны.

WAGTAIL_WORKFLOW_REQUIRE_REAPPROVAL_ON_EDIT

WAGTAIL_WORKFLOW_REQUIRE_REAPPROVAL_ON_EDIT = True

Рабочие процессы модерации могут использоваться в двух режимах. Первый — требование, чтобы все задачи одобрили конкресную версию страницы для завершения рабочего процесса. В результате, если изменения внесены в страницу во время модерации, любые одобренные задачи должны быть повторно одобрены для новой версии перед завершением рабочего процесса. Это значение по умолчанию, WAGTAIL_WORKFLOW_REQUIRE_REAPPROVAL_ON_EDIT = True . Второй режим не требует повторного одобрения: если изменения внесены, когда задачи уже были одобрены, эти задачи не должны быть повторно одобрены. Это больше подходит для иерархической системы рабочих процессов. Для использования рабочих процессов в этом режиме установите WAGTAIL_WORKFLOW_REQUIRE_REAPPROVAL_ON_EDIT = False.

WAGTAIL_FINISH_WORKFLOW_ACTION

WAGTAIL_FINISH_WORKFLOW_ACTION = 'wagtail.core.workflows.publish_workflow_state'

Это устанавливает функцию, которая вызывается при успешном завершении рабочего процесса — по умолчанию wagtail.core.workflows.publish_workflow_state, которая публикует страницу. Функция должна принимать объект WorkflowState в качестве единственного позиционного аргумента.

WAGTAIL_WORKFLOW_CANCEL_ON_PUBLISH

WAGTAIL_WORKFLOW_CANCEL_ON_PUBLISH = True

Это определяет, отменяет ли публикация страницы текущий рабочий процесс (если истинно) или оставляет рабочий процесс без изменений (ложь). Отключение этого может быть полезно, если на вашем сайте есть длинные рабочие процессы с несколькими этапами, и вы хотите иметь возможность публиковать срочные обновления страниц, в то время как рабочий процесс продолжает предоставлять менее срочные отзывы.

  • Предыдущая Сигналы
  • Следующая Шаблон проекта

Содержание страницы

  • Настройки
    • Название сайта
      • WAGTAIL_SITE_NAME
    • Добавить слеш
      • WAGTAIL_APPEND_SLASH
    • Поиск
      • WAGTAILSEARCH_BACKENDS
      • WAGTAILSEARCH_HITS_MAX_AGE
    • Международная локализация
      • WAGTAIL_I18N_ENABLED
      • WAGTAIL_CONTENT_LANGUAGES
    • Вставки
      • WAGTAILEMBEDS_RESPONSIVE_HTML
    • Панель управления
      • WAGTAILADMIN_RECENT_EDITS_LIMIT
      • WAGTAILADMIN_USER_LOGIN_FORM
      • WAGTAIL_GRAVATAR_PROVIDER_URL
      • WAGTAIL_MODERATION_ENABLED
      • WAGTAIL_SLIM_SIDEBAR
    • Комментарии
      • WAGTAILADMIN_COMMENTS_ENABLED
    • Изображения
      • WAGTAILIMAGES_IMAGE_MODEL
      • WAGTAILIMAGES_IMAGE_FORM_BASE
      • WAGTAILIMAGES_MAX_UPLOAD_SIZE
      • WAGTAILIMAGES_MAX_IMAGE_PIXELS
      • WAGTAILIMAGES_FEATURE_DETECTION_ENABLED
      • WAGTAILIMAGES_INDEX_PAGE_SIZE
      • WAGTAILIMAGES_USAGE_PAGE_SIZE
      • WAGTAILIMAGES_CHOOSER_PAGE_SIZE
    • Документы
      • WAGTAILDOCS_DOCUMENT_MODEL
      • WAGTAILDOCS_DOCUMENT_FORM_BASE
      • WAGTAILDOCS_SERVE_METHOD
      • WAGTAILDOCS_CONTENT_TYPES
      • WAGTAILDOCS_INLINE_CONTENT_TYPES
      • WAGTAILDOCS_EXTENSIONS
    • Управление паролями
      • WAGTAIL_PASSWORD_MANAGEMENT_ENABLED
      • WAGTAIL_PASSWORD_RESET_ENABLED
      • WAGTAILUSERS_PASSWORD_ENABLED
      • WAGTAILUSERS_PASSWORD_REQUIRED
      • WAGTAIL_EMAIL_MANAGEMENT_ENABLED
    • Уведомления по электронной почте
      • WAGTAILADMIN_NOTIFICATION_FROM_EMAIL
      • WAGTAILADMIN_NOTIFICATION_USE_HTML
      • WAGTAILADMIN_NOTIFICATION_INCLUDE_SUPERUSERS
    • Уведомления о обновлениях Wagtail
      • WAGTAIL_ENABLE_UPDATE_CHECK
    • Закрытые страницы/документы
      • PASSWORD_REQUIRED_TEMPLATE
      • DOCUMENT_PASSWORD_REQUIRED_TEMPLATE
    • Страница входа
      • WAGTAIL_FRONTEND_LOGIN_TEMPLATE
      • WAGTAIL_FRONTEND_LOGIN_URL
    • Теги без учёта регистра
      • TAGGIT_CASE_INSENSITIVE
    • Теги из нескольких слов
      • TAG_SPACES_ALLOWED
    • Предел тегов
      • TAG_LIMIT
    • Unicode адреса страниц
      • WAGTAIL_ALLOW_UNICODE_SLUGS
    • Автообновление предварительного просмотра
      • WAGTAIL_AUTO_UPDATE_PREVIEW
    • Пользовательские формы редактирования
      • WAGTAIL_USER_EDIT_FORM
      • WAGTAIL_USER_CREATION_FORM
      • WAGTAIL_USER_CUSTOM_FIELDS
    • Использование изображений, документов и фрагментов
      • WAGTAIL_USAGE_COUNT_ENABLED
    • Ввод даты и времени
      • WAGTAIL_DATE_FORMAT, WAGTAIL_DATETIME_FORMAT, WAGTAIL_TIME_FORMAT
    • Часовые пояса
      • WAGTAIL_USER_TIME_ZONES
    • Языки административной панели
      • WAGTAILADMIN_PERMITTED_LANGUAGES
    • Статические файлы
      • WAGTAILADMIN_STATIC_FILE_VERSION_STRINGS
    • Настройки API
      • WAGTAILAPI_BASE_URL
      • WAGTAILAPI_LIMIT_MAX
      • WAGTAILAPI_SEARCH_ENABLED
      • WAGTAILAPI_USE_FRONTENDCACHE
    • Кэш фронта
      • WAGTAILFRONTENDCACHE
      • WAGTAILFRONTENDCACHE_LANGUAGES
    • Форматированный текст
      • WAGTAILADMIN_RICH_TEXT_EDITORS
      • WAGTAILADMIN_EXTERNAL_LINK_CONVERSION
    • Блокировка страниц
      • WAGTAILADMIN_GLOBAL_PAGE_EDIT_LOCK
    • Перенаправления
      • WAGTAIL_REDIRECTS_FILE_STORAGE
    • Блок создания форм
      • WAGTAILFORMS_HELP_TEXT_ALLOW_HTML
    • Рабочий процесс
      • WAGTAIL_WORKFLOW_ENABLED
      • WAGTAIL_WORKFLOW_REQUIRE_REAPPROVAL_ON_EDIT
      • WAGTAIL_FINISH_WORKFLOW_ACTION
      • WAGTAIL_WORKFLOW_CANCEL_ON_PUBLISH

© 2014-present Torchbox Ltd and individual contributors.
All rights are reserved.
Licensed under the BSD License.
https://docs.wagtail.org/en/v2.16.3/reference/settings.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API