https://github.com/codelibs/fess-ds-atlassian
DataStore Crawler for JIRA/Confluence
https://github.com/codelibs/fess-ds-atlassian
Last synced: about 1 year ago
JSON representation
DataStore Crawler for JIRA/Confluence
- Host: GitHub
- URL: https://github.com/codelibs/fess-ds-atlassian
- Owner: codelibs
- License: apache-2.0
- Created: 2018-06-16T04:27:28.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2025-04-13T13:37:55.000Z (about 1 year ago)
- Last Synced: 2025-04-13T14:26:06.442Z (about 1 year ago)
- Language: Java
- Homepage:
- Size: 289 KB
- Stars: 7
- Watchers: 9
- Forks: 6
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
JIRA/Confluence Data Store for Fess
[](https://github.com/codelibs/fess-ds-atlassian/actions/workflows/maven.yml)
==========================
## Overview
JIRA/Confluence Data Store is an extension for Fess Data Store Crawling.
## Download
See [Maven Repository](https://repo1.maven.org/maven2/org/codelibs/fess/fess-ds-atlassian/).
## Installation
See [Plugin](https://fess.codelibs.org/13.3/admin/plugin-guide.html) of Administration guide.
## Getting Started
### Parameters
```
home=...
auth_type=...
oauth.consumer_key=OauthKey
oauth.private_key=...
oauth.secret=...
oauth.access_token=...
issue.jql=...
```
| Key | Value |
| --- | --- |
| home | URL of the Atlassian application(JIRA/Confluence) |
| auth_type | `oauth`(OAuth authentication) or `basic`(Basic authentication) |
| oauth.consumer\_key | Consumer key for OAuth (Usually `OauthKey`) |
| oauth.private\_key | Private key for OAuth |
| oauth.secret | Verification code for OAuth |
| oauth.access\_token | Access token for OAuth |
| basic.username | username of Atlassian account for Basic |
| basic.password | password of Atlassian account for Basic |
| issue.jql | [JQL](https://confluence.atlassian.com/jirasoftwarecloud/advanced-searching-764478330.html) for advanced search (JIRA only) (Optional) |
`oauth` or `basic` parameters are required.
### Scripts
#### JiraDataStore
```
url=issue.view_url
title=issue.summary
content=issue.description + issue.comments
last_modified=issue.last_modified
```
| Key | Value |
| --- | --- |
| issue.view\_url | URL of the issue. |
| issue.summary | Summary of the issue. |
| issue.description | Description of the issue. |
| issue.comments | Comments of the issue. |
| issue.last\_modified | Last modified date of the issue. |
#### ConfluenceDataStore
```
url=content.view_url
title=content.title
content=content.body + content.comments
last_modified=content.last_modified
```
| Key | Value |
| --- | --- |
| content.view\_url | URL of the content page. |
| content.title | Title of the content page. |
| content.body | Body of the content page. |
| content.comments | Comments of the content page. |
| content.last\_modified | Last modified date of the content. |