algolia / docsearch

:blue_book: The easiest way to add search to your documentation.
https://docsearch.algolia.com
MIT License
3.96k stars 383 forks source link

Run on your own guide for windows 10 #1177

Open kingabzpro opened 2 years ago

kingabzpro commented 2 years ago

Describe the problem

The docker dose not translate well into windows so I figure out ways to do for windows.

Describe the solution

  1. create API key and add * after your index as shown below👇 image
  2. copy newly created API and Application ID into .env
  3. convert the json file into text file either by jq -r tostring or use online tools. save it in config.txt
  4. install wsl2 and Ubuntu-> make ubuntu default. Install latest docker from docker hub.
  5. type wsl and use cd /mnt/c/your/directory/
  6. run the command docker run -it --env-file=.env -e "CONFIG=$(cat config.txt)" algolia/docsearch-scraper

Alternatives you've considered

It worked for me and If you have any question you can ask me on Docsearch Discord server.

shortcuts commented 2 years ago

Hey, thanks for letting us know.

If you want to, you can also add a guide to our documentation by adding a On windows (or something similar) section on this page: https://docsearch.algolia.com/docs/legacy/run-your-own#run-the-crawl-from-the-docker-image

kingabzpro commented 2 years ago

I will look into later this month.