Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

issue #186 support multiple confluence sites #187

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

issue #186 support multiple confluence sites #187

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dcb2cb4
issue #186 support for multiple sites
pweissbrod-eh Sep 20, 2023
b1d593c
updating README to match configuration change
pweissbrod-eh Sep 20, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
61 changes: 61 additions & 0 deletions .idea/workspace.xml
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 4 additions & 0 deletions plugins/search-confluence-backend/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# @k-phoen/backstage-plugin-confluence-backend

## 0.1.00

- support for multiple confluence sites

## 0.0.14

### Patch Changes
Expand Down
29 changes: 15 additions & 14 deletions plugins/search-confluence-backend/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,20 +17,21 @@ Configure the plugin in `app-config.yaml`:
```yaml
# app-config.yaml
confluence:
# Confluence base URL for wiki API
# Typically: https://{org-name}.atlassian.net/wiki
wikiUrl: https://org-name.atlassian.net/wiki

# List of spaces to index
# See https://confluence.atlassian.com/conf59/spaces-792498593.html
spaces: [ENG]

# Authentication credentials towards Confluence API
auth:
username: ${CONFLUENCE_USERNAME}
# While Confluence supports BASIC authentication, using an API token is preferred.
# See: https://support.atlassian.com/atlassian-account/docs/manage-api-tokens-for-your-atlassian-account/
password: ${CONFLUENCE_PASSWORD}
sites:
# Confluence base URL for wiki API
# Typically: https://{org-name}.atlassian.net/wiki
- wikiUrl: https://org-name.atlassian.net/wiki

# List of spaces to index
# See https://confluence.atlassian.com/conf59/spaces-792498593.html
spaces: [ENG]

# Authentication credentials towards Confluence API
auth:
username: ${CONFLUENCE_USERNAME}
# While Confluence supports BASIC authentication, using an API token is preferred.
# See: https://support.atlassian.com/atlassian-account/docs/manage-api-tokens-for-your-atlassian-account/
password: ${CONFLUENCE_PASSWORD}
```

Enable Confluence documents indexing in the search engine:
Expand Down
54 changes: 31 additions & 23 deletions plugins/search-confluence-backend/config.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,31 +1,39 @@
export interface Config {
confluence: {
/**
* Confluence base URL for wiki API
* Typically: https://{org-name}.atlassian.net/wiki
* Collection of sites
* @visibility backend
*/
wikiUrl: string;
sites: [
{
/**
* Confluence base URL for wiki API
* Typically: https://{org-name}.atlassian.net/wiki
* @visibility backend
*/
wikiUrl: string;

/**
* Spaces to index
* @visibility backend
*/
spaces: string[];
/**
* Spaces to index
* @visibility backend
*/
spaces: string[];

/**
* @visibility backend
*/
auth: {
/**
* @visibility backend
*/
username: string;
/**
* @visibility backend
*/
auth: {
/**
* @visibility backend
*/
username: string;

/**
* @visibility secret
*/
password: string;
};
};
}
/**
* @visibility secret
*/
password: string;
}
}
]
}
};
Loading