phoebe

command module
v0.5.0 Latest Latest
Warning

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

Go to latest
Published: Dec 9, 2025 License: MIT Imports: 1 Imported by: 0

README

phoebe

GitHub Actions Workflow Status Go Report Card GitHub License

project logo

a booru-style image gallery and organizer.

Built with the Go language and Svelte framework, phoebe is designed for personal image gathering.

Features

  • Upload and organize images
  • Basic tagging system
  • Search and autocomplete based on tags
  • Similarity search and duplicate detection using perceptual hash

Installation

The easiest way to get started is to use Docker:

docker pull damillora/phoebe
docker run -e POSTGRES_DATABASE=<PostgreSQL DSN> -e AUTH_SECRET=<secret> -e DATA_DIR=/data -e BASE_URL=http://localhost:8080 -p 8080:8080 -v "./data:/data" damillora/phoebe

Requirements

  • PostgreSQL database

Configuration

phoebe is configured using environment variables:

  • POSTGRES_DATABASE: DSN string of Postgres Database, see Gorm documentation
  • AUTH_SECRET: Secret used to sign JWTs
  • DATA_DIR: Data directory to store images
  • BASE_URL: Accesible URL of the instance
  • DISABLE_REGISTRATION: Optional, disable registration on the instance

Contributing

phoebe is still in an early stage, but contributions are welcome!

License

phoebe is licensed under the MIT license.

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
pkg
app
web

Jump to

Keyboard shortcuts

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