Skip to content

CAB233/s3-browser

Repository files navigation

s3-browser

English | 简体中文

Screenshot

Tech Stack

Usage

Local Development

  1. Clone the repository

    git clone https://github.com/CAB233/s3-browser.git
    cd s3-browser
  2. Install dependencies

    deno install
  3. Configure Environment Variables

    Copy .dev.vars.example to .dev.vars and fill in your S3 credentials.

  4. Run the application

    deno task dev

Deploy to Cloudflare

  1. Configure Wrangler configuration file

    cp wrangler.toml.example wrangler.toml
  2. Configure Secrets

    Before deploying, ensure you have set the required secret environment variables in your Cloudflare dashboard or via wrangler:

    deno run npm:wrangler secret put BUCKET_ENDPOINT
    deno run npm:wrangler secret put BUCKET_REGION
    deno run npm:wrangler secret put BUCKET_ACCESS_KEY_ID
    deno run npm:wrangler secret put BUCKET_SECRET_ACCESS_KEY
    deno run npm:wrangler secret put BUCKET_DOWNLOAD_URL
  3. Build and Deploy

    deno task build
    deno task deploy

Environment Variables

Name Description Required Default
BUCKET_ENDPOINT The endpoint of the bucket. Yes -
BUCKET_REGION The region of the bucket. Yes -
BUCKET_ACCESS_KEY_ID The access key ID of the bucket. Yes -
BUCKET_SECRET_ACCESS_KEY The secret access key of the bucket. Yes -
BUCKET_DOWNLOAD_URL A publicly accessible URL to download objects. Yes -
DISABLE_SE_INDEX Set to true to disable search engine indexing. No true

License

MIT

Acknowledgements

About

A simple S3 browser, inspired by CaddyServer's file browser UI

Topics

Resources

License

Stars

Watchers

Forks

Contributors