{"id":15136186,"url":"https://github.com/aleskandro/nextcloud-kobo","last_synced_at":"2025-10-23T11:31:15.488Z","repository":{"id":255263983,"uuid":"849046391","full_name":"aleskandro/nextcloud-kobo","owner":"aleskandro","description":"Nextcloud Sync Daemon for Kobo eReaders","archived":false,"fork":false,"pushed_at":"2025-01-15T14:14:12.000Z","size":55,"stargazers_count":7,"open_issues_count":2,"forks_count":2,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-30T18:05:43.871Z","etag":null,"topics":["kobo","kobo-ereader","nextcloud"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/aleskandro.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-08-28T22:01:29.000Z","updated_at":"2025-01-15T14:14:14.000Z","dependencies_parsed_at":"2024-09-04T09:15:33.607Z","dependency_job_id":null,"html_url":"https://github.com/aleskandro/nextcloud-kobo","commit_stats":null,"previous_names":["aleskandro/nextcloud-kobo"],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aleskandro%2Fnextcloud-kobo","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aleskandro%2Fnextcloud-kobo/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aleskandro%2Fnextcloud-kobo/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aleskandro%2Fnextcloud-kobo/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/aleskandro","download_url":"https://codeload.github.com/aleskandro/nextcloud-kobo/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":237821460,"owners_count":19371759,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["kobo","kobo-ereader","nextcloud"],"created_at":"2024-09-26T06:04:28.947Z","updated_at":"2025-10-23T11:31:15.484Z","avatar_url":"https://github.com/aleskandro.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Nextcloud Sync Daemon for Kobo eReaders\n\n![Go Version](https://img.shields.io/badge/go-1.23%2B-blue)\n![License](https://img.shields.io/github/license/aleskandro/nextcloud-kobo?)\n![Build Status](https://github.com/aleskandro/nextcloud-kobo/actions/workflows/build.yaml/badge.svg)\n![GitHub Downloads (all assets, latest release)](https://img.shields.io/github/downloads/aleskandro/nextcloud-kobo/latest/total?)\n\n## Overview\n\n**Nextcloud Sync Daemon for Kobo** is a Golang-based software designed to run on Kobo eReaders, allowing users to\nsynchronize a list of Nextcloud remote endpoints and folders back to a folder on the Kobo filesystem. This daemon is\nautomatically activated every time the Kobo device connects to the internet, ensuring that your files are always\nup-to-date.\n\nNote: This software has been tested only on the *Kobo Elipsa 2e*. While it may work on other Kobo devices, compatibility\nis not guaranteed.\n\n## Features\n\n- **Automatic Synchronization**: Syncs specified folders from Nextcloud to a designated folder on your Kobo eReader. The software relies on shares-as-webdav\n  every time it connects to the internet.\n- **Support for Multiple Remotes**: Manage and sync multiple Nextcloud endpoints and folders.\n- **Daemon Mode**: Runs quietly in the background as a daemon process.\n- **Efficient Syncing**: Downloads only updated or new files to minimize data usage and speed up synchronization.\n\n## Installation\n\nTo install the Nextcloud Sync Daemon on your Kobo eReader, follow these steps:\n\n### Prerequisites\n\n## Dependencies\n \n- [NickelDBus](https://github.com/shermp/NickelDBus)\n\n### Steps\n\n1. **Download the KoboRoot.tgz**: Go to the [releases page](https://github.com/aleskandro/kobo-nextcloud/releases) and\n   download the latest release with your Kobo device.\n\n2. **Transfer the binary to your Kobo**: Connect your Kobo eReader to your computer via USB and copy the downloaded\n   file to the Kobo's internal storage at `(/mnt/onboard).kobo/KoboRoot.tgz`.\n\n3. **Configure the daemon**:\n   The daemon reads the configuration from `(/mnt/onboard).adds/nextcloud-kobo/config.yaml`.\n   Here is an example configuration:\n\n```yaml\nautoUpdate: true # Automatically update the daemon from the GitHub release page\nremotes:\n- url: https://nextcloud.jdoe.com/s/abc123\n  local_path: share1/\n- url: https://nextcloud.jdoe.com/\n  username: john # Do not set if using a share link\n  password: doe\n  remote_folder: /my-remote-folder/ # Do not set if using a share link\n  local_path: share2/\n- url: https://nextcloud.jdoe.com/s/abc123\n  password: doe\n  local_path: share3/\n```\n\n4. **Reboot your Kobo**: Safely eject your Kobo device from your computer and reboot it to apply the changes.\n\n5. If the configuration is correct, you will get a message in the UI when the synchronization is complete.\n\n## Usage\n\nOnce installed and configured, the Nextcloud Sync Daemon will automatically sync the specified folders every time your\nKobo eReader connects to the internet.\n\n### Logs\n\nLogs are generated in the `/mnt/onboard/.adds/nextcloud-kobo/nextcloud-kobo.log` directory on your Kobo device. \n\n## Configuration\n\nThe `config.yaml` file is the core configuration file for this daemon.\n\n### Configuration Options\n\n- **auto_update**: If set to `true`, the daemon will automatically update from the GitHub release page after the first run.\n- **repo_owner**: defaults to `aleskandro` and used as the source for the repo owner of the automatic updates (override if forking).\n- **repo_name**: defaults to `nextcloud-kobo` and used as the source for the repo name of the automatic updates (override if forking).\n- **remotes**: a list of Nextcloud remotes to sync with the Kobo device.\n\n## Uninstallation\n\nTo uninstall the Nextcloud Sync Daemon, create an empty file named `UNINSTALL` in the `/mnt/onboard/.adds/nextcloud-kobo/` folder.\n\n#### Remote Options\n\n- **URL**: The Nextcloud share link for the folder you want to sync or the nextcloud URL for user-password authentication.\n- **userName**: Your Nextcloud username. Leave empty if you are using a share link.\n- **password**: Your Nextcloud password or the share link password.\n- **remoteFolder**: The folder on the Nextcloud server that you want to sync. Leave empty if you are using a share link.\n- **localPath**: The path on your Kobo device where the files will be synchronized. It is a relative path that will be\n created in the `/mnt/onboard/nextcloud` directory.\n\n## Contributing\n\nWe welcome contributions! To contribute to the project:\n\n1. Fork the repository.\n2. Create a new branch for your feature or bugfix.\n3. Commit your changes and push them to your fork.\n4. Open a pull request detailing your changes.\n\nPlease make sure to update tests as appropriate and adhere to the code style.\n\n### Requirements\n\n- [Docker](https://docs.docker.com/get-docker/) or [Podman](https://podman.io/getting-started/installation)\n- [Go](https://golang.org/doc/install)\n- [Make](https://www.gnu.org/software/make/)\n\n### Running Tests\n\nTo run the tests, execute the following command:\n\n```bash\nmake static\nmake test\n```\n\n### Building\n\nTo build the project, execute the following command:\n\n```bash\nmake koboroot\n```\n\nThe output KoboRoot.tgz file will be located in the `_artifacts` directory.\n\n## License\n\nThis project is licensed under the Apache License - see the [LICENSE](LICENSE) file for details.\n\n## Support\n\nIf you encounter any issues or have questions, please open an issue on this GitHub repository.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faleskandro%2Fnextcloud-kobo","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faleskandro%2Fnextcloud-kobo","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faleskandro%2Fnextcloud-kobo/lists"}