Link Search Menu Expand Document

More Quickstart Options

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, learn how to deploy lakeFS on your cloud.

Docker on Windows

To run a local lakeFS instance using Docker Compose:

  1. 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.

  2. Run the following command in your terminal:

    Invoke-WebRequest https://compose.lakefs.io | Select-Object -ExpandProperty Content | docker-compose -f - up
    
  3. Check your installation by opening http://127.0.0.1:8000/setup in your web browser.

  4. You are now ready to creating your first repository in lakeFS.

On Kubernetes with Helm

  1. Install lakeFS on a Kubernetes cluster using Helm:
    # 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
    
  2. The printed output will help you forward a port to lakeFS, so you can access it from your browser at http://127.0.0.1:8000/setup.

  3. Move on to create your first repository in lakeFS.

Using the Binary

Alternatively, you may opt to run the lakefs binary directly on your computer.

  1. Download the lakeFS binary for your operating system:

    Download lakefs

  2. Install and configure PostgreSQL

  3. 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"
    
  4. Create a local directory to store objects:

    mkdir ~/lakefs_data
    
  5. Run the server:

    ./lakefs --config /path/to/config.yaml run
    
  6. Check your installation by opening http://127.0.0.1:8000/setup in your web browser.

  7. You are now ready to create your first repository in lakeFS.