snipo

module
v1.1.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 8, 2025 License: GPL-3.0

README

Snipo

A lightweight, self-hosted snippet manager designed for single-user deployments.

Note: This project is intentionally scoped for single-user use. Multi-user features are not planned.

CI Release Go Version GitHub release

Snipo Demo

Quick Start

# Create environment file
cat > .env << EOF
SNIPO_MASTER_PASSWORD=your-secure-password
SNIPO_SESSION_SECRET=$(openssl rand -hex 32)
EOF

# Run with Docker Compose
docker compose up -d

Access at http://localhost:8080

Binary
# Download latest release
curl -LO https://github.com/MohamedElashri/snipo/releases/latest/download/snipo_linux_amd64.tar.gz
tar xzf snipo_linux_amd64.tar.gz

# Configure and run
export SNIPO_MASTER_PASSWORD="your-secure-password"
export SNIPO_SESSION_SECRET=$(openssl rand -hex 32)
./snipo serve

Configuration

Variable Required Default Description
SNIPO_MASTER_PASSWORD Yes - Login password
SNIPO_SESSION_SECRET Yes - Session signing key (32+ chars)
SNIPO_PORT No 8080 Server port
SNIPO_DB_PATH No ./data/snipo.db SQLite database path

See .env.example for all available options including S3 backup configuration.

API

Create API tokens in Settings → API Tokens. Authenticate via:

  • Authorization: Bearer <token>
  • X-API-Key: <key>

Full API documentation: docs/openapi.yaml

Development

See the Development Guide for build instructions, testing, and contribution guidelines.

License

GPLv3

Directories

Path Synopsis
cmd
server command
internal
api
testutil
Package testutil provides testing utilities for the snipo application.
Package testutil provides testing utilities for the snipo application.
web

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL