s3manager-web/README.md

33 lines
1.5 KiB
Markdown
Raw Normal View History

2016-12-18 22:54:21 +01:00
# S3 Manager
2017-08-26 10:49:41 +02:00
[![Go Report Card](https://goreportcard.com/badge/github.com/mastertinner/s3manager)](https://goreportcard.com/report/github.com/mastertinner/s3manager)
2018-01-09 23:18:04 +01:00
[![Build Status](https://travis-ci.org/mastertinner/s3manager.svg?branch=master)](https://travis-ci.org/mastertinner/s3manager)
[![codecov](https://codecov.io/gh/mastertinner/s3manager/branch/master/graph/badge.svg)](https://codecov.io/gh/mastertinner/s3manager)
2017-04-07 09:16:59 +02:00
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
2017-02-22 11:18:20 +01:00
## Run locally
2017-05-08 23:07:07 +02:00
1. Run `make`
1. Execute the created binary and visit <http://localhost:8080>
2017-03-30 22:56:25 +02:00
2017-04-27 12:29:13 +02:00
## Run with Docker
1. Set environment variables in `docker-compose.yml`
1. Run `docker-compose up`
1. Visit <http://localhost:8080>
## Build with Docker and run anywhere
2017-05-08 23:07:07 +02:00
1. Run `make build-docker`
2018-01-08 09:44:07 +01:00
To cross-compile for windows, add the `-e "GOOS=windows" -e "GOARCH=amd64"` flags to the `Makefile` (depending on your system, you might have to adjust `GOARCH`)
2018-01-08 09:44:07 +01:00
To cross-compile for macOS, add the `-e "GOOS=darwin" -e "GOARCH=amd64"` flags to the `Makefile` (depending on your system, you might have to adjust `GOARCH`)
2017-04-27 12:29:13 +02:00
## Run on Cloud Foundry
2017-03-30 22:56:25 +02:00
2017-05-08 23:07:07 +02:00
1. Change the service in `manifest.yml` to represent your S3 service (if you are using an external S3 provider, you'll have to switch the service type in `entrypoint-cf.sh` from `dynstrg` to `user-provided` and create the respective user-provided service with `cf create-user-provided-service`)
2018-01-10 17:15:59 +01:00
1. Add a route in `manifest.yml` that isn't taken yet
2017-05-08 23:07:07 +02:00
1. Run `make deploy-cf`