Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/jessfraz/s3server

Server to index & view files in a s3 or Google Cloud Storage bucket.
https://github.com/jessfraz/s3server

Last synced: 10 days ago
JSON representation

Server to index & view files in a s3 or Google Cloud Storage bucket.

Awesome Lists containing this project

README

        

# s3server

[![make-all](https://github.com/jessfraz/s3server/workflows/make%20all/badge.svg)](https://github.com/jessfraz/s3server/actions?query=workflow%3A%22make+all%22)
[![make-image](https://github.com/jessfraz/s3server/workflows/make%20image/badge.svg)](https://github.com/jessfraz/s3server/actions?query=workflow%3A%22make+image%22)
[![GoDoc](https://img.shields.io/badge/godoc-reference-5272B4.svg?style=for-the-badge)](https://godoc.org/github.com/jessfraz/s3server)

Static server for s3 or gcs files.

**Table of Contents**

- [Installation](#installation)
- [Binaries](#binaries)
- [Via Go](#via-go)
- [Usage](#usage)

## Installation

#### Binaries

For installation instructions from binaries please visit the [Releases Page](https://github.com/jessfraz/s3server/releases).

#### Via Go

```console
$ go get github.com/jessfraz/s3server
```

## Usage

```console
$ s3server -h
s3server - Server to index & view files in a s3 or Google Cloud Storage bucket.

Usage: s3server

Flags:

--bucket bucket path from which to serve files (default: )
--cert path to ssl certificate (default: )
-d enable debug logging (default: false)
--interval interval to generate new index.html's at (default: 5m0s)
--key path to ssl key (default: )
-p port for server to run on (default: 8080)
--provider cloud provider (ex. s3, gcs) (default: s3)
--s3key s3 access key (default: )
--s3region aws region for the bucket (default: us-west-2)
--s3secret s3 access secret (default: )

Commands:

version Show the version information.
```

**run with the docker image**

```console
# On AWS S3
$ docker run -d \
--restart always \
-e AWS_ACCESS_KEY_ID \
-e AWS_SECRET_ACCESS_KEY \
-p 8080:8080 \
--name s3server \
--tmpfs /tmp \
r.j3ss.co/s3server -bucket s3://hugthief/gifs

# On Google Cloud Storage
$ docker run --restart always -d \
--name gifs \
-p 8080:8080 \
-v ~/configs/path/config.json:/creds.json:ro \
-e GOOGLE_APPLICATION_CREDENTIALS=/creds.json \
--tmpfs /tmp \
r.j3ss.co/s3server -provider gcs -bucket gcs://misc.j3ss.co/gifs
```

![screenshot](screenshot.png)