Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/e2fyi/minio-web
Web server for S3 compatible storage
https://github.com/e2fyi/minio-web
go golang minio proxy-server s3 webserver
Last synced: about 4 hours ago
JSON representation
Web server for S3 compatible storage
- Host: GitHub
- URL: https://github.com/e2fyi/minio-web
- Owner: e2fyi
- License: apache-2.0
- Created: 2019-04-10T04:52:52.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-04-23T16:07:05.000Z (7 months ago)
- Last Synced: 2024-06-19T02:09:23.179Z (5 months ago)
- Topics: go, golang, minio, proxy-server, s3, webserver
- Language: Go
- Homepage:
- Size: 25.3 MB
- Stars: 20
- Watchers: 4
- Forks: 7
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# github.com/e2fyi/minio-web
[](https://godoc.org/github.com/e2fyi/minio-web/pkg)
[](https://hub.docker.com/r/e2fyi/minio-web)
[](https://quay.io/repository/e2fyi/minio-web)
A web server proxy for any S3-compatible storage.
## Quickstart
### Environment variables
```bash
# where config file is located
CONFIG_FILE_PATH=configs/config.json
# port for minio-web to listen to
SERVER_PORT=8080
# path to ssl cert and key files
SERVER_SSL_CERT=
SERVER_SLL_KEY=
# endpoint to call for the s3 compatible storage
MINIO_ENDPOINT=s3.amazonaws.com
# access key and secret key
MINIO_ACCESSKEY=
MINIO_SECRETKEY=
# ssl when calling endpoint
MINIO_SECURE=true
# aws s3 bucket region (optional)
MINIO_REGION=
# Extensions #
# bucket to serve if provided (http://minio-web/abc => endpoint/bucketname/abc)
# if not provided (http://minio-web/abc/efg => endpoint/abc/efg) where abc is the bucket
EXT_BUCKETNAME=
# prefix to add to query.
# e.g. EXT_PREFIX=foo/
# query to endpoint/abc -> query EXT_BUCKETNAME/foo/ab
EXT_PREFIX=
# if provided a list of default index files to return
# i.e http://minio-web/abc/ => http://minio-web/abc/index.html
EXT_DEFAULTHTML=index.html,README.md
# if provided, returns a default favicon if backend does not have one.
EXT_FAVICON=assets/favicon.ico
# if set, list the folders inside a folder
EXT_LISTFOLDER=true
# objects that match the glob expression will be listed. e.g. markdown files
EXT_LISTFOLDEROBJECTS=*.{md,html,jpg,jpeg,png,txt}
# if provided, renders any markdown resources as HTML with the template.
# template MUST have a placeholder {{ .Content }}
EXT_MARKDOWNTEMPLATE=assets/md-template.html
```
### Config file
```json
{
"server": {
"port": 8080,
"ssl": {
"cert": "",
"key": ""
}
},
"minio": {
"endpoint": "s3.amazonaws.com",
"accesskey": "",
"secretkey": "",
"secure": false,
"region": ""
},
"ext": {
"bucketname": "",
"defaulthtml": "index.html,README.md",
"favicon": "assets/favicon.ico",
"markdowntemplate": "assets/md-template.html",
"listfolder": true,
"listfolderobjects": "*.{md,html,jpg,jpeg,png,txt}"
}
}
```
### Run demo locally
```bash
# starts a minio server
./scripts/start-minio-server.sh
# starts minio-web service
go run .
```
Alternatively, with docker compose:
```bash
# you can access the minio-store at localhost:9000
# and the minio-web at localhost:8080
docker-compose up -d
```
### Docker image
Image will now available in ~[Dockerhub](https://hub.docker.com/r/e2fyi/minio-web)~, [Quay.io](https://quay.io/repository/e2fyi/minio-web) and [Github registry](https://github.com/e2fyi/minio-web/pkgs/container/minio-web).
- ~`e2fyi/minio-web:`~
- `quay.io/e2fyi/minio-web:`
- `ghcr.io/e2fyi/minio-web:`
> Free tier for docker hub automated build has been [discontinued](https://www.docker.com/blog/changes-to-docker-hub-autobuilds/).
> Until I find time to setup GitHub actions, no new tags will be pushed to docker hub.
> i.e. All the latest releases can only be found in Quay.io and ghcr.io (thanks @PseudoResonance)
```bash
# build locally
docker build -t e2fyi/minio-web:latest .
# pull from dockerhub
docker pull e2fyi/minio-web:latest
# run docker container
docker run --rm -ti \
-p 8080:8080 \
--env-file .envfile \
e2fyi/minio-web:latest
```
## Kubernetes deployment (Kustomize)
[kustomize](https://github.com/kubernetes-sigs/kustomize) k8s manifest for
`minio-web` can be found in [manifest/](./manifest).
## GoDoc
- [minio-web](https://godoc.org/github.com/e2fyi/minio-web/)
- [github.com/e2fyi/minio-web/pkg/app](https://godoc.org/github.com/e2fyi/minio-web/pkg/app)
- [github.com/e2fyi/minio-web/pkg/core](https://godoc.org/github.com/e2fyi/minio-web/pkg/core)
- [github.com/e2fyi/minio-web/pkg/minio](https://godoc.org/github.com/e2fyi/minio-web/pkg/minio)
- [github.com/e2fyi/minio-web/pkg/ext](https://godoc.org/github.com/e2fyi/minio-web/pkg/ext)