Skip to content

Commit 2c78319

Browse files
committed
chore: Add README.md
1 parent d7964da commit 2c78319

File tree

1 file changed

+39
-0
lines changed

1 file changed

+39
-0
lines changed

README.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# mongo-s3-backup
2+
3+
[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/F1F21LCOB)
4+
5+
Docker image for backup mongodb with s3cmd
6+
7+
## Usage
8+
9+
```bash
10+
docker run \
11+
-e MONGO_URI="mongodb://root:root@localhost:27017/db" \
12+
-e S3_ACCESS_KEY="ACCESS_KEY" \
13+
-e S3_SECRET_KEY="SECRET_KEY" \
14+
-e S3_PATH="s3://bucket/backup/" \
15+
-e S3_HOST_BASE="" \
16+
-e S3_HOST_BUCKET="" \
17+
-e S3_WEBSITE_ENDPOINT="" \
18+
ghcr.io/nitpum/mongo-s3-backup:main
19+
```
20+
21+
### Environment variables
22+
23+
- `MONGO_URI` Mongo uri example: `mongodb://root:root@localhost:27017/db`
24+
- `S3_ACCESS_KEY` S3 access key
25+
- `S3_SECRET_KEY` S3 secret key
26+
- `S3_PATH` S3 path example: `s3://bucket/backup/` (with trailing slash)
27+
- `S3_HOST_BASE` S3 host base example: `s3.amazonaws.com` or `nyc1.digitaloceanspaces.com`
28+
- `S3_HOST_BUCKET` S3 host bucket example: `%(bucket)s.s3.amazonaws.com` or `%(bucket)s.fra1.digitaloceanspaces.com`
29+
- `S3_WEBSITE_ENDPOINT` S3 website endpoint example: `http://%(bucket)s.s3-website-% (location)s.amazonaws.com/` or`http://%(bucket)s.s3-website-%(location)s.digitaloceanspaces.com/`
30+
31+
## Support
32+
33+
If you think this is useful, please consider support me ;)
34+
35+
[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/F1F21LCOB)
36+
37+
## License
38+
39+
[MIT License](LICENSE)

0 commit comments

Comments
 (0)