{"id":13582036,"url":"https://github.com/techknowlogick/caddy-s3browser","last_synced_at":"2025-11-06T03:30:25.249Z","repository":{"id":36631737,"uuid":"156116852","full_name":"techknowlogick/caddy-s3browser","owner":"techknowlogick","description":"[Archived] Caddy plugin to generate file indexes of S3 buckets to browse via Web Client. Please contact me if you need commercial support.","archived":true,"fork":false,"pushed_at":"2022-06-03T22:25:28.000Z","size":318,"stargazers_count":81,"open_issues_count":6,"forks_count":10,"subscribers_count":4,"default_branch":"main","last_synced_at":"2024-10-26T21:27:22.054Z","etag":null,"topics":["aws-s3","caddy","caddy-plugin","s3"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/techknowlogick.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null},"funding":{"github":["techknowlogick"]}},"created_at":"2018-11-04T19:26:42.000Z","updated_at":"2024-08-24T18:37:10.000Z","dependencies_parsed_at":"2022-08-08T16:15:47.560Z","dependency_job_id":null,"html_url":"https://github.com/techknowlogick/caddy-s3browser","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/techknowlogick%2Fcaddy-s3browser","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/techknowlogick%2Fcaddy-s3browser/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/techknowlogick%2Fcaddy-s3browser/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/techknowlogick%2Fcaddy-s3browser/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/techknowlogick","download_url":"https://codeload.github.com/techknowlogick/caddy-s3browser/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239479483,"owners_count":19645748,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["aws-s3","caddy","caddy-plugin","s3"],"created_at":"2024-08-01T15:02:23.849Z","updated_at":"2025-11-06T03:30:25.212Z","avatar_url":"https://github.com/techknowlogick.png","language":"Go","funding_links":["https://github.com/sponsors/techknowlogick"],"categories":["Go"],"sub_categories":[],"readme":"# Caddy s3browser\n\nThis will provide directory listing for an S3 bucket (you are able to use minio, or other S3 providers).\n\nNote: For performance reasons, the file listing is fetched once every 5 minutes to reduce load on S3. You can force a refresh by sending a POST request to the plugin.\n\n## Building\n\nUse [xcaddy](https://github.com/caddyserver/xcaddy) to build.\n\nExample:\n````bash\n$ xcaddy build --output ./caddy --with github.com/techknowlogick/caddy-s3browser@main\n````\n\n## Configuration\n\nSee `Caddyfile.tmpl` for a template.\n\n|  option   |  type  |  default   | help |\n|-----------|:------:|------------|------|\n| site_name           | string | S3 Browser | Site display name |\n| endpoint            | string |            | S3 hostname |\n| region              | string |   empty    | S3 region (optional) |\n| key                 | string |            | S3 access key |\n| secret              | string |            | S3 secret key |\n| secure              |  bool  |   `true`   | Use TLS when connection to S3 |\n| bucket              | string |            | S3 bucket |\n| refresh_interval    | string |    `5m`    | Time between periodic refresh |\n| refresh_api_secret  | string |   empty    | A key to protect the refresh API. (optional) |\n| debug               |  bool  |   `false`  | Output debug information |\n| signed_url_redirect |  bool  |   `false`  | Output debug information |\n\n\n## Force Refresh\n\nYou can trigger a force refresh by making a POST request to the server:\n```bash\ncurl -X POST \"$HOST\"\n```\n\nWhen `refresh_api_secret` is set, you must use HTTP basic auth:\n```bash\ncurl -X POST \"api:$SECRET@$HOST\" # the username can be anything\n```\n\n\n## Prior Art\n* This is based on the [Browse plugin](https://github.com/mholt/caddy/tree/master/caddyhttp/browse) that is built into Caddy\n* [s3server](https://github.com/jessfraz/s3server) from jessfraz\n* [pretty-s3-index-html](https://github.com/nolanlawson/pretty-s3-index-html) by Nolan Lawson\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftechknowlogick%2Fcaddy-s3browser","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftechknowlogick%2Fcaddy-s3browser","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftechknowlogick%2Fcaddy-s3browser/lists"}