Skip to content
This repository has been archived by the owner on Apr 27, 2021. It is now read-only.

Latest commit

 

History

History
107 lines (63 loc) · 4.63 KB

Troubleshooting.md

File metadata and controls

107 lines (63 loc) · 4.63 KB
Raw

Troubleshooting

Checklist

It's a good idea to check the following things when anything goes wrong.

For Any CMS

  1. Run php artisan vendor:publish to make sure you have all the required migrations and assets.
  2. Run php artisan cms:migrate to make sure any publish migrations for the CMS are applied.
  3. Run php artisan cms:menu:clear to force clearing out old menu data.

For CMSes using Models Module

  1. Run php artisan cms:models:clear to force clearing out old configurations.
  2. Run php artisan cms:models:show --keys to see which models are loaded.
  3. Run php artisan cms:models:show and browse through the configuration data to see if anything looks out of order.
    You can restrict the output to that for a specific model: cms:models:show <key>.

Issues

The CMS is slow

One way to speed up the CMS somewhat, is to cache menu data. You can do this by running php artisan cms:menu:cache.

If you are using the Models Module, make sure that you cache model configuration when not developing. You can do this by running php artisan cms:models:cache.
Further information on model configuration caching.

If caching is disabled, the CMS will analyze the database structure, model class files and parse configuration files, which can really slow things down as the amount of configured models increases.

Menu items or menu layout changes don't show up

Make sure the CMS menu configuration cache is cleared, using php artisan cms:menu:clear. It is easiest to leave the cache setting disabled while configuring the CMS.

Model configuration changes don't show up (Models Module)

Make sure the CMS model configuration cache is cleared.
You can clear the models cache by running php artisan cms:models:clear.

The base CMS URL (<base URL>/cms) fails to load (with a 404)

When running in a local development environment (using Laravel Valet or php artisan serve, for instance), be advised that some routes may not work depending on your public directory contents.

If you have a cms directory or file in Laravel's public/ path, then //<base URL>/cms/ may result in a 404, ignoring Laravel's routing entirely. The solution is to make sure the public directory contains no such content, or to change the base path for the CMS (using config key cms-core.route.prefix).

Note that this is not an issue with the CMS, and affects any Laravel routing where directory names in public match routes exactly.

The CMS theme style is broken or interactive components (such as date pickers) don't work

Make sure you have run php artisan vendor:publish after adding the CMS Service provider to the app.php (or module service providers to the cms-core.php) configuration file.

CMS assets may have been altered between versions, and vendor:publish will not overwrite the existing contents. Make sure to overwrite already published assets by adding the --force option:

php artisan vendor:publish --force --tag=assets --provider="Czim\CmsTheme\Providers\CmsThemeServiceProvider"

Be warned that forcing this will overwrite translation files published by the theme package. Omitting the --tag option will also cause the theme configuration file to be overwritten. If you'd rather only update the public directory assets, simply delete the public/_cms directory and run an unforced vendor:publish.

For more information on publishing assets, see the Laravel documentation

CMS Menu or model information is cached with errors, and Artisan commands are not available to clear the cache

Manually delete the following files, if they exist:

  • bootstrap/cache/cms_menu.php
  • bootstrap/cache/cms_model_information.php

Note that this is exactly the same fix for when a cached Laravel configuration cannot be normally cleared using artisan config:clear.

Helpful Artisan Commands

If you're encountering problems due to modules or configuration, keep the following Artisan commands in mind:

Core:

  • cms:migrate:status: check if CMS database migrations have all been run.
  • cms:modules:show: show currently loaded modules.
  • cms:menu:show: show currently loaded menu layout.
  • cms:menu:cache: write a fresh menu data cache file.
  • cms:menu:clear: clear cached menu data.

Models Module:

  • cms:models:cache: write a fresh model configuration cache file.
  • cms:models:clear: clear cached model configuration.
  • cms:models:show: show currently loaded and enriched model configuration.