# Self-host FalkorDB

> Low latency graph database that speaks the Redis protocol and the Cypher query language, with a bundled browser UI. Source available under the SSPL-1.0, which is not an open source license, so check it before offering it as a hosted service.

- Page: https://levelrail.com/templates/falkordb/
- JSON: https://levelrail.com/templates/falkordb.json
- Category: Database Tools
- Licence: SSPL-1.0 (Source available)
- Source: https://github.com/FalkorDB/FalkorDB
- Upstream docs: https://docs.falkordb.com/

## Requirements
- Memory: about 256 MiB
- amd64: unknown, arm64: unknown
- Needs configuration before start: no
- Pinned image tag: 6.0.4

## Services

| Service | Image | Tag | Ports | Volumes |
| --- | --- | --- | --- | --- |
| falkordb | falkordb/falkordb | 6.0.4 | 3000, 6379 | data -> /var/lib/falkordb/data |

## Deploy

### CLI

```bash
levelrail-cli templates deploy falkordb --name my-falkordb
```

### API

```bash
curl -X POST -H "Authorization: Bearer $TOKEN" \
  https://levelrail.example.com/api/v1/service-templates/falkordb/deploy
```

Create a token in the dashboard first. This one-click route deploys it as a trial app you can keep or remove.

## First run
1. Connect any Redis client to port 6379 and use GRAPH.QUERY, or open the address for the browser UI. There is no login, so keep it private.

## Questions

### Can I deploy FalkorDB on Dokploy or Dokku?

The services and pinned images on this page can be run on any Docker host. The public Dokploy templates list has an entry with the id falkordb for this app, so check that entry as well. Dokku deploys container images with its own commands, so the pinned image falkordb/falkordb:6.0.4 is what you deploy there.

Self-host FalkorDB, FalkorDB docker compose file, deploy FalkorDB on a VPS: this page lists the pinned image, ports, volumes and the commands for each.
