From 775c2f30ef563a856c403b45503c61abf35d397f Mon Sep 17 00:00:00 2001 From: t-takahashi Date: Thu, 4 Jul 2024 06:50:25 +0900 Subject: [PATCH] update README --- .github/workflows/go.yml | 2 +- README.md | 25 ++++++++++++++++++++++++- 2 files changed, 25 insertions(+), 2 deletions(-) diff --git a/.github/workflows/go.yml b/.github/workflows/go.yml index 55f6c72..071c0de 100644 --- a/.github/workflows/go.yml +++ b/.github/workflows/go.yml @@ -16,7 +16,7 @@ jobs: with: go-version: '1.22.4' - - name: Build & Test + - name: Build run: go build -v ./... - name: Test diff --git a/README.md b/README.md index 5d3ab0c..cebef5d 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,33 @@ # MOS3 `MOS3` is a mock application for Amazon S3, meaning `My Own S3`, pronounced `mɒsˈθri`. # Install +## Docker +Run command. +```bash +# https://hub.docker.com/r/tttol/mos3 +docker run -p 3333:3333 -v ./upload:/app/upload -it --rm tttol:mos3 +``` +Then acccess http://localhost:3333/s3 . + +## Docker Compose +Here is compose.yml. +```yml:compose.yml +version: '3.8' +services: + mos3: + image: tttol:mos3 + ports: + - "3333:3333" + volumes: + - ./upload:/app/upload +``` + +Run command. ```bash -docker run -p 3333:3333 -v ./up:/app/upload -it --rm tttol:mos3 +docker compose up -d ``` + Then acccess http://localhost:3333/s3 . # Usage TBD