asciimoo/omnom

Omnom

A web content preservation service

• Bookmark with website snapshots
• Aggregate feeds
• Follow ActivityPub streams

Check out our wiki for more information.

Features

• Self hosted
• Bookmarking
• RSS reader
• Fediverse/ActivityPub support
• Websites are captured as your browser renders it - saves the displayed content of dynamic pages as well
• Multiple snapshots of the same URL with resource summary and compare/diff views
• Web interface with multiuser support
• Locally saved multimedia content
• Flexible filtering - by date, free text search in content, tags, users, domains, URLs, etc..
• Documented API

Browser addon

Omnom browser addon is available for

• Firefox
• Chrome/Chromium

Installation

Single file binary release is available here. (Don't forget to chmod +x)

Docker image is also available available, more details here.

Local build

go >= 1.24 required

• Checkout the repo and execute go get -u in the root directory
• Run go build

Setup & run

• Run ./omnom help to list the available commands
• Execute ./omnom listen to start the web application

Configuration

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

Execute ./omnom create-config config.yml to generate a configuration file with the default configuration values.

Session cookies are signed with a key derived using HKDF-SHA256 from the configured ActivityPub private key (activitypub.privkey, default ./private.pem). No separate session secret is needed. Omnom generates the key pair on first startup. Keep the private key protected and persistent across restarts; Docker deployments should persist /omnom/config, which contains the key pair by default.

Upgrading from the old shared cookie signing key signs all users out once. Replacing the private key also invalidates login sessions and changes the ActivityPub identity key. Replicas of one deployment must use the same private key to accept each other's session cookies.

User handling

Omnom does not store passwords. Login requires one time login token, OAuth, or a remote user header.

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.

If you use Omnom behind a reverse proxy with authentication, you can pass the logged-in username in an HTTP header like Remote-User to automatically log in. Omnom can be configured to trust the header by setting the remote_user_header option in config.yml. Remote user header authentication can't be used with OAuth or open signups.

Command line tool

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

Available Commands

  create-bookmark      create new bookmark
  create-config        create default configuration file
  create-token         create new login/addon token for a user
  create-user          create new user
  diff-html            diff-html FILE1 FILE2
  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-unread          show unread details
  show-user            show user details
  update-feeds         update RSS/Atom feeds
  validate-html        validate-html FILE
  completion           Generate the autocompletion script for the specified shell

Translations

To contribute to localizations, please visit our weblate

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.