keystone-classic icon indicating copy to clipboard operation
keystone-classic copied to clipboard

What does the headless config option do?

Open stennie opened this issue 6 years ago • 1 comments

The headless config option has sparse documentation and no apparent test cases. It would be helpful to have more information on the intended use case(s).

From: https://keystonejs.com/documentation/configuration:

You can disable the Admin UI by setting the headless option to true.

This will allow you to use keystone.start() or keystone.set('routes', aRouter.) without Keystone creating route bindings for the Admin UI routes under /keystone.

Expected behavior

The headless option should disable Keystone Admin UI routes but leave Keystone API routes available for use as a headless CMS.

Actual/Current behavior

The headless option disables all keystone routes, including /keystone/api.

If this is the expected outcome, the documentation needs to be clearer. Otherwise this would be a bug.

Environment

Software Version
Keystone 4.0.0

stennie avatar Sep 26 '18 10:09 stennie