.github
.storybook
__mocks__
cypress
dev-test
functions
img
packages
netlify-cms
netlify-cms-app
netlify-cms-backend-azure
netlify-cms-backend-bitbucket
netlify-cms-backend-git-gateway
src
CHANGELOG.md
README.md
package.json
webpack.config.js
netlify-cms-backend-github
netlify-cms-backend-gitlab
netlify-cms-backend-proxy
netlify-cms-backend-test
netlify-cms-core
netlify-cms-default-exports
netlify-cms-editor-component-image
netlify-cms-lib-auth
netlify-cms-lib-util
netlify-cms-lib-widgets
netlify-cms-locales
netlify-cms-media-library-cloudinary
netlify-cms-media-library-uploadcare
netlify-cms-proxy-server
netlify-cms-ui-default
netlify-cms-widget-boolean
netlify-cms-widget-code
netlify-cms-widget-colorstring
netlify-cms-widget-date
netlify-cms-widget-datetime
netlify-cms-widget-file
netlify-cms-widget-image
netlify-cms-widget-list
netlify-cms-widget-map
netlify-cms-widget-markdown
netlify-cms-widget-number
netlify-cms-widget-object
netlify-cms-widget-relation
netlify-cms-widget-select
netlify-cms-widget-string
netlify-cms-widget-text
scripts
website
.all-contributorsrc
.editorconfig
.eslintrc.js
.gitattributes
.gitignore
.nvmrc
.prettierignore
.prettierrc
.stylelintrc
.vale.ini
CHANGELOG.md
CODE_OF_CONDUCT.md
CONTRIBUTING.md
LICENSE
README.md
babel.config.js
cms.png
commitlint.config.js
cypress.json
jest.config.js
lerna.json
netlify.toml
package.json
renovate.json
setupTestFramework.js
tsconfig.json
yarn.lock
27 lines
1.9 KiB
Markdown
27 lines
1.9 KiB
Markdown
# Git Gateway
|
|
|
|
Netlify's [gateway](https://github.com/netlify/git-gateway) to hosted git APIs.
|
|
|
|
## Code structure
|
|
|
|
`Implementation` for [File Management System API](https://github.com/netlify/netlify-cms/tree/master/packages/netlify-cms-lib-util/README.md) based on `Api`.
|
|
|
|
`Api` and `Implementation` from backend-[github](https://github.com/netlify/netlify-cms/tree/master/packages/netlify-cms-backend-github/README.md)/[gitlab](https://github.com/netlify/netlify-cms/tree/master/packages/netlify-cms-backend-gitlab/README.md)/[bitbacket](https://github.com/netlify/netlify-cms/tree/master/packages/netlify-cms-backend-bitbacket/README.md) extended with Netlify-specific `LargeMedia(LFS)` and `JWT` auth.
|
|
|
|
`AuthenticationPage` - uses [lib-auth](https://github.com/netlify/netlify-cms/tree/master/packages/netlify-cms-lib-auth/README.md) and implements Netlify Identity authentication flow.
|
|
|
|
Look at tests or types for more info.
|
|
|
|
## Debugging
|
|
|
|
When debugging the CMS with Git Gateway you must:
|
|
|
|
1. Have a Netlify site with [Git Gateway](https://docs.netlify.com/visitor-access/git-gateway/) and [Netlify Identity](https://docs.netlify.com/visitor-access/identity/) enabled. An easy way to create such a site is to use a [template](https://www.netlifycms.org/docs/start-with-a-template/), for example the [Gatsby template](https://app.netlify.com/start/deploy?repository=https://github.com/AustinGreen/gatsby-starter-netlify-cms&stack=cms)
|
|
2. Tell the CMS the URL of your Netlify site using a local storage item. To do so:
|
|
|
|
1. Open `http://localhost:8080/` in the browser
|
|
2. Write the below command and press enter: `localStorage.setItem('netlifySiteURL', 'https://yourwebsiteurl.netlify.app/')`
|
|
3. To be sure, you can run this command as well: `localStorage.getItem('netlifySiteURL')`
|
|
4. Refresh the page
|
|
5. You should be able to log in via your Netlify Identity email/password
|