Skip to content

Web application

Adam Tauber edited this page Nov 26, 2025 · 3 revisions

Omnom has a multi-user, web based service that can save and serve bookmarks/snapshots.

Output formats

Every endpoint has an additional JSON and RSS output. Add ?format=rss or ?format=json GET parameter to the URL to be able to fetch the non-HTML output formats of any endpoint.

Omnom.go

The web application is written in Golang and can be started by executing omnom.go with the listen argument. (go run omnom.go listen or go build omnom.go && ./omnom listen)

The executable provides the following actions:

Usage:
  omnom [command]

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

Flags:
      --config string   config file (default is config.yml) (default "config.yml")
  -d, --debug           turn on debug mode
  -h, --help            help for omnom
  -v, --version         version for omnom

Use "omnom [command] --help" for more information about a command.

Configuration

Configure Omnom by copying the config.yml_sample sample configuration file to config.yml and editing it.

Clone this wiki locally