flashnote

command module
v1.0.3 Latest Latest
Warning

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

Go to latest
Published: Mar 9, 2026 License: Apache-2.0 Imports: 1 Imported by: 0

README

logo

Flash Note

Self-hosted ephemeral text & image sharing. Paste to upload, one-click copy, auto-expire. Single binary, zero external dependencies.

demo

Features

  • Paste-first — Ctrl+V anywhere to upload text or images
  • Real-time sync — WebSocket pushes changes to all connected clients instantly
  • Auto-expire — Every clip has a TTL; expired content is cleaned up automatically
  • Single binary — Frontend is embedded via go:embed, just run and go
  • Dark mode — Follows system preference, no toggle needed
  • Image actions — Copy to clipboard, download, share (Web Share API)

Quick Start

Binary

Download the latest binary from Releases, then:

cp examples/config.yaml config.yaml
./flashnote

Open http://localhost:8080 in your browser.

Docker
mkdir -p data && chown -R 65532:65532 data
docker run -d \
  -p 8080:8080 \
  -v ./data:/data \
  -v ./config.yaml:/config.yaml \
  mmx233/flashnote
Build from Source
git clone https://github.com/Mmx233/flashnote.git
cd flashnote
cd web && yarn install && yarn build && cd ..
go build -o flashnote .

Configuration

Create a config.yaml in the working directory (or specify with -c). See examples/config.yaml for a full example.

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
internal
ws

Jump to

Keyboard shortcuts

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