yadunut/clan-core
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
Files
29c764773f79b939ce19e4c1c5949b8266db6f86
clan-core/clanModules/syncthing
History
hsjobeki 341f444fa0 revert bd3861c580 
revert Merge pull request 'Remove clanModules/*' (#4202) from remove-modules into main

Reviewed-on: https://git.clan.lol/clan/clan-core/pulls/4202

See: https://git.clan.lol/clan/clan-core/issues/4365

Not all modules are migrated.
If they are not migrated, we need to write migration docs and please display the link to the migration docs
2025-07-15 17:51:36 +00:00
..
roles
revert bd3861c580
2025-07-15 17:51:36 +00:00
default.nix
revert bd3861c580
2025-07-15 17:51:36 +00:00
README.md
revert bd3861c580
2025-07-15 17:51:36 +00:00
shared.nix
revert bd3861c580
2025-07-15 17:51:36 +00:00

README.md

description = "A secure, file synchronization app for devices over networks, offering a private alternative to cloud services." features = [ "inventory" ] [constraints] roles.introducer.min = 1 roles.introducer.max = 1

Warning: This module was written with our VM integration in mind likely won't work outside of this context. They will be generalized in future.

Usage

We recommend configuring this module as an sync-service through the provided options. Although it provides a Web GUI through which more usage scenarios are supported.

Features

  • Private and Secure: Syncthing uses TLS encryption to secure data transfer between devices, ensuring that only the intended devices can read your data.
  • Decentralized: No central server is involved in the data transfer. Each device communicates directly with others.
  • Open Source: The source code is openly available for audit and contribution, fostering trust and continuous improvement.
  • Cross-Platform: Syncthing supports multiple platforms including Windows, macOS, Linux, BSD, and Android.
  • Real-time Synchronization: Changes made to files are synchronized in real-time across all connected devices.
  • Web GUI: It includes a user-friendly web interface for managing devices and configurations. (127.0.0.1:8384)

Configuration

  • Share Folders: Select folders to share with connected devices and configure permissions and synchronization parameters.

!!! info Clan automatically discovers other devices. Automatic discovery requires one machine to be an introducer

If that is not the case you can add the other device by its Device ID manually.
You can find and share Device IDs under the "Add Device" button in the Web GUI. (`127.0.0.1:8384`)

Troubleshooting

  • Sync Conflicts: Resolve synchronization conflicts manually by reviewing file versions and modification times in the Web GUI (127.0.0.1:8384).

Support