Auto-hébergement LightCMS
DéployerGuide de l'auto-hôte LightCMS, couvrant l'application GitHub, PostgreSQL, les variables d'environnement, AI, CDN et email optionnels, et le déploiement sur arête.
Vous voulez LightCMS entièrement sous votre contrôle ? LightCMS est une application SvelteKit , donc elle peut être déployée n'importe où, soutenue par une base de données PostgreSQL et une application GitHub (Octokit). Votre contenu ne quitte jamais vos propres dépôts GitHub.
Ce guide vous guide à travers tout ce dont vous avez besoin pour exécuter votre propre instance : création de l'application GitHub, provisioning PostgreSQL, configuration des variables d'environnement et déploiement.
Comment les pièces s'adaptent ensemble
| Composant | Objectif | Requis |
|---|---|---|
| PostgreSQL | Stocke les utilisateurs, les sessions, les mots de passe et les installations GitHub | Oui |
| GitHub App | Lit et écrit du contenu dans vos dépôts et signe les utilisateurs avec GitHub | Oui |
| Fournisseur SMTP | Envoie des e-mails de connexion de lien magique | Oui, pour vous connecter à un lien magique |
| API compatible OpenAI | Pouvoir le Copilot de l'IA | Optionnel |
| API de synthèse à texte | Pouvoir dicter la voix | Optionnel |
| CDN de l'image | Hôtes les images téléchargées dans l'éditeur | Optionnel |
| PosteHog | Analyse des produits et observabilité de l'IA | Requis dans le développement seulement |
Pré-requis
- mise à jour: installe et gère les dépendances de tâches. Ce guide suppose que vous l'avez installé.
- PostgreSQL: une base de données qui accepte les connexions TLS. Les fournisseurs de cloud tels que Neon, Supabase ou Nil fonctionnent bien. Voir de superbes postgres libres pour des options gratuites.
- GitHub account: needed to register the GitHub App.
- fournisseur SMTP (pour les liens magiques) : Si vous avez un domaine, Renvoyer est une bonne option. Sinon, utilisez Zoho Mail et créez un mot de passe de l'application.
TLS est obligatoire. L'application se connecte à PostgreSQL avec
ssl : "require". Une instance locale PostgreSQL sans TLS activée sera rejetée, donc utilisez une base de données hébergée ou configurez TLS sur votre propre serveur.
1. Fork the Repository and Install Dependencies
Cloner le dépôt et installer les dépendances :
cd lightcms
mise à jour trust
mise à jour deps
mise à jour install2. Create the GitHub App
LightCMS uses a GitHub App for two things: signing users in with GitHub (OAuth), and acting on your behalf through installations. Vous pouvez le créer avec l'assistant d'installation de Probot, ou à la main.
Option A : Assistant d'installation du Probot
démarrer le bot avec :
bot mis runSans authentification dans .env, Probot démarre un serveur de configuration à http://localhost:3000:
- Ouvrez
http://localhost:3000et cliquez sur Enregistrez l'application GitHub. - Choisissez votre compte personnel ou une organisation.
- Confirmez. Probot crée l'application et écrit ses identifiants dans votre fichier
.env.
L'assistant définit l'URL du webhook de l'application sur un canal Smee (ou http://localhost:3000/), pas sur le point de terminaison du webhook de LightCMS. Mettez à jour l'application dans les paramètres de GitHub avant de la mettre en ligne (voir déploiement de production).
Option B : Configuration manuelle
Créez l'application dans Paramètres GitHub → Paramètres du développeur → Applications GitHub → Nouvelle application GitHub avec ces valeurs :
| Réglages | Valeur |
|---|---|
| URL de la page d'accueil | https://<your-domain> |
| Callback URL | https://<your-domain>/api/auth/callback/github |
| Setup URL | https://<your-domain>/github/setup |
| URL du Webhook | https://<your-domain>/api/github/webhook |
| Secret du Webhook | Un secret aléatoire (voir Générer des secrets) |
Autorisations du dépôt
| Permission | Accès | Utilisé pour |
|---|---|---|
Contenus |
Lire et écrire | Lecture et livraison des fichiers de contenu |
Problèmes |
Lire et écrire | Revoir les commentaires et les étiquettes sur les pull requests |
Demandes de tirage |
Lecture seule | Liste des fichiers modifiés dans une pull request |
Statuts de validation |
Lire et écrire | Signalement de la validation du contenu sur les Push |
Métadonnées |
Lecture seule | Obligatoire pour chaque application GitHub |
Abonnez-vous aux événements : Push et Pull request. Les événements d'installation sont livrés automatiquement aux applications GitHub.
Après avoir créé l'application, notez le App ID, générez un client secret, et générer et télécharger une clé privée (. em).
3. Configurer les variables d'environnement
Créez un fichier .env à la racine du projet. Le référentiel ne fournit pas de fichier d'exemple utilisable, donc utilisez la référence ci-dessous.
Requis
# ---------------------------------------------------------------------------
# Authentification (Better Auth)
# ---------------------------------------------------------------------------
BETTER_AUTH_SECRET="<output of: openssl rand -hex 32>"
# URL publique de cette instance. Doit correspondre à la visite des utilisateurs de l'URL.
BETTER_AUTH_URL="http://localhost:5173"
# -----------------------------------------------------------
# Base de données (PostgreSQL, TLS requis)
# -----------------------------------------------------------
DATABASE_URL="postgresql://user:password@host:5432/lightcms? slmode=require"
# -----------------------------------------------------------
# App GitHub
# ---------------------------------------------------------------------------
GITHUB_APP_ID="123456"
GITHUB_CLIENT_ID="Iv1. xxxxxxxxx"
GITHUB_CLIENT_SECRET="<github-app-client-secret>"
GITHUB_WEBHOOK_SECRET="<webhook-secret>"
GITHUB_PRIVATE_KEY="-----BEGIN RSA PRIVATE KEY-----
...
-----END RSA CLÉ PRIVÉE -----"GITHUB_PRIVATE_KEY est le contenu complet de PEM. Gardez les sauts de ligne et enveloppez la valeur entre guillemets, ce qui est la façon dont l'assistant Probot l'écrire.
Requis pour le développement
LightCMS rapporte des analyses et des erreurs à PostHog. Lorsque les touches sont manquantes, l'application lance en développement pour empêcher que les événements ne soient supprimés silencieusement. En production, elles sont optionnelles et la télémétrie est ignorée quand elles sont désactivées.
VITE_POSTHOG_PROJECT_TOKEN="phc_xxxxxxxxxxxx"
VITE_POSTHOG_HOST="https://us.i.posthog.com"E-mail: requis pour la connexion par lien magique
Les liens magiques sont envoyés par SMTP avec Nodemailer. L'envoi échoue avec une erreur de configuration quand MAIL_HOST, MAIL_USER, MAIL_PASS ou MAIL_FROM est manquant.
MAIL_HOST="smtp.resend.com"
# Par défaut 587 si omis
MAIL_PORT="465"
# "true", "1", "oui" ou "on" active implicitement TLS. Lorsqu'il est omis, TLS n'est activé que pour le port 465.
MAIL_SECURE="1"
MAIL_USER="resend"
MAIL_PASS="<smtp-password-or-api-key>"
MAIL_FROM="LightCMS <[email protected]>"Optionnel: Copilot AI
Le Copilot utilise n'importe quelle API de chat compatible avec OpenAI. Les trois variables sont nécessaires pour que cela fonctionne.
OPEN_AI_ENDPOINT="https://api.openai.com/v1"
OPEN_AI_APIKEY="sk-..."
OPEN_AI_MODEL="gpt-4o-mini"N'importe quel fournisseur qui expose une API compatible OpenAI fonctionne, par exemple OpenAI, OpenRouter (https://openrouter. i/api/v1) ou NVIDIA NIM.
Facultatif : dictée vocale à texte
LightCMS supporte deux backends de transcription. Lorsque les deux sont configurées, le backend compatible OpenAI est utilisé.
Transcription compatible OpenAI. Il est sélectionné quand SPEECH_API_KEY est défini, et a également besoin de SPEECH_MODEL:
SPEECH_API_KEY="<api-key>"
SPEECH_MODEL="whisper-1"
# URL de base du fournisseur. Omettre pour utiliser OpenAI par défaut.
SPEECH_ENDPOINT="https://api.openai.com/v1"Point SPEECH_ENDPOINT chez n'importe quel fournisseur qui implémente l'API /audio/transcriptions , et définissez SPEECH_MODEL sur un modèle que le fournisseur offre. Un /audio/transcriptions de fin est automatiquement supprimé.
Wit.ai est utilisé quand SPEECH_API_KEY n'est pas défini :
WIT_AI_TOKEN="<wit-ai-server-access-token>"Si aucun des deux n'est configuré, la dictée n'est pas disponible.
Optionnel: téléversements d'images (CDN)
Les images collées ou téléchargées dans l'éditeur sont envoyées à une API de téléchargement compatible avec la norme Chevereto. Les options hébergées incluent FreeImage.host et ImgBB, ou vous pouvez exécuter votre propre instance de Chevereto.
CDN_URL="https://freeimage.host/api/1/upload"
CDN_KEY="<cdn-api-key>"CDN_KEY est envoyé comme le paramètre de requête de la clé `` sauf si CDN_URL en contient déjà un. Si le téléchargement échoue ou que les variables sont supprimées, LightCMS revient à intégrer l'image dans le document en tant que données en base64 : URL. Cela marche, mais cela rend vos fichiers Markdown beaucoup plus grands, donc configurez un CDN pour un usage réel.
Transfert de Webhook local (développement uniquement)
WEBHOOK_PROXY_URL="https://smee.io/<your-channel>"Ceci est lu par Probot, pas par l'application SvelteKit. See Testing webhooks locally.
Génération des secrets
Utilisez l'un d'entre eux pour générer BETTER_AUTH_SECRET et GITHUB_WEBHOOK_SECRET:
openssl rand -hex 32
# ou
node -e "console.log(require('crypto').randomBytes(32).toString('hex'))"4. Configurer la base de données
LightCMS utilise Drizzle ORM. Le schéma vit dans src/lib/server/db/schema.tset les migrations sont générées dans le répertoire drizzle. Avec un ensemble DATABASE_URL , appliquez les migrations :
bun run db:migrateLors du développement local, vous pouvez plutôt pousser le schéma directement dans la base de données, sans fichiers de migration :
exécuter bun db:pushAutres scripts de base de données:
| Commandes | Libellé |
|---|---|
bun run db:generate |
Générer une migration après modification du schéma |
exécuter bun db:studio |
Parcourir et éditer vos données dans Drizzle Studio |
5. Exécuter localement
exécuter le développeur bun

LightCMS est maintenant disponible sur http://localhost:5173. Set BETTER_AUTH_URL to this address, and sign in with GitHub for the first time.
Test des webhooks localement
GitHub ne peut pas livrer de webhooks à localhost, donc transférez-les via smee.io:
Créez un salon sur smee.io et copiez son URL.
Set
WEBHOOK_PROXY_URLin.envto that URL.Définissez l'URL Webhook dans les paramètres de votre application GitHub à la même URL.
Exécuter le bot dans un second terminal :
bun run bot:start
Le bot enregistre les mêmes gestionnaires que le point de terminaison de production : validation de contenu sur push, examiner les commentaires et les étiquettes sur pull_request, et installation logging.
6. Déploiement de production
Le projet est configuré avec SvelteKit, qui est agnostique de fournisseur. Vercel, Netlify et Cloudflare Workers sont toutes des cibles de déploiement prises en charge.
- Importez votre dépôt Git dans la plate-forme de déploiement.
- Ajoute chaque variable d'environnement de l'étape 3 dans Paramètres du projet → Environnement Variables. Set
BETTER_AUTH_URLto your production URL. - Déploiez.
Pour vérifier la construction de la production localement:
bun run build
bun run previewDépannage
Créez un compte avec Wit.ai c'est un service gratuit par meta | et n'importe quelle API openai compatible pour la transcription. | On peut utiliser groq ou assemblyai ou | onze ou deepgram ou sarvam. |
Identifiants postHog
Use the project token from your own PostHog project (Project settings → Project API key). Ne réutilisez pas un jeton de cette documentation : des événements envoyés avec un jeton de terre partagé dans le projet de quelqu'un d'autre, de sorte que ses indications, alertes et notifications ne sont pas à vous de lire.
VITE_POSTHOG_PROJECT_TOKEN=phc_your_project_token
VITE_POSTHOG_HOST=https://us.i.posthog.com
WIT_AI_TOKEN="Jeton d'accès au serveur"
WIT_AI_CLIENT_TOKEN="Jeton d'accès au client"APP_ID=
BETTER_AUTH_SECRET=
BETTER_AUTH_URL=
CDN_KEY=
CDN_URL=
DATABASE_URL=
GITHUB_APP_ID=
GITHUB_APP_NAME=
GITHUB_CLIENT_ID=
GITHUB_CLIENT_SECRET=
GITHUB_PRIVATE_KEY=
GITHUB_WEBHOOK_SECRET=
MAIL_FROM=
MAIL_HOST=
MAIL_PASS=
MAIL_PORT=
MAIL_SECURE=
MAIL_USER=
OPEN_AI_ENDPOINT=
OPEN_AI_MODEL=
OPEN_AI_APIKEY=
ORIGIN=
PRIVATE_KEY=
VITE_POSTHOG_HOST=
VITE_POSTHOG_PROJECT_TOKEN=
SPEECH_API_KEY=
SPEECH_ENDPOINT=
SPEECH_MODEL=
WEBHOOK_SECRET=
WIT_AI_CLIENT_TOKEN=
WIT_AI_TOKEN=