Démarrage rapide

Passez de zéro à une plateforme de documentation fonctionnelle en moins de 5 minutes. Ce guide couvre le chemin le plus rapide — pour les options détaillées, consultez le guide d’Installation.

Étape 1 : Installer

# Recommandé (détection automatique de la plateforme)
curl -fsSL https://valoryx.org/install.sh | sh

Ou télécharger manuellement :

curl -sLO https://github.com/Valoryx-org/releases/releases/latest/download/docplatform-linux-amd64
chmod +x docplatform-linux-amd64
sudo mv docplatform-linux-amd64 /usr/local/bin/docplatform

Ou avec Docker :

docker run -d --name docplatform -p 3000:3000 -v docplatform-data:/data ghcr.io/valoryx-org/docplatform:latest

Si vous utilisez Docker, passez directement à l’Étape 3 — le conteneur s’initialise automatiquement.

Étape 2 : Initialiser un espace de travail

docplatform init --workspace-name "My Docs" --slug my-docs

Cela crée :

.docplatform/
├── data.db              # SQLite database
├── jwt-key.pem          # Auto-generated RS256 signing key
└── workspaces/
    └── {workspace-id}/
        ├── docs/        # Your documentation lives here
        └── .docplatform/
            └── config.yaml

Avec git (optionnel)

Connectez-vous à un dépôt git existant lors de l’initialisation :

docplatform init \
  --workspace-name "My Docs" \
  --slug my-docs \
  --git-url [email protected]:your-org/docs.git \
  --branch main

DocPlatform clone le dépôt et commence la synchronisation. Tous les fichiers .md existants sont automatiquement indexés.

Étape 3 : Démarrer le serveur

docplatform serve

INFO  Server starting            port=3000 version=v0.5.2
INFO  Database initialized       path=.docplatform/data.db
INFO  Search index ready         documents=0
INFO  Workspace loaded           name="My Docs" slug=my-docs
INFO  Listening on               http://localhost:3000

Ouvrez http://localhost:3000 dans votre navigateur.

Étape 4 : Enregistrer votre compte

Le premier utilisateur à s’enregistrer devient automatiquement Super Admin avec un accès complet à la plateforme.

1. Cliquez sur Create Account
2. Saisissez votre nom, e-mail et mot de passe
3. Vous êtes connecté et prêt à rédiger

Note de sécurité : Le mécanisme « premier utilisateur = admin » ne s’applique que lorsqu’aucun utilisateur n’existe. Après la première inscription, les nouveaux comptes reçoivent le rôle par défaut configuré pour l’espace de travail.

Étape 5 : Créer votre première page

1. Cliquez sur New Page dans la barre latérale
2. Donnez-lui un titre — le slug d’URL est généré automatiquement à partir du titre
3. Commencez à rédiger dans l’éditeur riche
4. Les modifications sont sauvegardées automatiquement toutes les quelques secondes

La page est stockée sous forme de fichier Markdown dans le répertoire docs/ de votre espace de travail. Si vous avez connecté git, elle est auto-commitée et poussée.

Étape 6 : Essayer

Voici quelques actions à essayer immédiatement :

Et ensuite