Installation

#Comment ça s'organise

Le panel Socle est hébergé par nous : tu n'as aucun site web à installer. Sur la machine de ton serveur FiveM, tu installes deux choses :

• la base Socle : les ressources du jeu, ta base de données et server.cfg ;
• l'agent : un petit programme Node.js qui relie ton serveur au panel en ligne.

ton navigateur ──HTTPS──▶ panel en ligne ◀──connexion sortante chiffrée── agent ──▶ ta base de données
                                                                            ├──▶ le dossier du serveur
                                                                            └──▶ FXServer (démarrer, arrêter)

L'agent ouvre lui-même la connexion vers le panel : aucun port à ouvrir chez toi. Tu te connectes ensuite au panel avec ton compte Discord.

#Prérequis

Organisation conseillée des dossiers :

MonServeur\
  artifact\FXServer.exe      ← l'artifact FiveM
  serveur\                   ← le dossier Socle (server.cfg, resources\, install\base.sql)
C:\SocleAgent\               ← l'agent

#1. Récupérer Socle

Après le paiement, la page de confirmation affiche ta clé de licence Socle. Socle est ensuite ajouté à ton compte Cfx.re : connecte-toi sur portal.cfx.re, ouvre Granted assets et télécharge-le.

Le paquet contient notamment :

Décompresse-le dans le dossier du serveur (MonServeur\serveur\ dans l'exemple).

#2. Créer la base de données

1. Crée une base vide en utf8mb4 (par exemple socle).
2. Importe install\base.sql dedans : avec HeidiSQL (Fichier › Exécuter un fichier SQL), ou en ligne de commande :

mariadb -u utilisateur -p socle < install\base.sql

base.sql contient la structure et les données de référence, sans aucun joueur. Les tables se mettent ensuite à jour toutes seules à chaque démarrage du serveur.

#3. Configurer server.cfg

Copie server.cfg.example en server.cfg, et server_settings.cfg.example en server_settings.cfg. Puis remplis les lignes suivantes dans server.cfg :

# clé FiveM (portal.cfx.re › Server Keys)
sv_licenseKey "ta-cle-fivem"

# connexion à la base importée à l'étape 2
set mysql_connection_string "mysql://utilisateur:motdepasse@127.0.0.1:3306/socle?charset=utf8mb4"

# clé de licence Socle : « set », JAMAIS « setr » (elle ne doit pas partir aux joueurs)
set socle_license_key "SOCLE-XXXX-XXXX-XXXX"

# arrêt propre du serveur par le panel : 12 caractères au moins
set rcon_password "un-mot-de-passe-long-et-aleatoire"

# liaison entre le panel et le jeu : une longue valeur aléatoire, « set » seulement
set panel_token "une-longue-valeur-aleatoire"

# signature des events du Socle : un entier, « setr » (le client doit le lire)
setr network_token 123456789

OneSync doit rester activé (set onesync on, déjà présent dans le modèle). Avec txAdmin, active-le dans les réglages de txAdmin.

Le détail de la licence (vérification, période de grâce, mode limité) est dans La clé de licence.

#4. Ajouter ton serveur dans le panel

1. Clique sur Se connecter en haut du site Socle et connecte-toi avec Discord.
2. Ouvre Serveurs › Ajouter un serveur : donne un nom et ta clé de licence Socle.
3. Le panel affiche une seule fois la configuration de l'agent, avec son jeton. Copie-la tout de suite.

Le compte qui ajoute le serveur en devient propriétaire. Il invite ensuite son équipe : voir Équipe et accès.

#5. Installer et lancer l'agent

1. Installe Node.js 20 ou plus récent sur la machine du serveur.
2. Copie le dossier de l'agent (agent\) sur cette machine, par exemple dans C:\SocleAgent. Si tu ne l'as pas, demande-le à l'équipe sur Discord.
3. Dans ce dossier, installe ses dépendances :

cd C:\SocleAgent
npm ci

1. Crée config.json à partir de config.example.json. Colle la configuration donnée par le panel (adresse, identifiant et jeton déjà remplis), puis complète :

1. Lance l'agent :

node index.mjs

Le journal affiche « connecté au panel », et la page Serveurs du panel passe ton agent en ligne.

Pour que l'agent démarre avec Windows et redémarre seul s'il s'arrête, installe-le en service : voir Lancer l'agent au démarrage de Windows. Toutes les clés de config.json sont détaillées dans Installer l'agent.

#6. Premier démarrage

Avant de lancer le serveur, tu peux exécuter verifier-installation.ps1 (clic droit › Exécuter avec PowerShell) : il contrôle server.cfg, la base et les ressources sans rien modifier.

Dans le panel, ouvre Serveur › État & redémarrage et clique sur Démarrer. L'agent lance FXServer.exe et attend que le serveur réponde.

Au premier démarrage, le serveur publie la liste de ses réglages : c'est à ce moment que les catégories apparaissent dans le panel. Continue avec Premiers pas.

#Les vérifications de démarrage

Le bouton Démarrer refuse de lancer le serveur tant qu'un de ces points échoue, et indique quoi corriger :

Le chemin de FXServer.exe est vérifié par l'agent au moment du lancement.

#Héberger le panel soi-même (avancé)

Le panel garde un mode local, installé sur ta propre machine, avec son assistant d'installation et sa propre application Discord. Il n'est pas inclus dans le paquet Socle : si tu as une raison de l'héberger toi-même, parles-en à l'équipe sur Discord avant de commander.