Installer Roadiz Standard Edition

Pour les nouveaux projets Roadiz peut être facilement configuré en utilisant la commande create-project.

# Create a new Roadiz project
composer create-project roadiz/standard-edition my-website
cd my-website
# Create a new theme for your project and link assets
# path in public folder
bin/roadiz themes:generate --symlink --relative FooBar
# Go to your theme
cd themes/FooBarTheme
# Install JS dependencies with npm or Yarn
yarn # or npm install
# Build your new theme assets
yarn build # or npm run build

Composer will prompt you if you want to can versioning history. Choose the default answer no as we definitely want to replace standard-edition Git with our own versioning. Then you will be able to customize every files in your projects and save them using Git, not only your theme. Of course we added a default .gitignore file to prevent your configuration setting and entry points to be committed in your Git history. That way you can have different configuration on development and on your production server without bothering about merge conflicts.

Do not forget to add the following lines to your app/AppKernel.php file once you generated a new theme:

// app/AppKernel.php
public function register(\Pimple\Container $container)
{
    parent::register($container);
    /*
     * Add your own service providers.
     */
    $container->register(new \Themes\FooBarTheme\Services\FooBarThemeServiceProvider());
}

Note

Pour les utilisateurs de Windows, la commande bin/roadiz themes:generate --symlink --relative FooBar peut être utilisée sans l’option --relative pour créer des liens symboliques absolus. Vous pouvez même installer les ressources de votre thème en tant que hard copy sans option --symlink. Assurez-vous d’exécuter régulièrement bin/roadiz themes:assets:install FooBar lorsque vous utilisez le mode hard copy pour mettre à jour vos ressources. Vous devriez utiliser des liens symboliques dès que possible pour éviter les problèmes de mise à jour.

Travailler avec les environnements Roadiz

Environnement d’installation

Une fois que vous avez réussi à télécharger Roadiz et ses dépendances, vous devrez configurer sa base de données et toutes les informations nécessaires pour démarrer votre site Web.

Comme toutes les applications Symfony, Roadiz fonctionne en utilisant des environnements. Par défaut, il y a un environnement production qui est géré par le point d’entrée index.php. En ce moment, si vous essayez de vous connecter à votre nouveau site web Roadiz, vous obtiendrez une erreur car nous n’avons pas installé sa base de données et ses données essentielles.

Pour pouvoir utiliser l’interface d’installation de Roadiz installation, vous devrez appeler le point d’entrée install.php. Ce fichier a été généré lorsque vous avez exécuté la commande composer install. Cet environnement sera accessible à l’adresse http://mywebsite.com/install.php.

Pour des raisons de sécurité, nous avons activé un filtrage d’IP pour ce point d’entrée, vous pouvez ajouter votre propre adresse IP dans le tableau suivant : array('127. .0.1', 'fe80::1', '::1', ':ffff:127. .0.1', '::ffff:127.0.0.1'). Ce filtrage IP est très important si vous travaillez sur un serveur public, personne à part vous ne devrait pouvoir accéder au point d’entrée install.

À la fin du processus d’installation, vous serez invité à supprimer le fichier install.php et à vous connecter à l’URL finale de votre site.

Environnement de développement

L’environnement de production de Roadiz n’est pas conçu pour développer vos propres thèmes et étendre les fonctionnalités du back-office. De la même manière que l’environnement install, nous avons préparé un environnement dev pour désactiver la mise en cache des ressources et activer les fonctionnalités de débogage. Vous trouverez un fichier dev.php à la racine de votre site web qui a été généré à la commande composer install. De la même manière que pour install.php, vous devrez ajouter votre propre adresse IP pour filtrer qui peut accéder à votre environnement dev.

Environnement de prévisualisation

L’environnement preview n’est pas un vrai car il ajoute seulement un drapeau au noyau de Roadiz pour permettre aux utilisateurs du back-office de voir les nœuds non publiés. Par défaut, il est disponible en utilisant le point d’entrée preview.php, sauf si vous décidez de le supprimer.

Note

Since Roadiz v1.6, preview environment is deprecated in favor of ?_preview=1 query param which allows previewing in any environment, especially for API responses (JSON).

Environnement de production

C’est le point d’entrée index.php par défaut qui sera appelé par tous vos visiteurs. Il n’y a pas de restriction à ce sujet et il lancera l’application Roadiz en utilisant les politiques de mise en cache les plus fortes. Il n’est donc pas recommandé d’utiliser pour le développement (vous devrez vider les caches chaque fois que vous changez quelque chose dans le code).

Environnement pour le vidage du cache

L’environnement clear_cache est uniquement destiné à vider le cache Roadiz sans exécuter toute l’application. Il peut être utile si vous utilisez un cache op-code comme APC ou PHP natif OPcache. Ces caches spécials ne peuvent pas être purgées depuis utilitaires en ligne de commande, donc vous devez appeler un script PHP depuis votre navigateur ou via curl pour les vider. Comme l’environnement install et dev, clear_cache.php est restreint par IP pour ne pas permettre à tout le monde de vider vos caches applicatifs. Vous devrez ajouter votre propre adresse IP pour filtrer qui peut y accéder.