Run on your own guide for windows 10
- Dominant language
- TypeScript
- Stars
- 4.4k
- Forks
- 439
- Avg merge
- 14h 32m
- Merged PRs (30d)
- 19
Description
## 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👇

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.
Contributor guide
Research direction
Start by locating the project's setup or run documentation and compare it with the Windows 10 workflow described here: WSL2, Ubuntu, the .env file, config.txt, and the docker run command. Document the verified steps and prerequisites, with completion marked by a Windows user being able to run the scraper successfully.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- docker, ubuntu
- Domain
- devops, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 52/100