Quickstart

Prerequisites

Go 1.22+ (for building from source) or Docker
A Google OAuth client ID and secret

Option 1: From Source

Set environment variables

export SESSION_SECRET="$(openssl rand -hex 32)"
export GOOGLE_CLIENT_ID="your-client-id"
export GOOGLE_CLIENT_SECRET="your-client-secret"

Run the server

go run ./cmd/stashy serve --migrate

Upload your first file

Visit http://localhost:8080, sign in, create an API key, then:

curl -H "Authorization: Bearer <your-api-key>" \
  -X POST http://localhost:8080/v1/files \
  -H "Content-Type: image/png" \
  --data-binary @photo.png

Response:

{ "id": "V1StGXR8_Z5jdHi6B-myT", "url": "http://localhost:8080/V1StGXR8_Z5jdHi6B-myT" }

Access it at http://localhost:8080/V1StGXR8_Z5jdHi6B-myT.

Option 2: Docker Compose

cp .env.example .env   # fill in your secrets
docker compose up

Option 3: Homebrew

brew install stashysh/tap/stashy
stashy serve --migrate

Option 4: Binary Release

Download from GitHub Releases for your platform (Linux, macOS, Windows — amd64/arm64).

Getting Started

Core Concepts

Operations

Prerequisites

Option 1: From Source

Option 2: Docker Compose

Option 3: Homebrew

Option 4: Binary Release

Next Steps

Configuration

Authentication

​Prerequisites

​Option 1: From Source

​Option 2: Docker Compose

​Option 3: Homebrew

​Option 4: Binary Release

​Next Steps

Configuration

Authentication

Prerequisites

Option 1: From Source

Option 2: Docker Compose

Option 3: Homebrew

Option 4: Binary Release

Next Steps