Rook is a open source bookmark service built to provide a performant solution to organize, tag and search bookmarks. Rook bundles a database (sqlite3) with a Java API server and lightweight web application.
alpha container images have been published and can be pulled from:
docker pull ghcr.io/thesummitdev/rook:arm
docker pull ghcr.io/thesummitdev/rook:latest
For sample configuration see the docker-compose.yml in this repo.
To persist data between containers, make sure to bind a volume to the $DATA path.
It is recommended to use $DATA=/data/rook and use a volume mount for /data inside the container.
With such a setup, when the container is stopped (i.e. if a new version of the container is pulled)
and later restart the application's configuration and data will not be lost.
- A single deployment can support multiple unique users whom can all store their own bookmarks and tagging metadata.
- A container based deployment means updating to a new version is as simple as pulling the latest container image. With a built in automatic database migrations managed by the rook server.
- If this project interests you contact me on Mastodon: @tylersaunders@fosstodon.org
- Good first issues are marked in the issue tracker if you are looking to contribute.
- Initial inspiration was drawn from sites such as pinboard.
- Icons are provided courtesy of the excellent tabler-icons.io.
- GNU GPL v3
- Copyright 2021-2023 thesummit.dev