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

Clarify that base_url should contain only hostname #2143

Merged
merged 1 commit into from
Mar 11, 2019

Conversation

maxgardner
Copy link
Contributor

If users include any path in their base_url, the postMessage does not work.

Summary

I had to troubleshoot for most of today trying to piece together why the postMessage operation was not executing correctly upon successful authentication through GitHub. I ended up finding an answer in this issue on a supported OAuth backend, and I felt the documentation could have been clearer that the base_url should contain only the site's hostname and no path.

In this case, the confusion was that I'm handling auth through an existing api that is located at https://example.com/api. So I had:

base_url: https://example.com/api
auth_endpoint: /auth

Once I changed this to

base_url: https://example.com
auth_endpoint: /api/auth

I got it working.

Test plan

Just a small text change.

A picture of a cute animal (not mandatory but encouraged)

If users include any path in their base_url, the postMessage does not work.
@netlify
Copy link

netlify bot commented Mar 7, 2019

Preview proposed changes to the CMS demo site in the link below:

Built with commit 879f27f

https://deploy-preview-2143--cms-demo.netlify.com

@netlify
Copy link

netlify bot commented Mar 7, 2019

Preview proposed changes to netlifycms.org in the link below:

Built with commit 879f27f

https://deploy-preview-2143--netlify-cms-www.netlify.com

@erquhart
Copy link
Contributor

Sorry this took so much of your time, and thanks for updating the docs so others don't have to do the same!

@erquhart erquhart merged commit 1261ec7 into decaporg:master Mar 11, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants