Note: The quickstart section is for learning purposes. The installations below will not persist your data. Instead, it will spin-up a database in a docker container, which will be discarded later.
For a production suitable deployment, see Deploying on AWS.
To run a local lakeFS instance using Docker Compose:
Ensure you have Docker installed on your computer, and that compose version is 1.25.04 or higher. For more information, please see this issue.
Run the following command in your terminal:
Invoke-WebRequest https://compose.lakefs.io | Select-Object -ExpandProperty Content | docker-compose -f - up
Check your installation by opening http://127.0.0.1:8000/setup in your web browser.
You can install lakeFS on a Kubernetes cluster with the following commands:
# Add the lakeFS Helm repository helm repo add lakefs https://charts.lakefs.io # Deploy lakeFS with helm release "my-lakefs" helm install my-lakefs lakefs/lakefs
Alternatively, you may opt to run the lakefs binary directly on your computer.
Download the lakeFS binary for your operating system:
Install and configure PostgreSQL
Create a configuration file:
--- database: connection_string: "postgres://localhost:5432/postgres?sslmode=disable" blockstore: type: "local" local: path: "~/lakefs_data" auth: encrypt: secret_key: "a random string that should be kept secret" gateways: s3: domain_name: s3.local.lakefs.io:8000
Create a local directory to store objects:
Run the server:
./lakefs --config /path/to/config.yaml run