outline

server/scripts/compose/README.md

@@ -0,0 +1,20 @@
+A variant docker compose file that does not require cloning the repository, and
+instead uses pre-built images.
+
+### Details
+
+This folder contains a `compose.yaml` file that is a variant of the top level
+`server/compose.yaml`. The difference between the two are:
+
+- `server/compose.yaml` builds Ente images from source, assuming that the
+  `ente-io/ente` repository has been checked out.
+
+- `server/scripts/compose/compose.yaml` (the `compose.yaml` in this directory)
+  uses the pre-build Ente images, and does not require the `ente-io/ente`
+  repository to be cloned. That is, it can be run standalone by just curl-ing
+  it, and a few required files, to any folder on your machine.
+
+For more details about how to use it, see [docker.md](../../docs/docker.md).
+
+This folder also contains some other files that are required by (both) these
+docker compose files.