S3 crab_share

A super simple application to upload files to an S3 bucket and generate a shareable link.

Usage

crab_share <PATH>

Options:

Option	Default	Description
-e, --expires	7d	The time until the link expires.
-b, --bucket		The bucket to upload to.
-u, --url		The S3 url.
-r, --region	eu-central-1	The S3 region.
-a, --access-key		The S3 access key.
-s, --secret-key		The S3 secret key.
-c, --compression	zstd	The compression algorithm to use.
-z, --zip-single-file	false	Zip file before uploading.
-p, --purge	false	Purge expired files.

Setup

There are three ways to configure the application. Either by passing options, setting the environment variables, or by creating a config file containing the credentials. The default options are overwritten by the config file, which are overwritten by the environment variables, which are overwritten by the passed options.

Environment variables

export S3_URL=
export S3_ACCESS_KEY=
export S3_SECRET_KEY=
export S3_EXPIRES=
export S3_BUCKET=
export S3_PATH=
export S3_REGION=
export S3_COMPRESSION=
export S3_ZIP_SINGLE_FILE=
export S3_PURGE=

Token file

mkdir ~/.aws
touch ~/.aws/credentials.json
vim ~/.aws/credentials.json

The file should have the following format:

{
    "url": "https://s3.domain.com",
    "accessKey": "accessKey",
    "secretKey": "secretKey",
    "api": "s3v4",
    "path": "auto"
}

Config file

touch ~/.aws/crab_share.json
vim ~/.aws/crab_share.json

The file should have the following format:

{
    "bucket": "your-bucket-name",
    "region": "eu-central-1",
    "url": "https://s3.domain.com",
    "expires": "7d",
    "compression": "zstd",
    "zipSingleFile": false,
    "purge": true
}

Installation

Using the Nix package manager

This repository contains a flake.nix file which can be used to build the application using the Nix package manager.

Using homebrew

To install the application using homebrew, run:

# Add the tap to homebrew
brew tap --force-auto-update lounge-rocks/crab_share https://github.com/lounge-rocks/crab_share

# Install the application
brew install crab_share

# Install the application from main branch
brew install --HEAD crab_share 

In case you want to remove the application, run:

brew uninstall crab_share
brew untap lounge-rocks/crab_share
brew autoremove

Using cargo

Make sure you have cargo installed. To do this on MacOS, run:

brew install rustup
rustup-init

Then clone the repository and build the binary.

git clone https://github.com/lounge-rocks/crab_share.git
cd crab_share
cargo install --path .

It's also possible to just build the binary without installing it.

cargo build --release

Inner workings

Configuration

Internally, we use four different structs to configure the application.

• JSONConfig and JSONCredentials are used to parse the config and credentials files from ~/.aws.
• EnvConfig is used to parse the environment variables.
• Args contains all the options passed to the application.
• PartialConfig is the struct used for merging the different configuration sources. All values are optional. The default values are set as a function of this struct.
• Config is the main struct which contains all the combiled configuration. All values must be set in this struct.

Purging

Each uploaded file has a ulid in its path. The timestamp part of the ulid is used to determine when the file expires. When the --purge option is set, the application will check the bucket for expired files and delete them.