docs: update README with requirement & new variable

This commit is contained in:
2025-10-08 20:55:40 +04:00
parent 4b1452ee79
commit 66de41b118
+55
View File
@@ -80,9 +80,45 @@ kaubuntu.re est une interface web responsive qui permet de consulter et recherch
└── README.adoc
----
== 📋 Prérequis
- 🐘 *PHP 7.4+* (recommandé : PHP 8.0+)
- 📦 *Extensions PHP requises :*
* `curl` - Pour les appels API vers PeerTube
* `json` - Pour le traitement des données JSON
* `intl` - Pour la gestion des dates internationales et traductions
* `mbstring` - Pour la manipulation des chaînes multi-octets
- 🌐 *Serveur web* : Apache ou Nginx
- 🔒 *HTTPS* : Requis pour les fonctionnalités PWA
=== Installation de l'extension intl
L'extension `intl` est nécessaire pour l'affichage des dates et heures de directs en plusieurs langues et fuseaux horaires.
[source,bash]
----
# Sur Ubuntu/Debian
sudo apt-get install php-intl
# Sur Fedora/RHEL/CentOS
sudo dnf install php-intl
# Puis redémarrer le serveur web
sudo systemctl restart apache2
# ou pour nginx avec php-fpm
sudo systemctl restart php8.3-fpm
----
Pour vérifier que l'extension est bien chargée :
[source,bash]
----
php -m | grep intl
----
== 🚀 Installation
. 📥 Clonez ce dépôt
. 📦 *Vérifiez les prérequis :* Assurez-vous que toutes les extensions PHP requises sont installées
. 🔧 Configurez votre serveur web (Apache, Nginx, etc.) pour pointer vers le répertoire racine
. 🔒 *Important :* Assurez-vous que votre serveur supporte HTTPS (requis pour PWA)
. 🛡️ *Configuration serveur sécurisée :* Copiez le fichier de configuration approprié depuis `conf/`
@@ -108,10 +144,29 @@ cp includes/config.local.php.sample includes/config.local.php
* Clé API
* Catégories à afficher
* Nombre de vidéos par section
* Fuseau horaire par défaut (`DEFAULT_TIMEZONE`)
* etc.
Les modifications apportées à `config.local.php` ne seront pas suivies par Git, ce qui vous permet de personnaliser votre instance sans affecter le code source principal.
=== Configuration du fuseau horaire
Par défaut, le site utilise le fuseau horaire `Indian/Reunion`. Vous pouvez le changer en définissant la constante `DEFAULT_TIMEZONE` dans votre `config.local.php` :
[source,php]
----
// Fuseau horaire par défaut pour l'affichage des dates
// Liste des fuseaux disponibles : https://www.php.net/manual/fr/timezones.php
define('DEFAULT_TIMEZONE', 'Indian/Reunion');
----
Cette configuration affecte :
- L'affichage des dates et heures sur tout le site
- Les annonces de directs à venir avec leurs horaires
- Le système de compte à rebours
- La gestion des fuseaux horaires multiples dans les annonces
== 🏷️ Personnalisation des catégories
Pour personnaliser les catégories affichées sur la page d'accueil, modifiez la constante `PRIORITY_CATEGORIES` dans votre fichier `config.local.php` :