feat: Channels/terminal/xterm sample

config/asgi.py

@@ -0,0 +1,24 @@
+import os
+
+from channels.auth import AuthMiddlewareStack
+from channels.routing import ProtocolTypeRouter, URLRouter
+from channels.security.websocket import AllowedHostsOriginValidator
+from django.core.asgi import get_asgi_application
+
+from django_web_repl.urls import websocket_urlpatterns
+
+os.environ.setdefault("DJANGO_SETTINGS_MODULE", "config.settings.production")
+# Initialize Django ASGI application early to ensure the AppRegistry
+# is populated before importing code that may import ORM models.
+django_asgi_app = get_asgi_application()
+
+import django_web_repl.urls
+
+application = ProtocolTypeRouter(
+    {
+        "http": django_asgi_app,
+        "websocket": AllowedHostsOriginValidator(
+            AuthMiddlewareStack(URLRouter(websocket_urlpatterns))
+        ),
+    }
+)

config/settings/base.py

@@ -1,6 +1,7 @@
 """
 Base settings to build other settings files upon.
 """
+
 from pathlib import Path
 
 import environ
@@ -60,6 +61,7 @@
 # APPS
 # ------------------------------------------------------------------------------
 DJANGO_APPS = [
+    "daphne",
     "django.contrib.auth",
     "django.contrib.contenttypes",
     "django.contrib.sessions",
@@ -87,6 +89,7 @@
     "django_user_agents",
     "django_json_ld",
     "django_custom_error_views",
+    "django_web_repl",
     "health_check",
     "meta",
     "modelcluster",
@@ -437,3 +440,13 @@
 
 # Django-prometheus
 PROMETHEUS_EXPORT_MIGRATIONS = env.bool("PROMETHEUS_EXPORT_MIGRATIONS", True)
+
+ASGI_APPLICATION = "config.asgi.application"
+CHANNEL_LAYERS = {
+    "default": {
+        "BACKEND": "channels_redis.core.RedisChannelLayer",
+        "CONFIG": {
+            "hosts": [("127.0.0.1", 6379)],
+        },
+    },
+}

config/urls.py

@@ -17,6 +17,7 @@
 
 
 urlpatterns: list[Any] = [
+    path("admin/terminal/", include("django_web_repl.urls")),
     # Django Admin, use {% url 'admin:index' %}
     path(settings.ADMIN_URL, admin.site.urls),
     # User management

django_wtf/customadmin/apps.py

@@ -1,10 +1,40 @@
 from admin_site_search.views import AdminSiteSearchView
 from django.contrib import admin
 from django.contrib.admin.apps import AdminConfig
+from django.urls import path
+from django_web_repl.views import TerminalView
 
 
 class CustomAdminSite(AdminSiteSearchView, admin.AdminSite):
-    pass
+    def get_urls(self):
+
+        urls = super().get_urls()
+        urls.insert(
+            0,
+            path(
+                "terminal/",
+                self.admin_view(TerminalView.as_view()),
+                name="terminal",
+            ),
+        )
+        return urls
+
+    def get_app_list(self, request, app_label=None):
+        app_list = [
+            {
+                "name": "Terminal",
+                "app_label": "terminal",
+                "models": [
+                    {
+                        "name": "Terminal",
+                        "object_name": "Terminal",
+                        "admin_url": "/admin/terminal/",
+                        "view_only": True,
+                    }
+                ],
+            }
+        ] + super().get_app_list(request)
+        return app_list
 
 
 class CustomAdminConfig(AdminConfig):