docs: Update Docs: Backends “bitbucket-backend” (#3910)
This commit is contained in:
@ -1,9 +1,8 @@
|
|||||||
---
|
---
|
||||||
title: Bitbucket
|
title: Bitbucket
|
||||||
weight: 20
|
|
||||||
group: backends
|
group: backends
|
||||||
|
weight: 20
|
||||||
---
|
---
|
||||||
|
|
||||||
For repositories stored on Bitbucket, the `bitbucket` backend allows CMS users to log in directly with their Bitbucket account. Note that all users must have write access to your content repository for this to work.
|
For repositories stored on Bitbucket, the `bitbucket` backend allows CMS users to log in directly with their Bitbucket account. Note that all users must have write access to your content repository for this to work.
|
||||||
|
|
||||||
To enable it:
|
To enable it:
|
||||||
@ -11,26 +10,26 @@ To enable it:
|
|||||||
1. Follow the authentication provider setup steps in the [Netlify docs](https://www.netlify.com/docs/authentication-providers/#using-an-authentication-provider).
|
1. Follow the authentication provider setup steps in the [Netlify docs](https://www.netlify.com/docs/authentication-providers/#using-an-authentication-provider).
|
||||||
2. Add the following lines to your Netlify CMS `config.yml` file:
|
2. Add the following lines to your Netlify CMS `config.yml` file:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
backend:
|
backend:
|
||||||
name: bitbucket
|
name: bitbucket
|
||||||
repo: owner-name/repo-name # Path to your Bitbucket repository
|
repo: owner-name/repo-name # Path to your Bitbucket repository
|
||||||
```
|
```
|
||||||
|
|
||||||
### Client-Side Implicit Grant (Bitbucket)
|
### Client-Side Implicit Grant (Bitbucket)
|
||||||
|
|
||||||
With Bitbucket's Implicit Grant, users can authenticate with Bitbucket directly from the client. To do this:
|
With Bitbucket's Implicit Grant, users can authenticate with Bitbucket directly from the client. To do this:
|
||||||
|
|
||||||
1. Follow the [Atlassian docs](https://confluence.atlassian.com/bitbucket/oauth-on-bitbucket-cloud-238027431.html) to create an OAuth consumer. Make sure you allow `Account/Read` and `Repository/Write` permissions. For the **Callback URL**, enter the address where you access Netlify CMS, for example, `https://www.mysite.com/admin/`.
|
1. Follow the [Atlassian docs](https://confluence.atlassian.com/bitbucket/oauth-on-bitbucket-cloud-238027431.html) to create an OAuth consumer. Make sure you allow `Account/Read` and `Repository/Write` permissions. To use the [Editorial Workflow](https://www.netlifycms.org/docs/configuration-options/#publish-mode), allow `PullRequests/Write` permissions. For the **Callback URL**, enter the address where you access Netlify CMS, for example, `https://www.mysite.com/admin/`.
|
||||||
2. Bitbucket gives you a **Key**. Copy this Key and enter it in your Netlify CMS `config.yml` file, along with the following settings:
|
2. Bitbucket gives you a **Key**. Copy this Key and enter it in your Netlify CMS `config.yml` file, along with the following settings:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
backend:
|
backend:
|
||||||
name: bitbucket
|
name: bitbucket
|
||||||
repo: owner-name/repo-name
|
repo: owner-name/repo-name
|
||||||
branch: default
|
branch: default
|
||||||
auth_type: implicit
|
auth_type: implicit
|
||||||
app_id: # The Key from your Bitbucket settings
|
app_id: # The Key from your Bitbucket settings
|
||||||
```
|
```
|
||||||
|
|
||||||
**Warning:** With Bitbucket implicit grant, the authentication is valid for 1 hour only. After that, the user has to login again, **which can lead to data loss** if the expiration occurs while content is being edited.
|
**Warning:** With Bitbucket implicit grant, the authentication is valid for 1 hour only. After that, the user has to login again, **which can lead to data loss** if the expiration occurs while content is being edited.
|
||||||
|
Reference in New Issue
Block a user