Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/asciimoo/omnom
A webpage bookmarking and snapshotting service
https://github.com/asciimoo/omnom
Last synced: 4 days ago
JSON representation
A webpage bookmarking and snapshotting service
- Host: GitHub
- URL: https://github.com/asciimoo/omnom
- Owner: asciimoo
- License: agpl-3.0
- Created: 2021-04-19T15:50:17.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2023-05-15T09:26:36.000Z (over 1 year ago)
- Last Synced: 2024-04-14T19:54:19.888Z (7 months ago)
- Language: Go
- Size: 3.7 MB
- Stars: 24
- Watchers: 6
- Forks: 5
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Omnom
A webpage bookmarking and snapshotting service.
Omnom consists of two parts; a multi-user web application that accepts bookmarks and snapshots and a browser extension responsible for bookmark and snapshot creation.
Omnom is a rebooted implementation of @stef's original omnom project, big thanks for it.
## Requirements
go >= 1.14
## Setup & run
- Checkout the repo and execute `go get -u`
- Copy `config.yml_sample` to `config.yml`
- Execute `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.
### 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
- [Firefox](https://addons.mozilla.org/en-US/firefox/addon/omnom/)
- [Chrome/Chromium](https://chrome.google.com/webstore/detail/omnom/nhpakcgbfdhghjnilnbgofmaeecoojei)
## Bugs
Bugs or suggestions? Visit the [issue tracker](https://github.com/asciimoo/omnom/issues) or join our [discord server](https://discord.gg/GAh4RCruh6)
## License
AGPLv3
## Funding
This project is funded through [NGI Zero Core](https://nlnet.nl/core), a fund established by [NLnet](https://nlnet.nl) with financial support from the European Commission's [Next Generation Internet](https://ngi.eu) program. Learn more at the [NLnet project page](https://nlnet.nl/project/Omnom-ActivityPub).
[
](https://nlnet.nl)
[
](https://nlnet.nl/core)