floccusaddon/floccus: :cloud: Sync your bookmarks privately across browsers and devices

Floccus

Sync your bookmarks privately across browsers and devices

🔖 Syncs your real, native browser bookmarks directly
☸ Sync via Nextcloud Bookmarks, Linkwarden, KaraKeep, Google Drive, Dropbox, any Git server (like GitHub, Gitlab, Gitea, etc.) or any WebDAV-compatible service
⚛ Use any browser that supports Web extensions (e.g. Firefox, Chrome, Edge, Opera, Brave, Vivaldi,…; Safari not yet)
📲 Install the floccus Android/iOS app to access your bookmarks on your phone (Most mobile browsers do not support floccus, sadly)
💼 Create as many sync profiles as you need
🚚 Control sync strategy (i.e. uni- or bidirectional), ⏳ sync interval and 📂 synced folder
📦 Easily export your configuration

This is the SHA-256 fingerprint of the certificate used to sign the floccus APKs:

ffed2778ff07371e6367b6dcf5d7c1327c57ff7158b8444029182a9aa2dd7085

If you’d like to support the creation and maintenance of this software, please consider donating.:)

🎬 Getting started

If you don’t know how to start with Floccus, read these guides.

If you need help, talk to us on gitter, matrix (#marcelklehr_floccus:gitter.im), in the official Nextcloud Bookmarks talk channel or on r/floccus on reddit 👋

Troubleshooting

Emojis: MySQL doesn’t support emojis out of the box, so if you’re syncing to nextcloud and getting Error code 500 from nextcloud, check the nextcloud log for SQL errors and proceed as explained in the nextcloud docs if you get charset errors.

If you need help sorting out problems, try the gitter chat room: https://gitter.im/marcelklehr/floccus

Considerations

Is this a good idea? I think so. If you’d like to know more, check out the considerations file

What’s with the name?

Cirrus floccus is a type of cloud, that ~~can sync your browser data~~ looks very nice.

Contributors

This project exists thanks to all the people who contribute.

_{Bernd Wechner} 🐛 🤔 ⚠️	_jlbprof 💻 🐛 ⚠️	_TeutonJon78 🐛 🤔	_{Scott P.} 🐛 🤔	_Lantizia 🐛 🤔	_TCB13 💻 🤔 🔌 🌍	_gohrner 🐛
_Tank-Missile 🐛	_{Torsten Kurbad} 🐛	_gerroon 🐛	_{Matija Nalis} 🤔 💬 🐛	_{Marcel Klehr} 💬 💻 🖋 🎨 📖 🚇 📆	_binsee 💻	_{Marc Shapiro} 💻
_{Marllus Lustosa} 💻	_Izzy 🐛 🤔 🚇	_sunjam 🤔 ⚠️	_{Danny Siminiuk} ⚠️ 🤔	_Seirade 🤔 🐛	_pinpontitit 🤔 🐛 💻	_Motte 💻 🐛
_macrogreg 💻	_{Andy Balaam} 💻 🐛	_Balthanon 🤔 🐛

This project follows the all-contributors specification.

Contribute

All contributions, code, feedback and strategic advice, are welcome. If you have a question you can open an issue on the repository, talk to us on gitter, matrix (#marcelklehr_floccus:gitter.im), in the official Nextcloud Bookmarks talk channel or on r/floccus on reddit. I’m also always happy for people helping me test new features — see the issues for announcements of beta versions.

Translating

Translations can now be provided over at transifex.

Development

Setting up a dev environment

Clone this repository.
Install the latest LTS version of node.js.
In the root of your floccus repo, run npm install.
Run npm run build to build.
Find out more on how to develop browser extensions here: https://extensionworkshop.com/.

For building the android app you’ll need Android Studio

Open the android/ folder in Android studio and build the App like any other Android app.
npm run build and npm run watch will push changes to android/ as necessary.

Building

npm run build

Run the following to automatically compile changes as you make them:

npm run watch

Releasing

npm run build-release

Windows-specific considerations

Follow the above general guidance on setting up a dev environment.
There are Windows-specific versions of some npm scripts:

build: npm run build-win
build-release: npm run build-release-win
watch: watch-win

When building for the first time you may get an error about gulp not being found.
You can install gulp globally on your system by executing npm install -g gulp from your repo root. It is recommended that you do this proactively after executing npm install in the repo root for the first time.

Running the browser extension and corresponding tests locally

Build the browser extension:
npm run build-release
(npm run build-release-win if you use Windows)
After a successful build, the extension package will be found in:
RepoRoot/builds/
The following steps use Firefox as an example; other browsers work similarly.
The Firefox extension package is a file with an .xpi -extension. It is a simple archive. To modify it, you can rename it to .zip, make the changes, and then rename it back to .xpi. Many archive-related tools know this and allow you to work with the .xpi -file directly (e.g. Total Commander).
Enable the extension package for local testing:
By default, tests are not included into the release archive. To run tests in your local browser, copy the file
RepoRoot/dist/js/test.js
into the release package, so that it is located at
FloccusPackage.xpi/dist/js/test.js
Open Firefox using a dedicated test-profile:
If you use your main profile for testing, the test scripts will likely destroy your existing bookmarks and open tabs!
To interact with profiles, go to this address:
about:profiles
Load the extension:
In the a dedicated Firefox profile window, go to
about:debugging
Select “This Firefox”, and then under “Temporary Extensions”, select “Load Temporary Add-on…”. Then select the .xpi -file you prepared earlier.
(Remember to unload the extension if you need to modify/rebuild the extension package.)
The extension is now loaded. You can access it via the browser’s extensions menu.
Run tests:
After loading the extension, click on “Manifest URL”. It will open a new tab with the URL moz-extension://SomeGuid/manifest.json Modify the URL to read
moz-extension://SomeGuid/dist/html/test.html
, keeping the same GUID and press enter. The test run should start automatically.
Debug or pause tests:
Press F12 to open developer tools.
On the “Debugger” tab, you can pause the execution, set breakpoints and step through the code.

Happy developing and thank you for your contributions!