Skip to content

ServerKit is a lightweight, modern server control panel for managing web applications, databases, and services on your VPS or dedicated server. Built with Python/Flask backend and React frontend.

docs(env): document the ALLOW_* security opt-ins and demo/staging flags

Juan Denisdcdd60b609fc
diff --git a/.env.example b/.env.example
index 542efe2b..ed582c3a 100644
--- a/.env.example
+++ b/.env.example
@@ -127,3 +127,23 @@ SERVERKIT_GITHUB_REPO=jhd3197/ServerKit
# Telegram Bot
# TELEGRAM_BOT_TOKEN=your-bot-token
# TELEGRAM_CHAT_ID=your-chat-id
+
+# ----------------------------------------
+# Security opt-ins & special modes
+# ----------------------------------------
+
+# Allow installed extensions to pip-install the Python requirements they ship.
+# Off by default: pip runs with the backend's privileges.
+# SERVERKIT_ALLOW_PLUGIN_PIP=false
+
+# Allow extension downloads from non-HTTPS / private-network URLs.
+# SERVERKIT_ALLOW_PRIVATE_DOWNLOADS=false
+
+# Read-only demo panel (mutating API calls are refused).
+# SERVERKIT_DEMO_MODE=false
+
+# Stream simulated deploys through the real deploy pipeline (no Docker needed).
+# SERVERKIT_DEMO_DEPLOYS=false
+
+# Mark this panel as a staging install (reported by /health).
+# SERVERKIT_STAGING=false
diff --git a/backend/.env.example b/backend/.env.example
index dea91bfa..7c4ee1c3 100644
--- a/backend/.env.example
+++ b/backend/.env.example
@@ -59,3 +59,10 @@ SERVERKIT_GITHUB_REPO=jhd3197/ServerKit
# the panel issues to agents will embed this URL instead of the request's
# Host header (which would otherwise be the internal IP/port).
# SERVERKIT_PUBLIC_URL=https://panel.your-domain.com
+
+# Security opt-ins & special modes (all default off)
+# SERVERKIT_ALLOW_PLUGIN_PIP=false # let extensions pip-install their requirements
+# SERVERKIT_ALLOW_PRIVATE_DOWNLOADS=false # allow non-HTTPS/private extension downloads
+# SERVERKIT_DEMO_MODE=false # read-only demo panel
+# SERVERKIT_DEMO_DEPLOYS=false # simulated deploys through the real pipeline
+# SERVERKIT_STAGING=false # mark this panel as staging (/health flag)