Quickstart

This guide starts S3 Lens with a prepared executable and one configured object-storage Provider. Use the binary supplied by your distribution channel.

Requirements

• An S3 Lens executable
• Access credentials for an S3-compatible Provider

Create a configuration

Create s3lens.yaml next to the executable:

workspace:
  id: local
  display_name: Local storage
  providers:
    - id: storage
      display_name: Object storage
      type: generic
      endpoint: ${S3_ENDPOINT}
      region: ${S3_REGION:-us-east-1}
      credentials:
        access_key_id: ${S3_ACCESS_KEY_ID}
        secret_access_key: ${S3_SECRET_ACCESS_KEY}

server:
  listen: http://127.0.0.1:8085

ui:
  enabled: true

Export the variables referenced by the configuration before you start the server. See Configuration for other fields and Storage providers for provider-specific settings.

Start S3 Lens

./s3lens serve --config ./s3lens.yaml

Open http://127.0.0.1:8085 in a browser. The bundled UI and JSON-RPC endpoint use this same origin.

Check that the server is ready:

curl --fail http://127.0.0.1:8085/healthz
curl --fail http://127.0.0.1:8085/readyz

The readiness probe does not contact the configured Provider. Stop the server with Ctrl-C.

Continue

Read Configuration to set listener, UI, logging, and authentication options. Read Authentication before exposing the server beyond the local machine.