Confluence
Connect Confluence to your preprocessing pipeline, and use the Unstructured CLI or Python to batch process all your spaces and pages and store structured outputs locally on your filesystem.
The requirements are as follows.
-
A Confluence Cloud account or Confluence Data Center installation.
-
The site URL for your Confluence Cloud account or Confluence Data Center installation.
-
A user in your Confluence Cloud account or Confluence Data Center installation.
-
The user must have the correct permissions in your Conflunce Cloud account or Confluence Data Center installation to access the target spaces and pages.
-
One of the following:
- For Confluence Cloud or Confluence Data Center, the target user’s name or email address, and password. Change a Confluence Cloud user’s password. Change a Confluence Data Center user’s password.
- For Confluence Cloud only, the target user’s name or email address, and API token. Create an API token.
- For Confluence Data Center only, the target user’s personal access token (PAT). Create a PAT.
-
Optionally, the names of the specific spaces in the Confluence instance to access.
The following video provides related setup information for Confluence Cloud:
The Confluence connector dependencies:
You might also need to install additional dependencies, depending on your needs. Learn more.
The following environment variables:
-
CONFLUENCE_URL
- The target Confluence site’s URL, represented by--url
(CLI) orurl
(Python). -
One of the following:
- For API token authentication:
CONFLUENCE_USERNAME
andCONFLUENCE_TOKEN
- The name or email address,and API token of the target Confluence user, represented by--username
(CLI) orusername
(Python) and--token
(CLI) ortoken
(Python), respectively. - For personal access token (PAT) authentication:
CONFLUENCE_TOKEN
- The PAT for the target Confluence user, represented by--token
(CLI) ortoken
(Python). - For password authentication:
CONFLUENCE_USERNAME
andCONFLUENCE_PASSWORD
- The name or email address, and password of the target Confluence user, represented by--username
(CLI) orusername
(Python) and--password
(CLI) orpassword
(Python), respectively.
- For API token authentication:
Additional settings include:
--spaces
(CLI) orspaces
(Python): Optionally, the list of the names of the specific spaces to access, expressed as a comma-separated list of strings (CLI) or an array of strings (Python), with each string representing a space’s name. The default is no specific spaces, if not otherwise specified.--max-num-of-spaces
(CLI) ormax_num_of_spaces
(Python): Optionally, the maximum number of spaces to access, expressed as an integer. The default value is500
if not otherwise specified.--max-num-of-docs-from-each-space
(CLI) ormax_num_of_docs_from_each_space
(Python): Optionally, the maximum number of documents to access from each space, expressed as an integer. The default value is100
if not otherwise specified.--cloud
or--no-cloud
(CLI) orcloud
(Python): Optionally, whether to use Confluence Cloud (--cloud
for CLI orcloud=True
for Python). The default is--no-cloud
(CLI) orcloud=False
(Python) if not otherwise specified.
These environment variables:
UNSTRUCTURED_API_KEY
- Your Unstructured API key value.UNSTRUCTURED_API_URL
- Your Unstructured API URL.
Now call the Unstructured CLI or Python SDK. The destination connector can be any of the ones supported. This example uses the local destination connector:
Was this page helpful?