bridge-local-dev/minio/README.md

71 lines
2.2 KiB
Markdown
Raw Permalink Normal View History

2018-06-24 20:13:31 +00:00
# Summary
This directory contains scripts for starting a VM running Minio - an open source object storage
server with an Amazon S3 compatibl API.
The sections are:
* **Connection Information**: The connection details for the object store
* **Setup**: Steps required for setup
* **Maintenance**: How to bring minio up again if the VM wasn't suspended properly
Note, the information on connecting a local server to Minio is contained in the top-level README.md.
# Connection information:
* URL for web frontend: http://172.16.0.21:9000/
* Access Key & Secret Key: Displayed on first run, or available from `/root/.minio/config.json`
* Environment variables for dev server:
```
"minioEndpoint": "172.16.0.21",
"minioPort": "9000",
"minioAccessKey": "XXXXXXXXXXXXXXXXXXXX",
"minioSecretKey": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"minioStorageBucket": "dev"
```
# Setup
## Pre-requisites
1. Install [Virtual Box](https://www.virtualbox.org/).
2. Install [Vagrant](https://www.vagrantup.com/).
## To Start
1. `vagrant up` from the shell/console
2. Go to http://172.16.0.21:9000/
3. Log in with Access Key and Secret Key (displayed on first run or in `/root/.minio/config.json`)
4. Click the *`+`* sign in the bottom right and choose *"Create Bucket"*
5. Name the bucket *"dev"*
NOTE: Steps 2-5 are only needed on first start
The first time, This will create and start an entirely new VM, download and install all packages, etc.
After that, this will only start up the suspended VM again.
NOTE: if the PC is rebooted without suspending the VM, the VM will be "powered down" and will not
have minio running next time it is resumed with `mongo up`. See *Maintenance* section below for
how to bring minio up again.
## To Stop
1. `vagrant suspend`
This will suspend the VM, retaining all data.
## To Reset
1. `vagrant destroy`
2. `vagrant up`
This will entirely reset the VM, losing all previous data. You have been warned!
# Maintenance
Login to the VM from the host and restart minio:
1. `vagrant ssh`
2. `sudo killall minio` to kill any running minio
3. `cd minio`
3. `sudo ./minio server ./data &` to start it again