I. Prérequis et avertissements de sécurité▲
L'exemple fourni est une base de démonstration, sans authentification ni contrôle d'accès. Il ne vérifie pas les données reçues ni ne protège les ressources contre les accès non autorisés. Pour une utilisation en production, il est indispensable de revoir la gestion de la sécurité, les droits d'accès et la validation des données.
II. Configuration de l'environnement▲
Dans le répertoire racine du projet, copiez le fichier .env.example vers .env :
cp .env.example .env
Modifiez les variables d'environnement selon votre environnement (voir ci-dessous pour les plus importantes).
III. Installation via Docker (recommandée)▲
III-A. Téléchargement de l'exemple▲
cd /my/php-laravel/project
curl --output PHP.Laravel.Example.zip --location https://github.com/ONLYOFFICE/document-server-integration/releases/latest/download/PHP.Laravel.Example.zip
unzip PHP.Laravel.Example.zip
cd "PHP Laravel Example"III-B. Configuration de la clé JWT▲
Dans le fichier .env, modifiez la variable DOCUMENT_SERVER_JWT_SECRET pour y mettre une clé secrète JWT personnalisée. Elle sera utilisée pour la signature des requêtes.
III-C. Lancement des conteneurs Docker▲
Option 1 :
make compose-start
Option 2 :
docker compose build && docker compose up -d
III-D. Installation des dépendances▲
docker compose exec example composer install
&& docker compose exec node npm install
&& docker compose exec node npm run buildIII-E. Génération de la clé de l'application Laravel▲
docker compose exec example php artisan key:generate
Vous pouvez maintenant accéder à l'application via http://localhost.
Pour arrêter les conteneurs :
make compose-stop
ou
docker compose down
IV. Installation locale (sans Docker)▲
IV-A. Prérequis▲
PHP ≥ 8.2
Node.js (v16 ou plus)
Composer
NPM
Laravel 11
IV-B. Téléchargement de l'exemple▲
cd /path/to/my/projects
curl --output PHP.Laravel.Example.zip --location https://github.com/ONLYOFFICE/document-server-integration/releases/latest/download/PHP.Laravel.Example.zip
unzip PHP.Laravel.Example.zip
cd "PHP Laravel Example"IV-C. Installation▲
composer install
Installer les dépendances frontales de l'application et construire les actifs :
npm install && npm run build
Générer une clé d'application pour l'instance Laravel :
php artisan key:generate
L'application est maintenant disponible à l'adresse définie par votre serveur local.
V. Configuration des variables d'environnement▲
Voici les variables essentielles à définir dans le fichier .env :
|
Nom |
Description |
Exemple |
|---|---|---|
|
USER |
Nom d'utilisateur système |
user |
|
UID |
ID utilisateur système |
1000 |
|
DOCUMENT_STORAGE_PUBLIC_URL |
URL publique de l'application |
http://localhost |
|
DOCUMENT_STORAGE_PRIVATE_URL |
URL interne utilisée par ONLYOFFICE Docs |
http://proxy |
|
DOCUMENT_SERVER_PUBLIC_URL |
URL publique du serveur ONLYOFFICE Docs |
http://localhost:8080 |
|
DOCUMENT_SERVER_PRIVATE_URL |
URL privée pour ONLYOFFICE Docs |
http://proxy:8080 |
|
DOCUMENT_SERVER_JWT_SECRET |
Clé secrète JWT |
votre-cle-secrete |
VI. Accessibilité réseau▲
Si ONLYOFFICE Docs et l'exemple Laravel sont installés sur des machines différentes :
- assurez-vous que le serveur Laravel est accessible depuis ONLYOFFICE Docs via l'adresse définie dans DOCUMENT_STORAGE_PRIVATE_URL ;
- et inversement, que Laravel peut joindre le serveur ONLYOFFICE via DOCUMENT_SERVER_PRIVATE_URL.
VII. En cas de problème▲
Consultez la documentation officielle de Laravel, si vous rencontrez des erreurs lors de l'installation ou de l'exécution de l'application.
Ce tutoriel constitue une base pour intégrer les éditeurs ONLYOFFICE dans un environnement Laravel. Avant tout déploiement en production, il est essentiel d'y ajouter une authentification sécurisée, une gestion des autorisations, des validations de données et des journaux d'activité.
VIII. Ressources utiles▲
IX. Remerciements Developpez.com▲
Nous tenons à remercier Malick pour la mise au gabarit.