078d4c8d41
Added new files for setting up Firecrawl on a Kubernetes Cluster. The files include Kubernetes manifests for deploying API, worker, playwright service, and Redis with associated ConfigMap and Secret associated resources. Also, updated the self-host documentation to include instructions for Kubernetes deployment.
34 lines
1.2 KiB
Markdown
34 lines
1.2 KiB
Markdown
# Self-hosting Firecrawl
|
|
*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.
|
|
|
|
## Getting Started
|
|
|
|
First, clone this repository and copy the example env file from api folder `.env.example` to `.env`.
|
|
```bash
|
|
git clone https://github.com/mendableai/firecrawl.git
|
|
cd firecrawl
|
|
cp ./apps/api/.env.example ./.env
|
|
```
|
|
|
|
For running the simplest version of FireCrawl, edit the `USE_DB_AUTHENTICATION` on `.env` to not use the database authentication.
|
|
```yml
|
|
USE_DB_AUTHENTICATION=false
|
|
```
|
|
|
|
Update the Redis URL in the .env file to align with the Docker configuration:
|
|
```yml
|
|
REDIS_URL=redis://redis:6379
|
|
```
|
|
|
|
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`.
|
|
|
|
# Install Firecrawl on a Kubernetes Cluster (Simple Version)
|
|
Read the [examples/k8n/README.md](examples/k8n/README.md) for instructions on how to install Firecrawl on a Kubernetes Cluster. |