From b571d097b615783e4ea676a14da5df2883196307 Mon Sep 17 00:00:00 2001 From: Colin Griffin Date: Fri, 17 Dec 2021 12:30:44 -0500 Subject: [PATCH] update readme with production remarks --- README.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index fd5e5bb..26f2397 100644 --- a/README.md +++ b/README.md @@ -8,10 +8,18 @@ Community Support -# calendso-docker +# Docker The Docker configuration for Calendso is an effort powered by people within the community. Calendso does not provide official support for Docker, but we will accept fixes and documentation. Use at your own risk. +## Important Notes + +This Docker Image is managed by the Calendso Community. Support for this image can be found via the repository, located at [https://github.com/calendso/docker](https://github.com/calendso/docker) + +Currently, this image is intended for local development/evaluation use only, as there are specific requirements for providing environmental variables at build-time in order to specify a non-localhost BASE_URL. (this is due to the nature of the static site compilation, which embeds the variable values). The ability to update these variables at runtime is in-progress and will be available in the future. + +For Production, for the time being, please checkout the repository and build/push your own image privately. + ## Requirements Make sure you have `docker` & `docker-compose` installed on the server / system.