From abe63ee6b4a80133d92010fe39994419edc21734 Mon Sep 17 00:00:00 2001 From: GoProSlowYo <68455785+goproslowyo@users.noreply.github.com> Date: Tue, 3 Oct 2023 01:48:55 -0700 Subject: [PATCH] Clarify usage a bit more --- README.md | 6 ++++++ USAGE.md | 22 ++++++++++++++++++++-- 2 files changed, 26 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index db75356..a507750 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/USAGE.md b/USAGE.md index 5e02001..0d88630 100644 --- a/USAGE.md +++ b/USAGE.md @@ -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.