| # Persistent cache for Gerrit, based on ChronicleMap | |
| Non-blocking and super-fast on-disk cache libModule for [Gerrit Code Review](https://gerritcodereview.com) | |
| based on [ChronicleMap on-disk implementation](https://github.com/OpenHFT/Chronicle-Map). | |
| ## How to build | |
| This libModule is built like a Gerrit in-tree plugin, using Bazelisk. See the | |
| [build instructions](src/main/resources/Documentation/build.md) for more details. | |
| ## Setup | |
| * Install cache-chronicalmap module | |
| Install the chronicle-map module into the `$GERRIT_SITE/lib` directory. | |
| Add the cache-chroniclemap module to `$GERRIT_SITE/etc/gerrit.config` as follows: | |
| ``` | |
| [gerrit] | |
| installModule = com.googlesource.gerrit.modules.cache.chroniclemap.ChronicleMapCacheModule | |
| ``` | |
| For further information and supported options, refer to [config](src/main/resources/Documentation/config.md) | |
| documentation. | |
| ## Migration from H2 caches | |
| You can check how to migrate from H2 to chronicle-map [here](src/main/resources/Documentation/migration.md). |