mirror of
https://github.com/screentinker/screentinker.git
synced 2026-06-15 02:33:15 -06:00
406f481a57
DISABLE_REGISTRATION already closes public self-service signup (first-user setup on an empty DB still allowed) and the login page already hides its "Create account" button when it's set - but the flag was easy to miss: it was in the README env-var table yet absent from .env.example (the file self-hosters actually copy) and from the README systemd unit example. - .env.example: document DISABLE_REGISTRATION + DISABLE_HOMEPAGE under the Self-hosting section. - README: add commented Environment= lines for both to the systemd example, noting the login UI hides the signup button to match. Docs only - no code change. Backend gate (routes/auth.js canRegister + /auth/config registration_enabled) and the login.js hiding already behave correctly; verified registration_enabled flips to false under the flag. Closes #11.
48 lines
2.4 KiB
Plaintext
48 lines
2.4 KiB
Plaintext
# ScreenTinker server configuration — process environment variables.
|
|
#
|
|
# NOTE: the app reads these from the *process environment* (your systemd unit's
|
|
# Environment=/EnvironmentFile=, your container runtime, or your shell). It does
|
|
# NOT auto-load this file. Copy the values you need into your process manager.
|
|
# This file exists only to document the available options.
|
|
|
|
# --- Self-hosting ---
|
|
# Set to "true" on your own instance. When true, the hosted signup emails
|
|
# (welcome to the user + admin notification) are disabled, so a self-hosted
|
|
# instance never emits mail from a domain that isn't yours.
|
|
SELF_HOSTED=true
|
|
|
|
# Close public self-service registration — for instances where all accounts are
|
|
# provisioned by your team (admin "Add user" / invites). When true, the public
|
|
# signup route is blocked (OAuth auto-signup with it) AND the login page hides
|
|
# its "Create account" button so the UI matches the backend. First-user setup on
|
|
# an empty DB is still allowed so a fresh install can be initialized.
|
|
# DISABLE_REGISTRATION=true
|
|
|
|
# Redirect "/" to the app (/app) instead of serving the marketing landing page.
|
|
# For internal-only deployments that don't want the public homepage shown.
|
|
# DISABLE_HOMEPAGE=true
|
|
|
|
# Where new-signup admin notifications are sent. Leave UNSET to disable admin
|
|
# notifications entirely — the user's welcome email is unaffected. Self-hosters
|
|
# who want to be notified of signups set this to their own address.
|
|
# ADMIN_NOTIFY_EMAIL=you@example.com
|
|
|
|
# Marks THIS deployment as the hosted (screentinker.com) instance. Gates the
|
|
# daily activation-nudge sweep (the T+3 "haven't paired a screen yet?" email).
|
|
# Leave UNSET on self-hosted instances so a daily bulk sweep never emails your
|
|
# user base with our onboarding mail. Only the hosted instance sets this true.
|
|
# HOSTED_INSTANCE=true
|
|
|
|
# --- Outbound email (Microsoft Graph, client-credentials flow) ---
|
|
# Required for ANY email (welcome, offline alerts, admin notify) to actually
|
|
# send. Leave blank and the app logs "[EMAIL] not configured" instead of sending.
|
|
# GRAPH_TENANT_ID=
|
|
# GRAPH_CLIENT_ID=
|
|
# GRAPH_CLIENT_SECRET=
|
|
# GRAPH_SENDER_EMAIL=signage@example.com
|
|
# GRAPH_SENDER_NAME=ScreenTinker
|
|
# Dev safety net: comma-separated allow-list of recipients. When set, mail to
|
|
# any address NOT in the list is suppressed (logged, not sent). Leave UNSET in
|
|
# production. Useful locally so test signups can't email real users.
|
|
# GRAPH_DEV_RESTRICT_TO=me@example.com
|