[En Cours] Documentation

NemStudio18

🇫🇷 Version française - Voir Réponse 1

🛠️ Un système de documentation de type wiki est actuellement à l’étude et en cours de développement.
En attendant, le guide ci-dessous est fourni à titre préparatoire en vue d’une future mise à jour.
Tous les retours, suggestions ou corrections sont les bienvenus afin d’en améliorer la qualité.

🇬🇧 English version - Voir Réponse 2

🛠️ A wiki-style documentation system is currently being designed and developed.
In the meantime, the following guide is provided as a preparatory resource for a future update.
Any feedback, suggestions, or corrections are welcome to help improve its quality.

NemStudio18

📚 Guide Complet CMS 299Ko - 🇫🇷 Français

📋 Table des Matières

Installation
Configuration
Utilisation de l'Interface d'Administration
Gestion des Plugins
Gestion des Thèmes
Sauvegarde et Restauration
Mises à Jour
Sécurité
Dépannage

🚀 Installation

Prérequis Système

Version PHP requise : PHP 7.4 ou supérieur

Extensions PHP recommandées :

json (requise)
curl (recommandée)
zip (recommandée pour les sauvegardes)
mbstring (recommandée)

Installation Simple

Téléchargez et décompressez le CMS 299Ko dans votre répertoire web
Accédez à l'URL de votre site : http://votre-domaine.com/install.php
Remplissez le formulaire avec :
- Une adresse email valide
- Un mot de passe sécurisé
Cliquez sur "Installer" - c'est tout ! 🎉

Après l'Installation

Le fichier install.php ne sera pas automatiquement supprimé
Vous pouvez vous connecter à l'interface d'administration, un popup récurrent vous proposera de supprimer install.php pour plus de sécurité.
La configuration se fait ensuite via le ConfigManager dans l'admin

Structure des Dossiers

test299ko/
├── admin/          # Interface d'administration
├── common/         # Core du système
├── data/           # Données et cache
├── plugin/         # Plugins installés
├── theme/          # Thèmes disponibles
├── index.php       # Point d'entrée public
└── install.php     # Installateur (supprimé après installation)

⚙️ Configuration

Accès au ConfigManager

Connectez-vous à l'interface d'administration
Accédez au ConfigManager via le menu principal (volet de gauche)
Configurez tous les paramètres de votre site

Paramètres Principaux

Paramètres du site :

Masquer le titre des pages: permet de cacher le titre des pages coté public
Plugin par défaut (public): coté public, permet de choisir quel plugin sera affiché en premier en accédant a https://votredomaine.fr
Plugin par défaut (admin): coté admin, permet de choisir quel plugin sera affiché en premier en accédant a https://votredomaine.fr/admin
Nom du site: le nom de votre site (affiché en haut a gauche coté public).
Description du site: La description qui sera affichée dans la bannière de votre site.
Langue du site: menu déroulant, choix de la langue par défaut utilisée sur le site.
Thème du site: menu déroulant, choix du thème à appliquer sur le site.

Paramètres avancés :

Mode debug (développement/production): activer ou non, permet d'afficher les différentes erreurs php renvoyées par le système (A désactiver ABSOLUMENT en production)
URL du site (sans slash final): bien que prérempli, vous pouvez le modifier lors d'une migration vers un autre nom de domaine par exemple, le plus souvent , vous n'avez pas a y toucher!
Contenu du fichier .htaccess: Vous avez la possibilité de modifier directement le .htaccess situé a la racine de votre installation de 299ko. Conseil: Pour des utilisateurs avérés !

Paramètres de mise en cache.

Activer la mise en cache : Active ou désactive complètement le système de cache. Désactivé automatiquement en mode administration.
Durée du cache (en secondes): Temps de vie des fichiers de cache (3600 = 1 heure). Les pages sont régénérées après expiration.
Minifier le HTML: Réduit la taille du HTML en supprimant espaces et commentaires tout en préservant les scripts et styles.
Lazy loading automatique: Ajoute automatiquement loading="lazy" aux images/iframes et alt="" aux images sans attribut alt.
Supprime tous les fichiers de cache existants: cliquer sur le bouton "Vider le cache"

Affiche les informations sur l'utilisation du cache: cliquer sur "Statistiques du cache afin de connaitre:

Nombre de fichiers en cache: X
Taille totale du cache: X.X KB
Dernier nettoyage: 2025-06-20 14:43:53

Minification des assets.

Minifier les fichiers CSS: Crée automatiquement des versions .min.css de tous les fichiers CSS pour réduire leur taille
Minifier les fichiers JavaScript: Crée automatiquement des versions .min.js de tous les fichiers JavaScript pour réduire leur taille

Avantages de performance.

Pages chargées instantanément depuis le cache
Réduction de la charge serveur et de la bande passante
Amélioration du référencement et de l'expérience utilisateur

Sécurité :

Clé de sécurité unique
Protection contre les attaques
Gestion des sessions

Sauvegarde de Configuration

Pour accèder au panneau de sauvegarde dans Configuration > Bouton en haut a droite de l'écran.

Créer une sauvegarde: cliquer sur ce bouton permet de générer une sauvegarde de votre installation puis de la télécharger via le bouton de téléchargement. Vous pourrez alors la réinjecter sur votre serveur web en cas de problème.
Restauration: via download après sauvegarde puis upload sur serveur web.

🎛️ Utilisation de l'Interface d'Administration

Connexion

Accédez à http://votre-domaine.com/admin/
Entrez vos identifiants (email + mot de passe)
Cliquez sur "Se connecter"

Navigation Principale

Menu de Navigation :

voir le site : Vue d'ensemble du site
Configuration : Configuration complète du CMS (nom, description mise en cache, etc...)
Gestionnaire de fichiers : Gestion des fichiers
Plugins : Gestion des extensions
Pages et menu : Gestion des pages et du menu
Utilisateurs : Gestion des utilisateurs

Gestion des Utilisateurs

Fonctionnalités :

Création de comptes utilisateurs (admin pour le moment)
Gestion des rôles et permissions (à venir )
Modification d'un utilisateur
Suppression de comptes

🔌 Gestion des Plugins

Plugins Disponibles

Plugins Installés par Défaut :

ConfigManager : Configuration complète du système
Users : Gestion des utilisateurs et authentification

Installation de Nouveaux Plugins

Préparez votre plugin dans un dossier

Structure requise :

   mon-plugin/
   ├── mon-plugin.php     # Fichier principal du plugin
   ├── param/
   │   ├── infos.json     # Métadonnées du plugin
   │   ├── config.json    # Configuration par défaut
   │   └── hooks.json     # Hooks du plugin
   ├── template/          # Templates (optionnel)
   │   ├── public.css     # CSS public
   │   ├── public.js      # JS public
   │   ├── admin.css      # CSS admin
   │   ├── admin.js       # JS admin
   │   ├── param.tpl      # Template des paramètres
   │   └── help.tpl       # Template d'aide
   ├── controllers/       # Contrôleurs (optionnel)
   ├── lib/              # Bibliothèques (optionnel)
   ├── langs/            # Fichiers de langue (optionnel)
   └── entities/         # Entités (optionnel)

Copiez le dossier dans /plugin/
Activez le plugin via l'interface d'administration

Structure d'un Plugin

Fichier param/infos.json :

{
    "slug": "mon-plugin",
    "name": "Mon Plugin",
    "icon": "fa-solid fa-icon",
    "description": "Description du plugin",
    "authorEmail": "votre@email.com",
    "authorWebsite": "https://votre-site.com",
    "version": "1.0.0",
    "homeAdminMethod": "MonPluginAdminController#home"
}

Fichier param/config.json :

{
    "activate": 0,
    "priority": 5
}

Fichier param/hooks.json :

{
    "hook1": "function1",
    "hook2": "function2"
}

Fichier principal (mon-plugin.php) :

<?php
// Fonction d'installation (optionnelle)
function monPluginInstall() {
    // Code d'installation
}

// Fonction de désinstallation (optionnelle)
function monPluginUninstall() {
    // Code de désinstallation
}

Gestion des Assets

Minification Automatique :

CSS et JS automatiquement minifiés
Cache intelligent des fichiers
Optimisation des performances

Structure des Assets :

template/
├── public.css          # CSS public
├── public.js           # JS public
├── admin.css           # CSS admin
└── admin.js            # JS admin

Activation/Désactivation

Via l'Interface Admin :

Accédez à la section Plugins
Cliquez sur "Activer" ou "Désactiver"
Confirmez l'action

Actions Disponibles :

Activer/Désactiver
Désinstaller
Mettre à jour

🎨 Gestion des Thèmes

Thèmes Disponibles

Thèmes par Défaut :

Default : Thème de base responsive
Admin : Interface d'administration

Installation de Nouveaux Thèmes

Préparez votre thème dans un dossier

Structure requise :

   mon-theme/
   ├── infos.json        # Métadonnées du thème
   ├── layout.tpl        # Template principal
   ├── styles.css        # CSS principal
   ├── scripts.js        # JavaScript principal
   ├── icon.png          # Icône du thème
   ├── functions.php     # Fonctions PHP (optionnel)
   └── plugin.tpl    # Templates pour plugins

Copiez le dossier dans /theme/
Activez le thème via l'interface d'administration > Configuration > Choix du thème.

Structure d'un Thème

Fichier infos.json :

{
    "name": "Mon Thème",
    "version": "1.0.0",
    "authorEmail": "votre@email.com",
    "authorWebsite": "https://votre-site.com"
}

Variables Disponibles

Variables Système :

{$site_name} : Nom du site
{$site_url} : URL du site
{$theme_assets} : Chemin vers les assets du thème
{$content} : Contenu principal

Variables Dynamiques :

{$page_title} : Titre de la page
{$page_content} : Contenu de la page
{$user_name} : Nom de l'utilisateur connecté

Gestion des Assets

Minification Automatique :

CSS et JS automatiquement minifiés
Images optimisées
Cache intelligent

Structure Recommandée :

mon-theme/
├── styles.css          # CSS principal
├── scripts.js          # JavaScript principal
├── icon.png            # Icône du thème
└── images/             # Images (optionnel)
    ├── logo.png
    └── background.jpg

Activation de Thème

Via l'Interface Admin :

Accédez à la section Thèmes
Cliquez sur "Activer" pour le thème souhaité
Confirmez l'action

Actions Disponibles :

Activer
Prévisualiser
Désinstaller
Voir les détails

💾 Sauvegarde et Restauration

Éléments Sauvegardés :

Configuration du système
Données utilisateurs
Plugins et thèmes
Fichiers de contenu

Sauvegarde Manuelle

Via l'Interface Admin :

Accédez à la section Sauvegardes (bouton en haut a droite dans "Configuration")
Cliquez sur "Créer une sauvegarde"
attendez
Télécharger la sauvegarde au format zip en cliquant sur le bouton.

Restauration

Ré-upload sur serveur web

⚠️ Attention :

La restauration écrase les données actuelles
Faites une sauvegarde avant restauration
Vérifiez la compatibilité des versions

Gestion des Sauvegardes

Actions Disponibles :

Télécharger une sauvegarde
Supprimer une sauvegarde

Stockage :

Sauvegardes stockées dans /data/backups/
Rotation automatique des anciennes sauvegardes
Compression pour économiser l'espace

🔄 Mises à Jour

Vérification des Mises à Jour

Automatique :

Vérification quotidienne des mises à jour
Notification dans l'interface d'administration
Vérification de la compatibilité

Mise à Jour du Core

Procédure Sécurisée :

Sauvegarde automatique avant mise à jour
Vérification de compatibilité des plugins/thèmes
Téléchargement de la nouvelle version
Installation automatique
Vérification du bon fonctionnement

En Cas de Problème :

Restauration automatique de la sauvegarde
Rollback vers la version précédente
Logs détaillés de la procédure

Mise à Jour des Plugins

Plugins Compatibles :

ConfigManager : Mises à jour automatiques
Users : Mises à jour automatiques

Procédure :

Vérification de la compatibilité
Sauvegarde du plugin actuel
Mise à jour automatique
Test de fonctionnement

Mise à Jour des Thèmes

Thèmes Compatibles :

Default : Mises à jour automatiques
Admin : Mises à jour automatiques

Procédure :

Sauvegarde du thème actuel
Mise à jour automatique
Vérification de l'apparence

🔒 Sécurité

Authentification

Système de Connexion :

Authentification par email/mot de passe
Sessions sécurisées
Protection contre les attaques par force brute
Déconnexion automatique après inactivité

Gestion des Mots de Passe :

Hachage sécurisé (bcrypt)
Politique de complexité
Récupération de mot de passe sécurisée

Protection du Système

Sécurité des Fichiers :

Protection des dossiers sensibles
Validation des uploads de fichiers
Restrictions d'accès aux fichiers système

Protection Web :

Protection CSRF (Cross-Site Request Forgery)
Validation des entrées utilisateur
Échappement des sorties
Headers de sécurité HTTP

Logs de Sécurité

Événements Traçés :

Erreurs système

Bonnes Pratiques

Recommandations :

Utilisez des mots de passe forts
Changez régulièrement vos identifiants
Surveillez les logs de sécurité
Faites des sauvegardes régulières
Maintenez le système à jour

Configuration Sécurisée :

Désactivez le mode debug en production
Utilisez HTTPS si possible
Limitez les tentatives de connexion
Activez la protection CSRF

🔧 Dépannage

Problèmes Courants

Erreur 500 - Erreur Serveur :

Vérifiez les logs dans /data/logs/
Activez le mode debug temporairement
Vérifiez les permissions des dossiers
Contactez l'administrateur si nécessaire

Page Blanche :

Vérifiez les logs PHP
Désactivez les plugins un par un
Vérifiez la configuration
Restaurez une sauvegarde si nécessaire

Problèmes de Connexion :

Vérifiez vos identifiants
Videz le cache du navigateur
Vérifiez les cookies
Contactez l'administrateur

Mode Debug

Activation Temporaire :

Accédez au ConfigManager
Activez le mode debug
Rechargez la page
Consultez les erreurs détaillées

Informations Affichées :

Erreurs PHP détaillées
Requêtes SQL (si applicable)
xxx

Logs Système

Types de Logs :

XXX : XXX

Récupération d'Urgence

Restauration Complète :

Restorez la dernière sauvegarde
Vérifiez la configuration
Testez toutes les fonctionnalités
Documentez le problème

Support et Aide

Ressources Disponibles :

Documentation : Ce guide complet
Logs système : Pour diagnostiquer les problèmes
Mode debug : Pour les erreurs détaillées
Sauvegardes : Pour la récupération

Contact :

Consultez d'abord la documentation
Vérifiez les logs système
Testez en mode debug
Contactez le support technique si nécessaire

📞 Support et Contact

Besoin d'Aide ?

Avant de Contacter le Support :

Consultez cette documentation
Vérifiez les logs système
Testez en mode debug
Recherchez dans les forums

Informations Utiles

Pour un Support Efficace :

Version du CMS utilisée ( last release ou Master (Github)?)
Version de PHP
Description détaillée du problème
Logs d'erreur pertinents
Étapes pour reproduire le problème

🎉 Conclusion

Le CMS 299Ko est conçu pour être simple, rapide et sécurisé. Cette documentation vous accompagne dans toutes les étapes de l'utilisation de votre CMS.

N'oubliez pas :

Faites des sauvegardes régulières
Maintenez votre système à jour
Surveillez les logs de sécurité
Testez avant de déployer en production

Bonne utilisation de votre CMS 299Ko ! 🚀

NemStudio18

📚 Complete Guide CMS 299Ko – 🇺🇸 English

🚀 Installation

System Requirements

Required PHP version: PHP 7.4 or newer
Recommended PHP extensions:

json (required)
curl (recommended)
zip (recommended for backups)
mbstring (recommended)

Quick Install

Download and extract CMS 299Ko into your web folder
Open http://your-domain.com/install.php in your browser
Fill out the form with:
- A valid email address
- A secure password
Click “Install” — that’s it! 🎉

After Installation

install.php will not be removed automatically
On login, a popup will remind you to delete it for security
Use ConfigManager in the admin panel for settings

Folder Structure

test299ko/
├── admin/          # Admin interface
├── common/         # Core system
├── data/           # Data & cache
├── plugin/         # Installed plugins
├── theme/          # Available themes
├── index.php       # Public entry point
└── install.php     # Installer (remove after install)

⚙️ Configuration

Accessing ConfigManager

Log in to the Admin Interface
Open ConfigManager from the left menu
Configure all site settings

Main Settings

Site options:

Hide page titles (public side)
Default public plugin (front page)
Default admin plugin (admin dashboard)
Site name (displayed top-left)
Site description (banner text)
Site language (dropdown)
Site theme (dropdown)

Advanced settings:

Debug mode (development/production): toggle to show/hide PHP errors (disable in production)
Site URL (no trailing slash): change only during domain migrations
.htaccess contents: editable directly from settings (for advanced users only)

Cache settings:

Enable/disable cache (auto-disabled in admin mode)
Cache lifetime (seconds, e.g., 3600 = 1 hour)
Minify HTML: removes spaces/comments
Automatic lazy loading: adds loading="lazy" to images/iframes
"Clear cache" button — removes all cached files
Cache stats: shows number of files, total size, last cleanup e.g., 2025‑06‑20 14:43:53

Asset minification:

Generate .min.css files for CSS
Generate .min.js files for JS

Performance benefits:

Instant pages served from cache
Reduced server load and bandwidth
Improved SEO and user experience

Security:

Unique security key
Attack protection
Secure session handling

Configuration backups:
In Configuration > top-right button:

Create backup – download a backup file
Restore – upload it back if needed

🎛️ Using the Admin Interface

Login

Visit http://your-domain.com/admin/
Enter your email and password
Click "Sign in"

Main Navigation

View Site – public front-end
Configuration – site settings
File Manager – file handling
Plugins – extension control
Pages & Menu – content and navigation
Users – user account management

User Management

Create user accounts (currently admins only)
Edit user details
Delete accounts
(Roles & permissions coming soon)

🔌 Plugin Management

Default Plugins

ConfigManager – system settings
Users – authentication & user management

Installing New Plugins

Prepare your plugin folder
Required structure:

my-plugin/
├── my-plugin.php         # Main plugin file
├── param/
│   ├── infos.json        # Plugin metadata
│   ├── config.json       # Default settings
│   └── hooks.json        # Hook definitions
├── template/             # Optional, UI templates
│   ├── public.css
│   ├── public.js
│   ├── admin.css
│   ├── admin.js
│   ├── param.tpl
│   └── help.tpl
├── controllers/          # Optional
├── lib/                  # Optional libraries
├── langs/                # Optional localization files
└── entities/             # Optional entities

Copy to /plugin/
Activate via Admin > Plugins

Plugin Structure

infos.json

{
  "slug": "my-plugin",
  "name": "My Plugin",
  "icon": "fa-solid fa-icon",
  "description": "Plugin description",
  "authorEmail": "you@domain.com",
  "authorWebsite": "https://your-site.com",
  "version": "1.0.0",
  "homeAdminMethod": "MyPluginAdminController#home"
}

config.json

{ "activate": 0, "priority": 5 }

hooks.json

{ "hook1": "function1", "hook2": "function2" }

my-plugin.php

<?php
function myPluginInstall() {
  // installation code
}
function myPluginUninstall() {
  // cleanup code
}

Asset Handling

CSS/JS are auto-minified and cached
Improved performance via smart cache

Activating/Deactivating

From Admin > Plugins:

Click Activate / Deactivate
Confirm action
Options: Activate, Deactivate, Uninstall, Update

🎨 Theme Management

Built‑In Themes

Default – responsive public theme
Admin – admin interface theme

Adding New Themes

Prepare your theme folder
Required structure:

my-theme/
├── infos.json        # metadata
├── layout.tpl        # main template
├── styles.css        # main CSS
├── scripts.js        # main JS
├── icon.png          # theme icon
├── functions.php     # optional
└── plugin.tpl        # plugin template

Copy to /theme/
Activate via Admin > Configuration > Theme selection

Theme Files

infos.json

{
  "name": "My Theme",
  "version": "1.0.0",
  "authorEmail": "you@domain.com",
  "authorWebsite": "https://your-site.com"
}

Available variables:

System:

{$site_name}, {$site_url}, {$theme_assets}, {$content}

Dynamic:

{$page_title}, {$page_content}, {$user_name}

Assets & Minification

Auto-minified CSS/JS
Optimized images
Smart cache

Recommended folder layout:

my-theme/
├── styles.css
├── scripts.js
├── icon.png
└── images/
    ├── logo.png
    └── background.jpg

Activating a Theme

From Admin > Themes:

Click Activate
Options: Activate, Preview, Uninstall, Details

💾 Backup & Restore

Included in backups:

System configuration
User data
Plugins and themes
Content files

Manual Backup

In Admin > Configuration > Backups (top-right):

Click Create Backup
Wait
Click Download

Restore

Upload backup ZIP to server

⚠️ Restore will overwrite current data — backup first and ensure version compatibility

Manage Backups

Options: Download, Delete backup files
Stored in /data/backups/
Old backups are rotated and compressed

🔄 Updates

Checking for Updates

Automatic daily checks
Admin notifications for updates and compatibility

Core Update Process

Auto-backup before updating
Verify plugin/theme compatibility
Download new version
Auto-install
Validate system post-update

If issues occur: rollback using backup, with detailed logs

Plugin Updates

Default plugins (ConfigManager, Users) are updated automatically:

Verify
Backup current version
Auto-update
Test

Theme Updates

Default themes (Default, Admin) update automatically:

Backup existing theme
Auto-update
Check appearance

🔒 Security

Authentication

Email/password login
Secure sessions
Brute-force protection
Auto logout after inactivity

Password Handling

bcrypt hashing
Password complexity rules
Secure recovery process

System Protection

Sensitive directories are protected
Validated file uploads
CSRF protection
Input validation and output escaping
Secure HTTP headers

Security Logs

Tracks system errors and suspicious activity

Best Practices

Use strong passwords
Change credentials regularly
Monitor logs
Backup regularly
Keep system updated
Disable debug mode in production
Use HTTPS
Limit login attempts

🔧 Troubleshooting

Common Issues

500 Server Error:

Check logs in /data/logs/
Enable debug temporarily
Verify folder permissions
Contact admin if needed

Blank Page:

Enable PHP logs
Disable plugins one-by-one
Check configuration
Restore a backup if needed

Login Problems:

Verify credentials
Clear browser cache
Check cookies
Contact admin

Debug Mode

Enable in ConfigManager to display:

Detailed PHP errors
SQL queries (if relevant)

Logs

Check relevant log types in /data/logs/

Emergency Recovery

Restore latest backup
Check config
Test features
Document issues

Support & Help

Use these before contacting support:

This documentation
System logs
Debug mode
Backups

Support Details:

CMS version (latest release or GitHub master)
PHP version
Problem description
Relevant error logs
Steps to reproduce

📞 Support & Contact

Need Help?

Before contacting support:

Check documentation
Review system logs
Use debug mode
Search community forums

Helpful Info to Provide

CMS version
PHP version
Description of the issue
Error logs
Reproduction steps

🎉 Conclusion

CMS 299Ko is simple, fast, and secure. This guide covers everything you need to use your CMS.

Remember:

Back up often
Keep updated
Monitor security logs
Test before production deployment

Enjoy using CMS 299Ko! 🚀