From 11de341559ed0ee412f20add86dc3c94d811d88a Mon Sep 17 00:00:00 2001 From: amhsirak Date: Sun, 3 Nov 2024 17:27:47 +0530 Subject: [PATCH 1/3] fix: typo --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 4bce9449..3bff4816 100644 --- a/README.md +++ b/README.md @@ -54,7 +54,7 @@ npm run start You can access the frontend at http://localhost:5173/ and backend at http://localhost:8080/ -# Envirnoment Variables +# Environment Variables | Variable | Mandatory | Description | If Not Set | |-----------------------|-----------|----------------------------------------------------------------------------------------------|--------------------------------------------------------------| | `BACKEND_URL` | Yes | URL to run backend on. | Backend won't start. If not sure, set to http://localhost:8080/ | From 5d83242fd66f632456bd8e2361ec8c48e1b15bae Mon Sep 17 00:00:00 2001 From: amhsirak Date: Sun, 3 Nov 2024 17:33:42 +0530 Subject: [PATCH 2/3] chore: example env --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index 3bff4816..da0f0527 100644 --- a/README.md +++ b/README.md @@ -55,6 +55,9 @@ You can access the frontend at http://localhost:5173/ and backend at http://loca # Environment Variables +1. Create a file named `.env` in the root folder of the project +2. Example env file can be viewed [here](https://github.com/getmaxun/maxun/blob/master/ENVEXAMPLE). + | Variable | Mandatory | Description | If Not Set | |-----------------------|-----------|----------------------------------------------------------------------------------------------|--------------------------------------------------------------| | `BACKEND_URL` | Yes | URL to run backend on. | Backend won't start. If not sure, set to http://localhost:8080/ | From 696ed32b181e736162d48c0efefbc1d67939d05b Mon Sep 17 00:00:00 2001 From: amhsirak Date: Sun, 3 Nov 2024 17:37:08 +0530 Subject: [PATCH 3/3] chore: create env example file --- ENVEXAMPLE | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) create mode 100644 ENVEXAMPLE diff --git a/ENVEXAMPLE b/ENVEXAMPLE new file mode 100644 index 00000000..d17b1fc5 --- /dev/null +++ b/ENVEXAMPLE @@ -0,0 +1,27 @@ +# App Setup +NODE_ENV=production # Set to 'development' or 'production' as required +JWT_SECRET=your_jwt_secret_key # Replace with a secure JWT secret key +DB_NAME=maxun # Your PostgreSQL database name +DB_USER=postgres # PostgreSQL username +DB_PASSWORD=postgres # PostgreSQL password +DB_HOST=postgres # Host for PostgreSQL in Docker +DB_PORT=5432 # Port for PostgreSQL (default: 5432) +ENCRYPTION_KEY=your_encryption_key # Key for encrypting sensitive data (passwords and proxies) +MINIO_ENDPOINT=minio # MinIO endpoint in Docker +MINIO_PORT=9000 # Port for MinIO (default: 9000) +MINIO_ACCESS_KEY=minio_access_key # MinIO access key +MINIO_SECRET_KEY=minio_secret_key # MinIO secret key +REDIS_HOST=redis # Redis host in Docker +REDIS_PORT=6379 # Redis port (default: 6379) + +# Backend URLs +BACKEND_URL=http://localhost:8080 # Internal URL for backend service +VITE_BACKEND_URL=http://localhost:8080 # URL used by frontend to connect to backend + +# Optional Google OAuth settings for Google Sheet Integration +GOOGLE_CLIENT_ID=your_google_client_id +GOOGLE_CLIENT_SECRET=your_google_client_secret +GOOGLE_REDIRECT_URI=your_google_redirect_uri + +# Telemetry Settings - Please keep it enabled. Keeping it enabled helps us understand how the product is used and assess the impact of any new changes. +MAXUN_TELEMETRY=true