From 0b3fe439898ece6f784adcb0239db9847463caf4 Mon Sep 17 00:00:00 2001 From: Julien Nahum Date: Thu, 29 Feb 2024 13:25:49 +0100 Subject: [PATCH] Add .env docker explanation in readme --- README.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 80a9dac..4e0eb08 100644 --- a/README.md +++ b/README.md @@ -69,8 +69,6 @@ It takes 1 minute to try out the builder for free. You'll have high availability ### Docker installation 🐳 -> ⚠️ **Warning**: the Docker setup is currently not working as we're migrating the front-end to Nuxt. [Track progress here](https://github.com/JhumanJ/OpnForm/issues/283). - This can be built and run locally but is also hosted publicly on docker hub at `jhumanj/opnform` and is generally best run directly from there. #### Running from docker hub @@ -79,7 +77,10 @@ This can be built and run locally but is also hosted publicly on docker hub at ` docker run --name opnform -v $PWD/my-opnform-data:/persist -p 80:80 jhumanj/opnform ``` -You should now be able to access the application by visiting http://localhost in a web browser. +You should now be able to access the application by visiting http://localhost in a web browser. + +> 👀 **Server Deployment**: If you are deploying OpnForm on a server (not locally), then you will [need to use 2 .env files](https://github.com/JhumanJ/opnform?tab=readme-ov-file#using-custom-env-files) to configure the app URLs (`APP_URL` in `.env` and both `NUXT_PUBLIC_APP_URL` & `NUXT_PUBLIC_API_BASE` in `client/.env`). + The `-v` argument creates a local directory called `my-opnform-data` which will store your database and files so that your work is not lost when you restart the container.