Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Include clearer configuration instructions for Netlify users #312

Open
djmtype opened this issue Jan 26, 2025 · 1 comment
Open

Include clearer configuration instructions for Netlify users #312

djmtype opened this issue Jan 26, 2025 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@djmtype
Copy link

djmtype commented Jan 26, 2025

Historically, I had always used Netlify Identity before NetlifyCMS became Decap when the backend was set to git-gateway.

And so I thought all the configuration in Netlify's UI would be handled under its Identity [https://app.netlify.com/sites/[project-name]/configuration/identity#content] settings rather than Access & Security [https://app.netlify.com/sites/[project-name]/configuration/access#content] settings when assigning Sveltia's configuration backend to something other than git-gateway, since Sveltia doesn't use it for performance reasons. Therefore, I'm using github for oAuth.

I discovered it's actually much simpler if you're already using Netlify to host Sveltia. There's no need to install Sveltia's oAuth package.

These links guided me towards success in order to set up a Github oAuth with Netlify:

@kyoshino
Copy link
Member

I think it’s already clear that you don’t need Sveltia’s OAuth client if you have already used Netlify/Decap CMS with the GitHub or GitLab backend.

https://github.com/sveltia/sveltia-cms?tab=readme-ov-file#migration

Have a look at the compatibility info above first. If you’re already using Netlify/Decap CMS with the GitHub or GitLab backend and don’t have any unsupported features like custom widgets or nested collections, migrating to Sveltia CMS is super easy — it works as a drop-in replacement.

https://github.com/sveltia/sveltia-cms?tab=readme-ov-file#migrating-from-git-gateway-backend

Sveltia CMS does not support the Git Gateway backend due to performance limitations. If you don’t care about user management with Netlify Identity, you can use the GitHub or GitLab backend instead. Make sure you install an OAuth client on GitHub or GitLab in addition to updating your configuration file. As noted in the document, Netlify is still able to facilitate the auth flow.

https://github.com/sveltia/sveltia-cms-auth?tab=readme-ov-file#sveltia-cms-authenticator

You don’t have to use it if you previously had Netlify/Decap CMS and your site is still being deployed to Netlify or if you have already used another 3rd party OAuth client.

But I understand that the overall steps are not clear, partly because the Netlify/Decap doc sucks. When we launch the 1.0 release, we will provide documentation with more detailed instructions.

@kyoshino kyoshino added the documentation Improvements or additions to documentation label Jan 26, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants