HackTricks-wiki/hacktricks

What it is

The HackTricks repository README is mostly instructions for running the wiki offline. It is built with mdbook and served at http://localhost:3337. Each translation lives on its own git branch, and master is the English one. The page lists 16 other language codes: af, de, el, es, fr, hi, it, ja, ko, pl, pt, sr, sw, tr, uk and zh. The rest of the page is sponsor blurbs, which add no technical content.

Preconditions

• Docker, with the linux/amd64 platform flag the command sets.
• Outbound access to github.com, because the container runs ssh-keyscan and git pull on start.
• The first build needs patience. The page says the book can take up to 5 minutes before it is available.

What to do

Clone the repo, pick a language branch, and start the container:

git clone https://github.com/HackTricks-wiki/hacktricks
export HT_LANG="master" # Leave master for English
docker run -d --rm --platform linux/amd64 -p 3337:3000 --name hacktricks -v $(pwd)/hacktricks:/app ghcr.io/hacktricks-wiki/hacktricks-cloud/translator-image bash -c "mkdir -p ~/.ssh && ssh-keyscan -H github.com >> ~/.ssh/known_hosts && cd /app && git config --global --add safe.directory /app && git checkout $HT_LANG && git pull && MDBOOK_PREPROCESSOR__HACKTRICKS__ENV=dev mdbook serve --hostname 0.0.0.0"

With Docker Compose, run this from the repo root:

docker compose up

Compose uses the bundled docker-compose.yml and serves whichever branch is checked out on the host, with live reload. To change language under Compose, check out the language branch before starting the service.

Caveats

• The container image is ghcr.io/hacktricks-wiki/hacktricks-cloud/translator-image, which is the image the README names for this repo.
• The container runs git pull on start, so content changes between runs.
• The README does not describe the wiki's technique coverage, so the page gives no basis for judging content quality or how current it is.