s3manager-web/README.md

34 lines
1.3 KiB
Markdown
Raw Normal View History

2016-12-18 22:54:21 +01:00
# S3 Manager
2017-04-07 09:16:59 +02:00
[![Build Status](https://travis-ci.org/mastertinner/s3-manager.svg?branch=master)](https://travis-ci.org/mastertinner/s3-manager)
2017-04-06 17:58:26 +02:00
A Web GUI written in Go to manage S3 buckets from any provider.
2016-12-18 22:54:21 +01:00
## Environment Variables
2017-02-22 11:18:20 +01:00
* `S3_ACCESS_KEY_ID`: Required. Your S3 access key ID
* `S3_SECRET_ACCESS_KEY`: Required. Your S3 secret access key
2016-12-18 22:54:21 +01:00
* `S3_ENDPOINT`: Optional. In case you are using a different S3 provider than AWS. Defaults to `s3.amazonaws.com`
* `V2_SIGNING`: Optional. In case your S3 provider still uses V2 Signing, set this to `true`
2017-02-22 11:18:20 +01:00
## Run locally
1. Set all necessary environment variables
2017-03-30 22:56:25 +02:00
1. Run `go build`
2017-02-22 11:18:20 +01:00
1. Run the binary and visit <http://localhost:8080>
2017-03-30 22:56:25 +02:00
## Build with Docker
1. Run `docker run --rm -v "${PWD}:/go/src/github.com/mastertinner/s3-manager" -w /go/src/github.com/mastertinner/s3-manager golang curl https://glide.sh/get | sh && glide install && go build`
To cross-compile for windows, use the `-e "GOOS=windows" -e "GOARCH=amd64"` flags (depending on your system, you might have to adjust `GOARCH`)
To cross-compile for macOS, use the `-e "GOOS=darwin" -e "GOARCH=amd64"` flags (depending on your system, you might have to adjust `GOARCH`)
2017-03-30 22:56:25 +02:00
## Push to Cloud Foundry
1. Set environment variables in `manifest.yml`
2017-03-30 22:57:33 +02:00
1. Set hostname that isn't taken yet in `manifest.yml`
2017-03-30 22:56:25 +02:00
1. Run `cf push`