Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
tttol committed Jul 3, 2024
1 parent e5012d3 commit 775c2f3
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 2 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/go.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ jobs:
with:
go-version: '1.22.4'

- name: Build & Test
- name: Build
run: go build -v ./...

- name: Test
Expand Down
25 changes: 24 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down

0 comments on commit 775c2f3

Please sign in to comment.