Skip to content

PascalCTF/Training-Wiki

Repository files navigation

Training Wiki

Training Wiki logo

Wiki/knowledge base built with Docusaurus with search powered by Typesense DocSearch.

Local setup

npm ci
npm run start

Server setup

  1. Create the .env file starting from .env.example and set the variables (especially ROOT_PASSWORD, TYPESENSE_ADMIN_API_KEY, TYPESENSE_SEARCH_API_KEY).

  2. Start the stack:

docker compose up -d --build
  1. Create the search-only API key (once):
docker compose --profile init run --rm typesense-init
  1. Index the docs into Typesense (required for getting results):
docker compose --profile scraper run --rm scraper

Optional: keep a watcher running and trigger re-index when needed:

docker compose up -d scraper-watcher

# trigger a re-index
docker compose exec wiki sh -lc 'touch /trigger/run'

Note: TYPESENSE_* variables are read at build time; if you change them, rebuild (--build).

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors