Skip to content

Commit

Permalink
update descriptions
Browse files Browse the repository at this point in the history
  • Loading branch information
yugoslavskiy committed Jul 11, 2021
1 parent 5103d64 commit 71b8173
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 6 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ TheHive Case Templates could be found in `docs/thehive_templates` directory and

## Data source of the ATC framework

ATC RE&CT project plays a role of data source for the [Atomic Threat Coverage](https://github.com/atc-project/atomic-threat-coverage) framework, that uses it to generate Markdown and Confluence knowledge bases, ATT&CK Navigator profiles, Elasticsearch indexes and [other](https://github.com/atc-project/atomic-threat-coverage#how-it-works) analytics.
ATC RE&CT project plays a role of data source for the [Atomic Threat Coverage](https://github.com/atc-project/atomic-threat-coverage) framework, that uses it to generate Markdown and Confluence knowledge bases, ATT&CK Navigator layers, Elasticsearch indexes and [other](https://github.com/atc-project/atomic-threat-coverage#how-it-works) analytics.

Originally analytics related to Incident Response were part of the ATC, but we decided to move it into a separate project to make it easier to maintain and provide an option for integration with other projects in this area.

Expand All @@ -139,7 +139,7 @@ Originally analytics related to Incident Response were part of the ATC, but we d
python3 main.py --thehive
python3 main.py -NAV
```
You will find the outcome in the `docs` directory and Confluence pages (according to the configuration). At the moment, RE&CT Navigator profile could be opened only in the [customized application](https://github.com/atc-project/react-navigator).
You will find the outcome in the `docs` directory and Confluence pages (according to the configuration). Also, the RE&CT Navigator layer could be opened only in the [customized application](https://github.com/atc-project/react-navigator).
5. Generate your own (private) website with your analytics, using [mkdocs](https://www.mkdocs.org/):
```
Expand Down
2 changes: 1 addition & 1 deletion README_RU.md
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,7 @@ Response Playbook (Сценарий Реагирования) — это пла
python3 main.py --thehive
python3 main.py -NAV
```
Результат будет доступен в директории `docs` и страницах Confluence (в соответствии с конфигурацией). На текущий момент, профиль RE&CT Navigator можно открыть только в [кастомизированном приложении](https://github.com/atc-project/react-navigator).
Результат будет доступен в директории `docs` и страницах Confluence (в соответствии с конфигурацией). Профиль RE&CT Navigator можно открыть только в [кастомизированном приложении](https://github.com/atc-project/react-navigator).
5. Сгенерируйте ваш собственный (приватный) веб-сайт с вашей собственной аналитикой, используя [mkdocs](https://www.mkdocs.org/):
```
Expand Down
8 changes: 5 additions & 3 deletions main.py
Original file line number Diff line number Diff line change
Expand Up @@ -61,9 +61,11 @@
help="Build initial pages or directories " +
"depending on the export type")
parser.add_argument('-cpat', '--confluence-pat', action='store',
help='Personal Access Token used to export analytics \
to Confluence. Confluence Username and passsword \
promted if this parameter is not provided')
help='Personal Access Token used to export analytics to \
the Confluence. You can also use CONFLUENCE_PAT \
environment variable instead of the argument. If this \
parameter or the variable are not provided, Confluence \
username and password will be requested.')

args = parser.parse_args()

Expand Down

0 comments on commit 71b8173

Please sign in to comment.