32 lines
1.2 KiB
ReStructuredText
32 lines
1.2 KiB
ReStructuredText
.. unisync documentation master file, created by
|
|
sphinx-quickstart on Sun Jan 4 15:02:58 2026.
|
|
You can adapt this file completely to your liking, but it should at least
|
|
contain the root `toctree` directive.
|
|
|
|
Documentation for unisync
|
|
=========================
|
|
|
|
Unisync is a data synchronising tool built around `unison`_ and expending on it.
|
|
|
|
Unisync tries to solve two problems that are often solved separately but never together :
|
|
|
|
* Keeping your data synchronised between multiple machines (through a central server), examples of this are rsync and of course unison.
|
|
* Being able to access and edit files stored on your server without having to download them, the gui interface of nextcloud for example.
|
|
* And of course I want to be able to do all of this without ever having to leave my terminal.
|
|
|
|
Unisync solves this problem by placing each file on your local machine but with only the selected files and folders being physically present on your drive,
|
|
the others are replaced by symbolic links pointing to a directory that is mounted from your server.
|
|
|
|
See this
|
|
:ref:`example_how_it_works`.
|
|
|
|
.. _unison: https://github.com/bcpierce00/unison
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
:caption: Contents:
|
|
|
|
example
|
|
modules
|
|
|