Add Getting started and WIP: Run Knight Crawler

This commit is contained in:
purple_emily
2024-03-10 11:40:58 +00:00
parent 71ec7bdf2b
commit ad286a984f
4 changed files with 38 additions and 38 deletions

View File

@@ -0,0 +1,21 @@
# Run Knight Crawler
To run Knight Crawler you need two files, both can be found in the [deployment/docker](https://github.com/Gabisonfire/knightcrawler/tree/master/deployment/docker)
directory on GitHub:
- <path>deployment/docker/.env.example</path>
- <path>deployment/docker/docker-compose.yaml</path>.
For this guide I will be placing them in a directory on my home drive <path>~/knightcrawler</path>.
Rename the <path>.env.example</path> file to be <path>.env</path>
```
~/
└── knightcrawler/
├── .env
└── docker-compose.yaml
```
Before we start the services, we need to