bookmarks/README.md

6.1 KiB

Nextcloud Bookmarks

Downloads Code coverage Dependabot status

Bookmarks app for Nextcloud

This app provides you with a web interface for collecting and organizing bookmarks to the places on the web that are precious to you.

  • 📂 Sort bookmarks into folders
  • 🏷 Add tags and personal notes
  • 🔍 Full-text search
  • 📲 Synchronize with all your browsers and devices
  • 👪 Share bookmarks with other users and publicly
  • ☠ Find broken links
  • ⚛ Generate RSS feeds of your collections
  • 📔 Read archived versions of your links in case they are depublished
  • 💬 Create new bookmarks directly from within Nextcloud Talk
  • 💼 Built-in Dashboard widgets for frequent and recent links

Third-party clients

Android

Browser

  • Owncloud Bookmarks - Bookmarks extension for Chromium-based browsers (Chromium/Chrome/Opera/Vivaldi)
  • Floccus - Bookmark sync as Browser extension for Firefox/Chromium-based browsers, Android & iOS Apps
  • FreedomMarks - Addon for Firefox and Chrome. No sync, just a client.
  • add-nextcloud-bookmarks - qutebrowser userscript that allows for easy bookmark creation

Desktop

iOS

Other

  • uMarks - App for Ubuntu touch

Community

Talk to us on gitter, via matrix #nextcloud-bookmarks_community:gitter.im or in our official Talk channel

Install

Requirements

  • php 7.3 and above

PHP extensions:

  • intl: *
  • mbstring: *

One-click

Install this app in the app store of your nextcloud instance (you must have administrator privileges). You will find it in the 'Organization' category.

Manual install

Dependencies

Setup

cd /path/to/nextcloud/apps/
git clone https://github.com/nextcloud/bookmarks.git
cd bookmarks
composer install
npm install
npm run build

API

This app exposes a public REST API that third-party clients can interface with.

Head over to the API docs.

Maintainers

Donate

If you'd like to support the creation and maintenance of this software, consider donating.

Contribute

We always welcome contributions. Have an issue or an idea for a feature? Let us know. Additionally, we happily accept pull requests.

In order to make the process run more smoothly, you can make sure of the following things:

  • Announce that you're working on a feature/bugfix in the relevant issue
  • Make sure the tests are passing
  • If you have any questions you can let the maintainers above know privately via email, or simply open an issue on github

Please read the Code of Conduct. This document offers some guidance to ensure Nextcloud participants can cooperate effectively in a positive and inspiring atmosphere, and to explain how together we can strengthen and support each other.

More information on how to contribute: https://nextcloud.com/contribute/

Happy hacking ❤️

License

This software is licensed under the terms of the AGPL written by the Free Software Foundation and available at COPYING.