Skip to content

Add some docs #31

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rivoalrivoal merged 1 commit into from
Oct 29, 2025
Merged

Add some docs #31

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 14 additions & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,20 @@
```bash
git clone # or gh repo clone Intrinsec/s3proxy
cd s3proxy
docker run --rm -p 4433:4433 -v $PWD:/app -it golang:1.24.5 bash
docker run --rm -p 4433:4433 -v $PWD:/app -it golang:1.25.3 bash
# In VSCode, use "Attach to Running Container..." option => select golang container => open /app folder
export AWS_ACCESS_KEY_ID=xxx
export AWS_SECRET_ACCESS_KEY=xxx
export S3PROXY_HOST=xxx
export S3PROXY_ENCRYPT_KEY=toto
go run s3proxy/cmd/main.go --no-tls --level=-4
```

# Example

```bash
echo "test" > test.txt
aws s3 cp ./test.txt s3://bucket/
aws s3 cp s3://bucket/test.txt ./test.txt
aws s3 rm s3://bucket/test.txt
```