Own packaging of Cryptpad

1 files changed, 27 insertions, 0 deletions

diff --git a/app/cryptpad/build/README.md b/app/cryptpad/build/README.md
index d5f5a5d..079d836 100644
--- a/app/cryptpad/build/README.md
+++ b/app/cryptpad/build/README.md
@@ -1,2 +1,29 @@
+## Build
+
+Cryptpad being not NixOS native, an upgrade must be done in 4 steps:
+  1. Bump the cryptpad version in `common.nix`
+  2. Rebuild the Nix lock files for the dependencies 
+  3. Build the package for Nix
+  4. Create a container from the Nix package
+
+To bump the nix version, set the desired tag in `common.nix` in the `cryptpadVersion` entry.
+Set the corresponding commit in the `cryptadCommit` field, its goal would be to detect unwanted update of the tag.
+
+To rebuild the lock files (they are stored in the `nix.lock` folder):
+
+```
+nix-shell --run "update_lock"
+```
+
+To build cryptpad:
+
+```
+nix-build
+```
+
+Create the container:
+
+```
 docker load < $(nix-build docker.nix)
 docker push superboum/cryptpad:???
+```