Skip to content

Commit 02c0f23

Browse files
authored
update docs how to authenticate (#50)
1 parent 0199c65 commit 02c0f23

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -193,12 +193,18 @@ You can authenticate with the Confluence API using the following methods:
193193

194194
#### Personal Access Token (PAT)
195195

196+
> Info: PAT is only available for self-hosted Confluence.
197+
196198
The plugin uses `CONFLUENCE_PAT` to authenticate with the Confluence API via token. You can set this value in the environment variables.
197199

198-
#### Basic Authentication
200+
To read more about how to create a PAT, please refer to the [official documentation](https://confluence.atlassian.com/enterprise/using-personal-access-tokens-1026032365.html#UsingPersonalAccessTokens-CreatingPATsintheapplication).
201+
202+
#### API token
199203

200204
The plugin uses `CONFLUENCE_USERNAME` and `CONFLUENCE_PASSWORD` to authenticate with the Confluence API via `basic auth`. You can set these values in the environment variables.
201205

206+
To read more about how to create an API token, please refer to the [official documentation](https://support.atlassian.com/atlassian-account/docs/manage-api-tokens-for-your-atlassian-account).
207+
202208
> Info: The order above is the priority. If you set both, the plugin will use the PAT.
203209

204210
### Disable this plugin at runtime

0 commit comments

Comments
 (0)