2024-04-16 05:01:47 +08:00
|
|
|
# Self-hosting Firecrawl
|
2024-05-16 04:25:39 +08:00
|
|
|
*We're currently working on a more in-depth guide on how to self-host, but in the meantime, here is a simplified version.*
|
|
|
|
|
|
|
|
Refer to [CONTRIBUTING.md](https://github.com/mendableai/firecrawl/blob/main/CONTRIBUTING.md) for instructions on how to run it locally.
|
2024-04-16 05:01:47 +08:00
|
|
|
|
2024-05-10 22:38:17 +08:00
|
|
|
## Getting Started
|
|
|
|
|
|
|
|
First, clone this repository and copy the example env file from api folder `.env.example` to `.env`.
|
2024-05-06 00:03:42 +08:00
|
|
|
```bash
|
|
|
|
git clone https://github.com/mendableai/firecrawl.git
|
|
|
|
cd firecrawl
|
2024-05-10 22:38:17 +08:00
|
|
|
cp ./apps/api/.env.example ./.env
|
2024-05-06 00:03:42 +08:00
|
|
|
```
|
2024-04-16 05:01:47 +08:00
|
|
|
|
2024-05-10 22:38:17 +08:00
|
|
|
For running the simplest version of FireCrawl, edit the `USE_DB_AUTHENTICATION` on `.env` to not use the database authentication.
|
|
|
|
```yml
|
2024-05-06 00:03:42 +08:00
|
|
|
USE_DB_AUTHENTICATION=false
|
|
|
|
```
|
|
|
|
|
2024-05-14 00:47:49 +08:00
|
|
|
Update the Redis URL in the .env file to align with the Docker configuration:
|
|
|
|
```yml
|
|
|
|
REDIS_URL=redis://redis:6379
|
|
|
|
```
|
|
|
|
|
2024-05-06 00:03:42 +08:00
|
|
|
Once that's complete, you can simply run the following commands to get started:
|
|
|
|
```bash
|
|
|
|
docker compose up
|
|
|
|
```
|
|
|
|
|
|
|
|
This will run a local instance of Firecrawl which can be accessed at `http://localhost:3002`.
|