poslop
15f199b2fe
- Cut Admin walkthrough and API curl block to one-liners pointing at docs - Keep Configuration table, features, Get Started, doc links - Retake all screenshots against current UI, one theme each: /new midnight, /history pastel-lavender, paste view pastel-peach, /mine pastel-cloud; remove superseded stale previews
106 lines
3.8 KiB
Markdown
106 lines
3.8 KiB
Markdown
# Palette
|
|
|
|
Palette is a fast, self-hosted pastebin. One Go binary, a SQLite database, and
|
|
a web UI for sharing code and text with links that expire on your terms.
|
|
|
|
## Features
|
|
|
|
- Paste cans — bundle notes, text, and files into one shareable page, with password/expiry/custom-slug parity and a `can` badge in listings
|
|
- Password lock — protect individual pastes with a password
|
|
- Custom expiry — from 1 minute up to 1 year, or never
|
|
- Burn after N reads — a paste that vanishes after a chosen number of reads
|
|
- Custom URLs — reserve `/my-snippet` instead of a random slug
|
|
- Syntax highlighting with language auto-detection (go-enry)
|
|
- Rate limiting on create and unlock
|
|
- Saved page — see and manage everything created from your browser
|
|
- API-first — every UI action is also a plain HTTP call
|
|
- Single binary — templates and assets are embedded; no external deps
|
|
|
|
## Get Started
|
|
|
|
### Build from source
|
|
|
|
Requires Go 1.21+.
|
|
|
|
```bash
|
|
go build -o palette .
|
|
./palette
|
|
# open http://localhost:8080
|
|
```
|
|
|
|
### Docker
|
|
|
|
```bash
|
|
docker run -p 8080:8080 -v palette-data:/data git.archfox.org/poslop/palette
|
|
```
|
|
|
|
The SQLite database lives in the `/data` volume inside the container.
|
|
|
|
## Screenshots
|
|
|
|
| | |
|
|
|---|---|
|
|
|  |  |
|
|
|  |  |
|
|
|
|
## Configuration
|
|
|
|
| Setting | Default | Description |
|
|
|---|---|---|
|
|
| `PALETTE_ADDR` | `:8080` | Listen address |
|
|
| `PALETTE_DB` | `palette.db` | SQLite database path |
|
|
| `PALETTE_MAX_TEXT` | `5242880` | Max paste size in bytes (5 MB) |
|
|
| `PALETTE_MAX_ITEM` | `26214400` | Max can item size in bytes (25 MB) |
|
|
| `PALETTE_ADMIN_KEY` | generated | Admin key; if unset a 32-char hex key is generated and persisted to `<db-dir>/admin-key` (0600) |
|
|
|
|
An `/admin` page exists for runtime settings, protected by a key set at
|
|
install (`PALETTE_ADMIN_KEY` env var) and resettable locally — see
|
|
[docs/API.md](docs/API.md) and [docs/design/](docs/design/) for details.
|
|
|
|
## API
|
|
|
|
Full REST API: [docs/API.md](docs/API.md). One example:
|
|
|
|
```bash
|
|
curl -X POST http://localhost:8080/api/pastes -d '{"content":"hello"}'
|
|
```
|
|
|
|
Design docs: [docs/design/](docs/design/).
|
|
|
|
## Performance Notes
|
|
|
|
The history and Saved pages use client-side filtering: when you type in the
|
|
search box, the UI fetches the most recent 100 pastes (`limit=100`, the API
|
|
maximum) once per query and filters/sorts them in the browser. Pastes beyond
|
|
the newest 100 are not searched; a match count against the full total is still
|
|
shown. This keeps search instant without a server-side query. If large
|
|
instances need full search later, it will be a server-side endpoint (see
|
|
issue #32).
|
|
|
|
## CI
|
|
|
|
Gitea Actions workflow at `.gitea/workflows/ci.yml`:
|
|
- On push to main: `go vet` + `go test`
|
|
- On tags: build and push Docker image to `git.archfox.org/poslop/palette`
|
|
|
|
## Docker Compose
|
|
|
|
See [docker-compose.yml](docker-compose.yml) for a ready-to-use example with
|
|
every environment variable documented, including which are required (only the
|
|
/data volume) and which are optional.
|
|
|
|
## License
|
|
|
|
Palette is licensed under the GNU Affero General Public License v3.0
|
|
(AGPL-3.0-only). See [LICENSE](LICENSE).
|
|
|
|
The software is provided AS IS, without warranty of any kind, express or
|
|
implied, including merchantability and fitness for a particular purpose.
|
|
In no event shall the authors be liable for any claim, damages, or other
|
|
liability, including without limitation any security vulnerabilities,
|
|
data loss, or legal issues arising from use of the software. You use it
|
|
at your own risk.
|
|
|
|
If you run a modified version of Palette as a network service, the AGPL
|
|
requires you to offer your modified source code to its users.
|