如何在Django Wagtail后台实现robots.txt纯文本编辑功能

要让管理员能在Wagtail后台直接编辑robots.txt，按以下步骤实现：

1. 创建RobotsTxt单例模型 #

首先在你的应用中定义一个模型，专门存储robots.txt的内容，同时限制只能存在一个实例（避免多版本冲突）：

# models.py
from django.db import models
from wagtail.contrib.modeladmin.options import ModelAdmin, modeladmin_register
from wagtail.admin.panels import FieldPanel

class RobotsTxt(models.Model):
    content = models.TextField(
        verbose_name="robots.txt内容",
        default="User-agent: *\nDisallow:"
    )

    panels = [
        FieldPanel('content', classname="full"),
    ]

    class Meta:
        verbose_name = "Robots.txt 管理"
        verbose_name_plural = "Robots.txt 管理"

    def save(self, *args, **kwargs):
        # 确保始终只有一个实例存在
        if not self.pk and RobotsTxt.objects.exists():
            existing = RobotsTxt.objects.first()
            existing.content = self.content
            existing.save()
            self.pk = existing.pk
        super().save(*args, **kwargs)

2. 注册到Wagtail后台 #

通过ModelAdmin将模型注册到Wagtail后台，添加专属菜单入口：

# admin.py
from .models import RobotsTxt

class RobotsTxtAdmin(ModelAdmin):
    model = RobotsTxt
    menu_label = 'Robots.txt'
    menu_icon = 'doc-full-inverse'
    menu_order = 1000  # 让菜单显示在靠后位置
    add_to_settings_menu = False
    exclude_from_explorer = True
    list_display = ('__str__',)  # 列表仅显示标识
    list_display_links = None  # 禁用列表跳转，直接用编辑按钮

    def get_queryset(self, request):
        # 首次访问自动创建默认实例
        qs = super().get_queryset(request)
        if not qs.exists():
            RobotsTxt.objects.create()
        return qs

modeladmin_register(RobotsTxtAdmin)

3. 配置robots.txt访问路由 #

编写视图读取模型内容，让网站根目录的/robots.txt指向该视图：

# views.py
from django.http import HttpResponse
from .models import RobotsTxt

def robots_txt(request):
    try:
        robots = RobotsTxt.objects.first()
        content = robots.content if robots else "User-agent: *\nDisallow:"
    except RobotsTxt.DoesNotExist:
        content = "User-agent: *\nDisallow:"
    return HttpResponse(content, content_type="text/plain")

在项目根路由中添加映射：

# urls.py
from django.urls import path
from .views import robots_txt

urlpatterns = [
    # ... 其他已有路由
    path('robots.txt', robots_txt, name='robots_txt'),
]

4. 权限控制 #

利用Wagtail自带的权限系统，在后台「设置-权限」中，给管理员组分配RobotsTxt模型的编辑权限，确保只有授权用户能修改内容。

测试验证 #

1. 登录Wagtail后台，找到「Robots.txt」菜单入口
2. 编辑内容后保存，访问网站根目录的/robots.txt，确认内容已更新

内容的提问来源于stack exchange，提问作者Hatim