Skip to content

Commit

Permalink
Clarify usage a bit more
Browse files Browse the repository at this point in the history
  • Loading branch information
goproslowyo committed Oct 3, 2023
1 parent 57d48fa commit abe63ee
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 2 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,12 @@ each page has basic templates attached to help document your exploitation.

glad you asked -- please check out the [usage instructions](USAGE.md).

you *will* need to set some things up so please read it.

easiest is to run the docker container if you have docker, otherwise run the python code.

sorry windows users, you might have to changes some paths. or just run the docker container.

## what else is needed?

maybe use notionx library over raw json + requests
Expand Down
22 changes: 20 additions & 2 deletions USAGE.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,14 +36,32 @@

![Get Hack The Box App Token](.img/htb-app-token.png)

---

By now you should have three things:

1. A Notion Internal Integration Secret

1. The database ID of your Notion DB

1. Your Hack The Box App Token

If don't have these items please review the above steps again.

- Install Poetry (you don't need poetry really, just requests, but poetry makes it easier if the project grows)

- `pip install --user poetry`

- `poetry run -- box-to-docs.py --help`
- `oetry run python box-to-docs.py --help`

or

- `pip install --user requests`

- `./box-to-docs.py`
- `python box-to-docs.py`

or

- `docker run -v /tmp:/tmp ghcr.io/goproslowyo/docsthebox:latest --help`

NOTE: Please adjust the paths accordingly if you're on windows.

0 comments on commit abe63ee

Please sign in to comment.