s3manager-web/README.md

60 lines
2 KiB
Markdown
Raw Normal View History

2016-12-18 22:54:21 +01:00
# S3 Manager
2019-01-26 13:53:36 +01:00
[![Go Report Card](https://goreportcard.com/badge/github.com/mastertinner/s3manager?style=flat-square)](https://goreportcard.com/report/github.com/mastertinner/s3manager)
2020-05-04 15:35:59 +02:00
[![Build Status](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2Fmastertinner%2Fs3manager%2Fbadge&style=flat-square)](https://github.com/mastertinner/s3manager/actions)
2019-09-05 00:44:02 +02:00
[![Docker Build](https://img.shields.io/docker/cloud/build/mastertinner/s3manager.svg?style=flat-square)](https://hub.docker.com/r/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
2020-05-04 10:33:23 +02:00
![Screenshot](https://raw.githubusercontent.com/mastertinner/s3manager/master/screenshot.png)
## Usage
2020-05-04 15:35:59 +02:00
### Configuration
2020-05-04 10:33:23 +02:00
The application can be configured with the following environment variables:
- `ENDPOINT`: The endpoint of your S3 server (defaults to `s3.amazonaws.com`)
- `ACCESS_KEY_ID`: Your S3 access key ID (required)
- `SECRET_ACCESS_KEY`: Your S3 secret access key (required)
2020-05-04 15:35:59 +02:00
- `USE_SSL`: Whether your S3 server uses SSL or not (defaults to `true`)
- `PORT`: The port the s3manager app should listen on (defaults to `8080`)
2020-05-04 10:33:23 +02:00
2020-05-04 15:35:59 +02:00
### Build and Run Locally
2017-04-27 12:29:13 +02:00
2020-05-04 10:33:23 +02:00
1. Run `make build`
2018-03-14 21:53:35 +01:00
1. Execute the created binary and visit <http://localhost:8080>
2017-04-27 12:29:13 +02:00
2020-11-03 11:36:43 +01:00
### Run Docker image
1. Run `docker run -p 8080:8080 -e 'ACCESS_KEY_ID=XXX' -e 'SECRET_ACCESS_KEY=xxx' mastertinner/s3manager`
2020-05-04 15:35:59 +02:00
### Deploy to Cloud Foundry
1. Modify `deployments/cf/*` to your liking
1. Run `make deploy-cf`
## Development
### Lint Code
1. Run `make lint`
### Run Tests
2018-03-14 21:53:35 +01:00
1. Run `make test`
2020-05-04 15:35:59 +02:00
### Build Docker Image
2018-10-27 14:59:59 +02:00
The image is available on [Docker Hub](https://hub.docker.com/r/mastertinner/s3manager/)
2018-03-14 21:53:35 +01:00
1. Run `make build-docker`
2020-05-04 15:35:59 +02:00
### Run Locally for Testing
2017-03-30 22:56:25 +02:00
2020-05-04 15:35:59 +02:00
There is an example [docker-compose.yml](https://github.com/mastertinner/s3manager/blob/master/docker-compose.yml) file that spins up an S3 service and the s3manager. You can try it by issuing the following command:
```shell
$ docker-compose up
```