llms.txt для Django
Четыре подхода для Django: статический файл (отдаваемый через Nginx), простое представление, возвращающее HttpResponse, динамическое представление из моделей базы данных или кэшированное представление для сайтов с высоким трафиком.
Последнее обновление:
Вариант 1: статический файл через STATICFILES_DIRS
Django — это staticfiles фреймворк копирует файлы из STATICFILES_DIRS в STATIC_ROOT при запуске collectstatic. Затем можно настроить Nginx на непосредственную отдачу файла, но
учтите, что URL будет находиться в разделе STATIC_URL
префикс (например, /static/llms.txt), а не в корне.
# Django static file approach
#
# 1. Place llms.txt in one of your STATICFILES_DIRS:
# myproject/
# ├── static/
# │ └── llms.txt ← add this
# └── myapp/
#
# 2. In settings.py, make sure STATICFILES_DIRS includes the static/ folder:
# STATICFILES_DIRS = [BASE_DIR / "static"]
#
# 3. Run collectstatic to copy it to STATIC_ROOT:
# python manage.py collectstatic
#
# NOTE: Django's staticfiles serve files under the STATIC_URL prefix (/static/ by default).
# This means the file will be at /static/llms.txt, NOT /llms.txt.
# Use the view approach below to serve at the root path /llms.txt.
Чтобы обслуживать по адресу /llms.txt из статических файлов настройте Nginx с помощью
alias директиву, указывающую на собранный файл в STATIC_ROOT. См. фрагмент конфигурации Nginx в разделе о развёртывании ниже.
Вариант 2: пользовательское представление с HttpResponse
Самый простой подход в Django — минимальное представление, возвращающее содержимое файла с
правильным content_type. Это работает с любой целью развёртывания и отдаёт файл
точно по адресу /llms.txt.
# myapp/views.py
from django.http import HttpResponse
LLMS_TXT_CONTENT = """# My Site
> One-sentence description of what my site or product does.
## Documentation
- [Getting Started](https://mysite.com/docs/start/): Install and configure in minutes.
- [API Reference](https://mysite.com/docs/api/): Full endpoint catalog with examples.
## Product
- [Overview](https://mysite.com/product/): Core features and capabilities.
- [Pricing](https://mysite.com/pricing/): Plans and billing details.
## Optional
- [Changelog](https://mysite.com/changelog/): Release history.
- [GitHub](https://github.com/my-org/my-repo): Source code.
"""
def llms_txt(request):
return HttpResponse(
LLMS_TXT_CONTENT,
content_type="text/plain; charset=utf-8",
headers={
"Cache-Control": "public, max-age=3600, stale-while-revalidate=86400",
},
)
Подключите это в корневом файле urls.py:
# myproject/urls.py
from django.urls import path
from myapp.views import llms_txt
urlpatterns = [
# Serve at /llms.txt (root path)
path("llms.txt", llms_txt, name="llms-txt"),
# ... your other URL patterns
]
path("llms.txt", ...) шаблон (без начального слеша) соответствует URL /llms.txt. Django удаляет начальную косую черту перед сопоставлением.
Вариант 3: динамическая генерация из моделей
Для сайтов, где страницы документации хранятся в базе данных, генерируйте содержимое файла из
queryset. Используйте встроенный cache_page декоратор, чтобы не обращаться к базе данных при каждом запросе.
# myapp/views.py
# Dynamic generation from database models
from django.http import HttpResponse
from django.views.decorators.cache import cache_page
from myapp.models import DocumentPage
# Cache for 1 hour, regenerated automatically when cache expires
@cache_page(60 * 60)
def llms_txt(request):
docs = DocumentPage.objects.filter(
published=True,
include_in_llms=True,
).order_by("order").values("title", "slug", "summary")
lines = ["# My Site", "", "> Documentation and API reference.", "", "## Documentation", ""]
for doc in docs:
url = f"https://mysite.com/docs/{doc['slug']}/"
lines.append(f"- [{doc['title']}]({url}): {doc['summary']}")
lines += [
"",
"## Optional",
"",
"- [Changelog](https://mysite.com/changelog/): Release history.",
]
return HttpResponse(
"\n".join(lines),
content_type="text/plain; charset=utf-8",
)
Добавьте логическое поле include_in_llms передайте вашей модели, чтобы редакторы могли
управлять тем, какие страницы появляются в файле. Запустите валидатор после любой миграции содержимого, чтобы выявить регрессии форматирования.
Развёртывание WSGI/ASGI (Gunicorn, uWSGI, Nginx)
Представление Django работает со всеми распространёнными вариантами развёртывания. Само представление синхронное и лёгкое, асинхронность не требуется.
# nginx.conf snippet, proxy to Gunicorn upstream
server {
listen 80;
server_name mysite.com;
# Serve llms.txt directly from Gunicorn (Django view)
location = /llms.txt {
proxy_pass http://127.0.0.1:8000;
proxy_set_header Host $host;
proxy_cache_valid 200 1h;
add_header Cache-Control "public, max-age=3600";
}
# Optionally serve a pre-built static copy faster:
# location = /llms.txt {
# alias /srv/mysite/static_root/llms.txt;
# add_header Content-Type "text/plain; charset=utf-8";
# }
}
- Gunicorn, работает сразу. Представление возвращает 200 с
text/plain; специальная настройка не требуется. - uWSGI, как Gunicorn. Если вы используете отдачу статических файлов через
uWSGI, можно сопоставить
/llms.txtнепосредственно к файлу вSTATIC_ROOTс помощьюstatic-map = /llms.txt=/path/to/llms.txt. - ASGI (Daphne, Uvicorn), представление совместимо без изменений. Django автоматически оборачивает синхронные представления в исполнитель потоков.
- Кэш Nginx, добавьте
proxy_cache_valid 200 1hв блоке location Nginx, чтобы кэшировать ответ на уровне прокси и не обращаться к Django при каждом запросе краулера.
Проверить
После развёртывания убедитесь, что файл обслуживается корректно:
curl -I https://mysite.com/llms.txt
# Expected:
# HTTP/2 200
# content-type: text/plain; charset=utf-8
curl https://mysite.com/llms.txt | head -5
# Should print the first lines of your file Связанные руководства
- Как создать llms.txt, шаблоны и контрольный список.
- Справочник формата llms.txt, подробности спецификации.
- Руководство по Express.js, эквивалентный подход для Node.js.
- Руководство по Laravel, аналогичный подход для PHP.
- Валидатор · Генератор.