Skip to content

asciimoo/omnom

Repository files navigation

Omnom

Bookmarking with website snapshots.

Access & share previously visited pages without worrying about modifications or availibilty.

Check out our wiki for more information.

Features

  • Self hosted
  • Web interface with multiuser support
  • Flexible filtering - by date, free text search in content, tags, users, domains, URLs, etc..
  • Private & public bookmarks
  • Multiple snapshots of the same URL
  • Documented API

Requirements

go >= 1.24

Setup & run

  • Checkout the repo and execute go get -u
  • Copy config.yml_sample to config.yml
  • Execute go build && ./omnom listen or go run omnom.go listen in the repo root

Settings can be configured in config.yml config file - don't forget to restart webapp after updating.

User handling

Omnom does not store passwords. Login requires one time login tokens or OAuth. Login tokens can be requested via email (this requires a valid SMTP configuration in config.yml) through the web interface or can be generated from command line using the ./omnom create-token [username] login.

Command line tool

Basic management actions are available using the command line tool (go run omnom.go or go build; ./omnom)

Available Commands

  create-token         create new login/addon token for a user
  create-user          create new user
  generate-api-docs-md Generate Markdown API documentation
  help                 Help about any command
  listen               start server
  set-token            set new login/addon token for a user
  show-user            show user details
  completion           Generate the autocompletion script for the specified shell

Browser addon

Omnom browser addon is available for

Bugs

Bugs or suggestions? Visit the issue tracker or join our discord server

License

AGPLv3

Funding

This project is funded through NGI Zero Core, a fund established by NLnet with financial support from the European Commission's Next Generation Internet program. Learn more at the NLnet project page.

NLnet foundation logo NGI Zero Logo