Quick Start

Get Cloodsy S3 running in under a minute.

Install

Quick Install (Linux / macOS)

The install script detects your OS and architecture, downloads the latest release, and installs to /usr/local/bin/:

curl -fsSL https://raw.githubusercontent.com/onaonbir/Cloodsy-S3/main/install.sh | bash

Manual Download

Download the binary for your platform from GitHub Releases:

Platform File
Linux x64 cloodsys3-linux-amd64.tar.gz
Linux ARM64 cloodsys3-linux-arm64.tar.gz
Linux ARMv7 cloodsys3-linux-armv7.tar.gz
macOS Apple Silicon cloodsys3-darwin-arm64.tar.gz
macOS Intel cloodsys3-darwin-amd64.tar.gz
Windows x64 cloodsys3-windows-amd64.zip 
# Example: Linux x64
curl -LO https://github.com/onaonbir/Cloodsy-S3/releases/latest/download/cloodsys3-linux-amd64.tar.gz
tar xzf cloodsys3-linux-amd64.tar.gz
chmod +x cloodsys3

Create a Bucket

./cloodsys3 bucket create my-files

Create Credentials

./cloodsys3 credential create my-files

Output:

Bucket:     my-files
Access Key: AK7F2B9X4MPLEPHOTO1
Secret Key: wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLE

Warning: Save the secret key now. It will not be shown again.

Start the Server

./cloodsys3 serve

The server starts on port 9000 by default. To use a custom config:

./cloodsys3 serve -config config.yaml

Upload Your First File

Configure the AWS CLI and upload a file:

# Configure a profile
aws configure --profile cloodsy
# Enter Access Key, Secret Key, Region: us-east-1

# Upload
aws --endpoint-url http://localhost:9000 --profile cloodsy \
    s3 cp hello.txt s3://my-files/

Verify

aws --endpoint-url http://localhost:9000 --profile cloodsy \
    s3 ls s3://my-files/

You should see hello.txt listed.

Self-Update

Cloodsy S3 can update itself:

# Check for updates
./cloodsys3 update --check

# Update to latest version
./cloodsys3 update

Next Steps

Configuration