Service: Filestash - EyevinnOSC/community GitHub Wiki

Filestash

Filestash (serviceId mickael-kerjean-filestash) is a file manager that gives one consistent web interface over many storage backends and protocols. In Eyevinn Open Source Cloud (OSC) it is a long-running service instance with up to 10 GiB of storage per instance. License: AGPL-3.0. Source: mickael-kerjean/filestash.

What it can do

  • Browse, upload (drag and drop) and manage files in S3-compatible storage such as MinIO, Akamai Object Storage or AWS S3, with the same UI independent of provider.
  • Connect Dropbox and Google Drive as backends when the OAuth client options are set.
  • Protect access with an authentication middleware (ADMIN password login, or for example HTPASSWD for more granular access control).
  • Be configured through an admin interface (backends, authentication, plugins).

Creating an instance

Have a storage bucket and access keys ready. With OSC MinIO (minio-minio) create the instance first, confirm it is running, and note RootUser, RootPassword and the instance URL from describe-service-instance. With Akamai or AWS follow the provider's documentation for Akamai buckets and access keys, or AWS S3.

Store the admin password as a service secret with create-service-secret (serviceId: "mickael-kerjean-filestash"), then call create-service-instance with serviceId: "mickael-kerjean-filestash":

{
  "name": "guide",
  "AdminPassword": "{{secrets.filestashadmin}}",
  "ConfigSecret": "{{secrets.filestashconfig}}"
}

Verify with wait-for-service-ready or get-instance-status and open the instance URL (from describe-service-instance) in a browser.

Options

Option Required Type Meaning
name Yes string Name of the instance. Alphanumeric/word characters only (^\w+$), at most 20 characters.
AdminPassword No string, sensitive Password for the admin interface where storage backends, authentication settings and plugins are configured. If not set, you are asked to enter an administrator password the first time you open the instance.
ConfigSecret No string, sensitive Secret key used to encrypt Filestash configuration data and session tokens. Keep it stable so configuration and sessions survive restarts.
DropboxClientId No string OAuth2 client ID from the Dropbox developer console; enables Dropbox as a storage backend.
GdriveClientId No string OAuth2 client ID from the Google Cloud Console; enables Google Drive as a storage backend. Pair with GdriveClientSecret.
GdriveClientSecret No string, sensitive OAuth2 client secret that belongs to GdriveClientId.

Pass sensitive options as {{secrets.NAME}}; a reference must be the whole field value.

Using the instance

  1. Open the instance URL and, if prompted, enter an administrator password for the Filestash storage manager.
  2. In the admin sidebar open "Backend" and select S3 as storage backend (you can remove the other backends if you only use S3).
  3. For authentication, the ADMIN middleware means you log in with the admin password; for real use consider at least HTPASSWD.
  4. Enter the S3 access key id and secret key (for OSC MinIO these are RootUser and RootPassword) and the endpoint, which is the URL of your MinIO instance.
  5. Go back to the start page, log in, and upload files by drag and drop.

Filestash backend settings

Filestash authentication middleware

Filestash S3 credentials

Filestash file browser

Limitations

  • Storage is limited to 10 GiB per instance.

Resources