From 675121f2430ff8bf50bad3223681efa1f7ff9ded Mon Sep 17 00:00:00 2001 From: Manav Rathi Date: Wed, 19 Mar 2025 17:31:46 +0530 Subject: [PATCH] outline --- server/scripts/compose/README.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) create mode 100644 server/scripts/compose/README.md diff --git a/server/scripts/compose/README.md b/server/scripts/compose/README.md new file mode 100644 index 0000000000..e9593ac806 --- /dev/null +++ b/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.