Service: Bucket Commander - EyevinnOSC/community GitHub Wiki

Bucket Commander

Bucket Commander (serviceId birme-bucket-commander) is a web-based S3 bucket browser with a dual-pane, Norton Commander-style interface for navigating, uploading and managing files across your OSC-managed storage buckets. It is a long-running service instance under the MIT license, with up to 10 GiB of storage per instance. Source: birme/bucket-commander.

What it can do

  • Browse and navigate directories in your storage buckets in two panes.
  • Upload and download files.
  • Copy and move files between buckets or paths, including S3-to-S3 copy with real-time job monitoring (this uses the OSC access token).
  • Delete files.

Creating an instance

You need an OSC Personal Access Token, which you can create on the API Access page (see Finding Your API Token). Store it as a service secret so it stays out of the instance configuration and can be rotated: call create-service-secret with serviceId: "birme-bucket-commander", name osctoken and the token as value.

Then call create-service-instance with serviceId: "birme-bucket-commander":

{
  "name": "mybrowser",
  "OscAccessToken": "{{secrets.osctoken}}"
}

Wait for the instance to be running (wait-for-service-ready) and use describe-service-instance to get its URL.

CLI equivalent:

osc create birme-bucket-commander mybrowser \
  -o OscAccessToken="{{secrets.osctoken}}"

Options

Option Required Type Meaning
name Yes string Name of the instance. Alphanumeric, at most 20 characters.
OscAccessToken Yes string, sensitive OSC access token, required for S3-to-S3 file copy operations with real-time job monitoring. Pass it as {{secrets.NAME}} referencing a service secret; a reference must be the whole field value.

Changing the secret later does not restart a running instance.

Using the instance

Open the instance URL. Both panes can navigate your OSC storage buckets. Credentials are stored in the browser session and are not sent to any third-party service.

Resources