| Davide Pesavento | a0546db | 2020-04-01 19:18:04 -0400 | [diff] [blame] | 1 | # ChronoSync: synchronization library for distributed realtime applications for NDN |
| Alexander Afanasyev | 7c97cfa | 2014-07-02 12:10:13 -0700 | [diff] [blame] | 2 | |
| Davide Pesavento | 22eeb29 | 2021-10-01 21:20:53 -0400 | [diff] [blame] | 3 | [](https://github.com/named-data/ChronoSync/actions/workflows/ci.yml) |
| 4 | [](https://github.com/named-data/ChronoSync/actions/workflows/docs.yml) |
| Davide Pesavento | 54bf15a | 2022-07-26 03:23:32 -0400 | [diff] [blame] | 5 |  |
| Davide Pesavento | 22eeb29 | 2021-10-01 21:20:53 -0400 | [diff] [blame] | 6 |  |
| Nick Gordon | dc88507 | 2017-12-21 14:18:49 -0600 | [diff] [blame] | 7 | |
| Davide Pesavento | 8560103 | 2023-02-14 03:02:02 -0500 | [diff] [blame] | 8 | > DEPRECATION NOTICE: ChronoSync's design is outdated. We recommend using more recent sync protocols, such as [PSync](https://github.com/named-data/PSync) or [StateVectorSync](https://named-data.github.io/StateVectorSync/). |
| Philipp Moll | 96b9a1d | 2021-02-26 22:13:55 +0100 | [diff] [blame] | 9 | |
| Alexander Afanasyev | 7c97cfa | 2014-07-02 12:10:13 -0700 | [diff] [blame] | 10 | In supporting many distributed applications, such as group text messaging, file sharing, |
| 11 | and joint editing, a basic requirement is the efficient and robust synchronization of |
| 12 | knowledge about the dataset such as text messages, changes to the shared folder, or |
| Davide Pesavento | c2489b4 | 2017-10-28 17:19:08 -0400 | [diff] [blame] | 13 | document edits. This library implements the |
| 14 | [ChronoSync protocol](https://named-data.net/wp-content/uploads/2014/03/chronosync-icnp2013.pdf), |
| Alexander Afanasyev | 7c97cfa | 2014-07-02 12:10:13 -0700 | [diff] [blame] | 15 | which exploits the features of the Named Data Networking architecture to efficiently |
| 16 | synchronize the state of a dataset among a distributed group of users. Using appropriate |
| 17 | naming rules, ChronoSync summarizes the state of a dataset in a condensed cryptographic |
| 18 | digest form and exchange it among the distributed parties. Differences of the dataset can |
| 19 | be inferred from the digests and disseminated efficiently to all parties. With the |
| 20 | complete and up-to-date knowledge of the dataset changes, applications can decide whether |
| 21 | or when to fetch which pieces of the data. |
| 22 | |
| Davide Pesavento | a0546db | 2020-04-01 19:18:04 -0400 | [diff] [blame] | 23 | ChronoSync uses the [ndn-cxx](https://github.com/named-data/ndn-cxx) library. |
| Alexander Afanasyev | 7c97cfa | 2014-07-02 12:10:13 -0700 | [diff] [blame] | 24 | |
| Davide Pesavento | a0546db | 2020-04-01 19:18:04 -0400 | [diff] [blame] | 25 | ## Installation |
| Alexander Afanasyev | 7c97cfa | 2014-07-02 12:10:13 -0700 | [diff] [blame] | 26 | |
| 27 | ### Prerequisites |
| 28 | |
| Davide Pesavento | 8560103 | 2023-02-14 03:02:02 -0500 | [diff] [blame] | 29 | * [ndn-cxx and its dependencies](https://docs.named-data.net/ndn-cxx/current/INSTALL.html) |
| Alexander Afanasyev | 7c97cfa | 2014-07-02 12:10:13 -0700 | [diff] [blame] | 30 | |
| 31 | ### Build |
| 32 | |
| Davide Pesavento | 8560103 | 2023-02-14 03:02:02 -0500 | [diff] [blame] | 33 | To build ChronoSync from source: |
| Alexander Afanasyev | 7c97cfa | 2014-07-02 12:10:13 -0700 | [diff] [blame] | 34 | |
| 35 | ./waf configure |
| 36 | ./waf |
| 37 | sudo ./waf install |
| 38 | |
| Davide Pesavento | 2ff1056 | 2023-02-19 20:14:06 -0500 | [diff] [blame] | 39 | To build on memory constrained systems, please use `./waf -j1` instead of `./waf`. This |
| 40 | will disable parallel compilation. |
| Yingdi Yu | e042f83 | 2015-02-09 14:52:59 -0800 | [diff] [blame] | 41 | |
| Davide Pesavento | a0546db | 2020-04-01 19:18:04 -0400 | [diff] [blame] | 42 | If configured with tests (`./waf configure --with-tests`), the above commands will also |
| Davide Pesavento | 2ff1056 | 2023-02-19 20:14:06 -0500 | [diff] [blame] | 43 | build a suite of unit tests that can be run with `./build/unit-tests`. |
| Davide Pesavento | a0546db | 2020-04-01 19:18:04 -0400 | [diff] [blame] | 44 | |
| 45 | ## Reporting bugs |
| 46 | |
| 47 | Please submit any bug reports or feature requests to the |
| 48 | [ChronoSync issue tracker](https://redmine.named-data.net/projects/chronosync/issues). |
| 49 | |
| 50 | ## Contributing |
| 51 | |
| Davide Pesavento | 2ff1056 | 2023-02-19 20:14:06 -0500 | [diff] [blame] | 52 | Contributions to ChronoSync are greatly appreciated and can be made through our |
| 53 | [Gerrit code review site](https://gerrit.named-data.net/). |
| Davide Pesavento | 8560103 | 2023-02-14 03:02:02 -0500 | [diff] [blame] | 54 | If you are new to the NDN software community, please read our [Contributor's Guide]( |
| 55 | https://github.com/named-data/.github/blob/main/CONTRIBUTING.md) to get started. |
| Davide Pesavento | a0546db | 2020-04-01 19:18:04 -0400 | [diff] [blame] | 56 | |
| 57 | ## License |
| 58 | |
| Davide Pesavento | 8560103 | 2023-02-14 03:02:02 -0500 | [diff] [blame] | 59 | ChronoSync is free software distributed under the GNU General Public License version 3. |
| 60 | See [`COPYING.md`](COPYING.md) for details. |