Skip to content

Commit

Permalink
Add README.me as GitHub is serving the Go file instead...
Browse files Browse the repository at this point in the history
  • Loading branch information
BastienClement committed Jul 14, 2024
1 parent 9da8f4f commit 1a33713
Showing 1 changed file with 26 additions and 0 deletions.
26 changes: 26 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# gcs-index

Provide auto-index in front of Google Cloud Storage buckets.

Intended to be used together with a caching proxy.

## Usage

```
gcs-index path:bucket:prefix [path:bucket:prefix ...]
```

For each bucket:
- `path` is the "mount point" in the global tree.
- `bucket` is the name of the bucket.
- `prefix` is a prefix to apply to objects when listing (might be empty).

## Flags

- `-port int`: port to listen on (default 8080)
- `-socket string`: socket to listen on
- `-socket-umask int`: umask for the socket file (default -1)
- `-readme`: enable README.md rendering
- `-skip-readme`: skip README.md in directory listings
- `-version-sort`: sort directory listings using a semver-aware algorithm
- `-v`: enable verbose logging

0 comments on commit 1a33713

Please sign in to comment.