Child pages
  • Guide to the Feature Showcase - Troubleshooting

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Introduction

Excerpt

If you have problems creating a new Feature Showcase entry, use this document to troubleshoot it.


Note
titleNote:

To test your new Feature Showcase item, log in to WHM as the root user. Then, navigate to https://hostname:2087//scripts3/feature_showcase, where hostname is your hostname.

Log file

The system sends errors to the /usr/local/cpanel/logs/error_log log file.

For example, an error could look like this:

Code Block
linenumberstrue
warn [whostmgr3] The following fatal warnings were in the warning_1 driver:
     The meta->first_appears_in field is missing or invalid.
     You must define either enable and disable overrides or a handle_showcase_submission override for interactive feature showcases.
     The meta->last_appears_in field is missing or invalid.
     The meta->meta_version field is missing or invalid.
The warning_1 driver will not be loaded.

warn [whostmgr10] The following non-fatal warnings were in the warning_1 driver:
     The spec_version field is missing or invalid. The system will assume a v2 driver.
The warning_1 driver will still function, but possibly not as intended.

Useful commands

Note
titleNote:

Some Feature Showcase items, such as AutoSSL, depend on other criteria that will appear in the driver’s META module’s showcase() method.

You can use these commands to find and troubleshoot issues:

CommandDescription


Code Block
languagebash
ls /var/cpanel/activate/features


Displays dismissed Feature Showcase items.


Code Block
languagebash
linenumberstrue
cd /var/cpanel/activate/features
rm -rf name


Displays a specific, dismissed Feature Showcase item.

Note
titleNote:

In this example, name is the name of the feature to display.



Expand
titleClick to view...


Code Block
languagebash
perl -MJSON -e '$j;$/=undef;$j=<>;$d=JSON->new->allow_nonref;print $d->pretty->encode($d->decode($j));'  < draftdrivername.json



Check JSON syntax and clean up formatting.

Note
titleNote:

In this example, draftdrivername.json is the name of the driver in progress.



Expand
titleClick to view...


Code Block
languagebash
perl -MJSON -e '$j;$/=undef;$j=<>;$d=JSON->new->allow_nonref;print $d->pretty->encode($d->decode($j));'  < drivername.json > yourfinaldriver.json




Output a command to a file.

Note
titleNote:

In this example, draftdrivername.json is the name of the driver in progress and drivername.json is the driver's final name.



Expand
titleClick to view...


Code Block
:%!perl -MJSON -e '$j;$/=undef;$j=<>;$d=JSON->new->allow_nonref;print $d->pretty->encode($d->decode($j));'



Validate JSON while using the vim text editor.


Code Block
rm -rf /var/cpanel/activate/features


View dismissed Feature Showcase items or items that the system has not displayed on a new installation.