Skip to content

Docs are incomplete when using Netlify for auth but not hosting (using Github Backend) #66

Open
@daniel-keller

Description

@daniel-keller

Decap CMS docs provide instructions for setting up the Github backend and explains why a netlify site, even if unused for hosting, is necessary for authentication. When providing instructions for this setup the docs direct devs to the Netlify docs (paragraph 3, step 1.). The Netlify docs assume Netlify is the hosting service and so a crucial step is not provided to devs who want to host their site on Github Pages (and I assume other services but I haven't confirmed this) but use Netlify for auth services.

The missing steps are as follows:

  1. Change the CMS site_domain configuration to the domain of the Netlify dummy site
  2. Register your Github Pages' site domain name within Netlify's "Domain Management" settings.

Without these steps your login into Decap on your Github Pages site will result in a "Not Found" message.

Sources are the Netlify Discord and this blog post

Could you update the docs to include these steps?

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions