2021-02-13 09:47:04 +00:00
2018-03-11 18:02:58 +00:00
# Nextcloud Bookmarks
2020-03-31 14:48:19 +00:00
![Downloads ](https://img.shields.io/github/downloads/nextcloud/bookmarks/total.svg?style=flat-square )
[![Code coverage ](https://img.shields.io/codecov/c/github/nextcloud/bookmarks.svg?style=flat-square )](https://codecov.io/gh/nextcloud/bookmarks/)
[![Dependabot status ](https://img.shields.io/badge/Dependabot-enabled-brightgreen.svg?longCache=true&style=flat-square&logo=dependabot )](https://dependabot.com)
2013-04-12 18:30:19 +00:00
2017-04-06 13:13:24 +00:00
![](https://github.com/nextcloud/bookmarks/raw/master/screenshots/Bookmarks.png)
2018-03-11 18:02:58 +00:00
> Bookmarks app for Nextcloud
2017-02-10 20:31:10 +00:00
2020-10-12 12:04:09 +00:00
This app provides you with a web interface for collecting and organizing bookmarks to the places on the web that are precious to you.
2022-03-12 11:05:27 +00:00
- 📂 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
2022-03-11 14:50:40 +00:00
- 💬 Create new bookmarks directly from within Nextcloud Talk
2022-03-12 11:05:27 +00:00
- 💼 Built-in Dashboard widgets for frequent and recent links
2020-10-12 12:04:09 +00:00
## Third-party clients
### Android
2021-03-21 17:56:26 +00:00
- [Nextcloud Bookmarks ](https://gitlab.com/bisada/OCBookmarks ) - client app for Android ([Amazon Appstore](https://www.amazon.com/dp/B08L5RKHMM/ref=apps_sf_sta)/[F-Droid](https://f-droid.org/packages/org.schabi.nxbookmarks))
2020-10-12 12:04:09 +00:00
- [NCBookmark ](https://gitlab.com/lenchan139/NCBookmark ) - Android App
2021-07-06 16:43:56 +00:00
- Bookmarks for Nextcloud - client app for Android (phone and tablet) with folders, tags, search, sync ([Google Play Store - Bookmarks for Nextcloud](https://play.google.com/store/apps/details?id=de.emasty.bookmarks))
2022-06-14 15:43:55 +00:00
- [Floccus ](https://floccus.org ) - Bookmark sync as Browser extension for Firefox/Chromium-based browsers, Android & iOS Apps
2020-10-12 12:04:09 +00:00
### Browser
2021-06-09 16:53:10 +00:00
- [Owncloud Bookmarks ](https://chrome.google.com/webstore/detail/owncloud-bookmarks/eomolhpeokmbnincelpkagpapjpeeckc ) - Bookmarks extension for Chromium-based browsers (Chromium/Chrome/Opera/Vivaldi)
2022-06-14 15:43:55 +00:00
- [Floccus ](https://floccus.org/ ) - Bookmark sync as Browser extension for Firefox/Chromium-based browsers, Android & iOS Apps
2020-10-12 12:04:09 +00:00
- [FreedomMarks ](https://github.com/damko/freedommarks-browser-webextension ) - Addon for Firefox and Chrome. No sync, just a client.
2021-10-21 21:46:41 +00:00
- [add-nextcloud-bookmarks ](https://github.com/qutebrowser/qutebrowser/blob/master/misc/userscripts/README.md ) - qutebrowser userscript that allows for easy bookmark creation
2020-10-12 12:04:09 +00:00
### Desktop
- [Nextcloud Bookmark Manager ](https://www.midwinter-dg.com/mac-apps/nextcloud-bookmark-manager.html ) A MacOS client
- [QOwnNotes ](https://www.qownnotes.org/ ) - Plain-text file markdown note taking desktop application (no sync, just importing bookmarks)
### iOS
2021-06-09 16:53:10 +00:00
- [Nextbookmark ](https://gitlab.com/altepizza/nextbookmark ) - A minimal client for iOS ([App Store entry](https://apps.apple.com/app/nextbookmark/id1500340092))
2021-10-19 07:17:57 +00:00
- [Onion Browser ](https://onionbrowser.com ) - Tor browser support syncing ([App Store entry](https://apps.apple.com/app/onion-browser/id519296448))
2022-06-14 15:43:55 +00:00
- [Floccus ](https://floccus.org ) - Bookmark sync as Browser extension for Firefox/Chromium-based browsers, Android & iOS Apps
2020-10-12 12:04:09 +00:00
### Other
- [uMarks ](https://open-store.io/app/umarks.ernesst ) - App for Ubuntu touch
2019-12-13 19:06:23 +00:00
## Community
2021-02-13 09:47:04 +00:00
Talk to us on [gitter ](https://gitter.im/nextcloud-bookmarks/community ), via matrix `#nextcloud-bookmarks_community:gitter.im` or in our [official Talk channel ](https://cloud.nextcloud.com/call/u52jcby9 )
2017-02-10 20:31:10 +00:00
2018-03-11 18:02:58 +00:00
## Install
2019-09-04 10:50:47 +00:00
2019-09-14 15:09:38 +00:00
### Requirements
2020-10-12 12:04:09 +00:00
- php 7.3 and above
2019-09-14 15:09:38 +00:00
PHP extensions:
2019-07-21 13:49:22 +00:00
- intl: \*
- mbstring: \*
2018-03-11 18:02:58 +00:00
### One-click
2018-12-14 14:19:24 +00:00
2018-06-16 20:08:04 +00:00
Install this app in the app store of your nextcloud instance (you must have administrator privileges). You will find it in the 'Organization' category.
2017-02-10 20:31:10 +00:00
2018-03-11 18:02:58 +00:00
### Manual install
2018-12-14 14:19:24 +00:00
2018-03-11 18:02:58 +00:00
#### Dependencies
2018-12-14 14:19:24 +00:00
- [git ](https://git-scm.org/ )
- [Node.js and npm ](https://nodejs.org/ )
2022-04-15 09:22:06 +00:00
- [php ](https://php.net/ ), extension dom and tokenizer
2020-01-08 07:56:18 +00:00
- [composer ](https://getcomposer.org/ )
2017-02-10 20:31:10 +00:00
2018-03-11 18:02:58 +00:00
#### Setup
2018-12-14 14:19:24 +00:00
2017-11-19 15:16:22 +00:00
```
2018-03-11 18:02:58 +00:00
cd /path/to/nextcloud/apps/
git clone https://github.com/nextcloud/bookmarks.git
2018-03-11 18:01:12 +00:00
cd bookmarks
composer install
npm install
npm run build
2017-11-19 15:16:22 +00:00
```
2018-03-11 18:02:58 +00:00
## API
2018-12-14 14:19:24 +00:00
2018-03-11 18:02:58 +00:00
This app exposes a public REST API that third-party clients can interface with.
2017-11-19 15:16:22 +00:00
2019-09-14 23:30:02 +00:00
[Head over to the API docs ](https://nextcloud-bookmarks.readthedocs.io/en/latest/ ).
2017-02-10 20:31:10 +00:00
2018-03-11 18:02:58 +00:00
## Maintainers
2018-12-14 14:19:24 +00:00
2018-03-11 18:02:58 +00:00
- [Marcel Klehr ](https://github.com/marcelklehr )
2017-02-10 21:16:08 +00:00
2019-09-04 10:50:47 +00:00
## Donate
If you'd like to support the creation and maintenance of this software, consider donating.
2020-10-12 12:04:09 +00:00
| [<img src="https://img.shields.io/badge/paypal-donate-blue.svg?logo=paypal&style=for-the-badge"> ](https://www.paypal.me/marcelklehr1 ) | [<img src="http://img.shields.io/liberapay/receives/marcelklehr.svg?logo=liberapay&style=for-the-badge"> ](https://liberapay.com/marcelklehr/donate ) |[< img src = "https://img.shields.io/badge/github-sponsors-violet.svg?logo=github&style=for-the-badge" > ](https://github.com/sponsors/marcelklehr) |
| :-----------------------------------------------------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------------------------------------------------------------------: |:--:|
2019-09-04 10:50:47 +00:00
2018-03-11 18:02:58 +00:00
## Contribute
2018-12-14 14:19:24 +00:00
2019-12-13 19:06:23 +00:00
We always welcome contributions. Have an issue or an idea for a feature? Let us know. Additionally, we happily accept pull requests.
2017-02-10 21:16:08 +00:00
2018-03-11 18:02:58 +00:00
In order to make the process run more smoothly, you can make sure of the following things:
2017-02-10 21:16:08 +00:00
2018-12-14 14:19:24 +00:00
- 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
2017-02-10 21:16:08 +00:00
2018-03-11 18:02:58 +00:00
Please read the [Code of Conduct ](https://nextcloud.com/community/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.
2017-02-10 21:16:08 +00:00
2018-03-11 18:02:58 +00:00
More information on how to contribute: https://nextcloud.com/contribute/
2017-02-10 21:16:08 +00:00
2018-03-11 18:02:58 +00:00
Happy hacking :heart:
2014-11-25 21:43:48 +00:00
2018-03-11 18:02:58 +00:00
## License
2018-12-14 14:19:24 +00:00
2018-03-11 18:02:58 +00:00
This software is licensed under the terms of the AGPL written by the Free Software Foundation and available at [COPYING ](./COPYING ).