From 51e8d3eaf59da86d59e1a80e09ba32466297b31d Mon Sep 17 00:00:00 2001 From: Elias Schneider Date: Thu, 12 May 2022 16:07:18 +0200 Subject: [PATCH] Update setup instructions --- .env.example | 15 +++++++++------ README.md | 6 ++++-- 2 files changed, 13 insertions(+), 8 deletions(-) diff --git a/.env.example b/.env.example index 353af8f0..de68d56d 100644 --- a/.env.example +++ b/.env.example @@ -1,6 +1,9 @@ -APPWRITE_FUNCTION_API_KEY="" -PUBLIC_APPWRITE_HOST="http://localhost/v1" -PUBLIC_MAX_FILE_SIZE="300000000" # Note: Must be the same as in the _APP_STORAGE_LIMIT in the Appwrite env file -PUBLIC_DISABLE_REGISTRATION="true" # Note: In the Appwrite console you have to change your user limit to 0 if false and else to 1 -PUBLIC_DISABLE_HOME_PAGE="false" -PUBLIC_MAIL_SHARE_ENABLED="false" \ No newline at end of file +# Appwrite +APPWRITE_FUNCTION_API_KEY=your-api-key +PUBLIC_APPWRITE_HOST=http://localhost/v1 + +# Frontend +PUBLIC_MAX_FILE_SIZE=300000000 # Note: Should be the same as in the _APP_STORAGE_LIMIT in the Appwrite .env file +PUBLIC_DISABLE_REGISTRATION=true # Note: In the Appwrite console you have to change your user limit to 0 if false and else to 1 +PUBLIC_DISABLE_HOME_PAGE=false +PUBLIC_MAIL_SHARE_ENABLED=false \ No newline at end of file diff --git a/README.md b/README.md index 60aee51d..7b12d6ce 100644 --- a/README.md +++ b/README.md @@ -35,7 +35,7 @@ First of all you have to start the Docker container. 2. Rename the `.env.example` file to `.env` 3. Start the container with `docker-compose up -d` -The container is now running. Now you have to setup the Appwrite structure, but no worries I made a setup script. +The container is now running. Now you have to setup the Appwrite structure, but no worries there is a simple setup script. To run the script run `docker-compose exec pingvin-share node scripts/setup.js`. @@ -44,7 +44,9 @@ You're almost done, now you have to change your environment variables that they 1. Go to your Appwrite console, visit "API Keys" and copy the "Functions API Key" secret to your clipboard. 2. Paste the key to the `APPWRITE_FUNCTION_API_KEY` variable in the `.env` file 3. Change `PUBLIC_APPWRITE_HOST` in the `.env` file to the host where your Appwrite instance runs -4. Change `PUBLIC_MAX_FILE_SIZE` in the `.env` file to the max file size limit you want +4. Change the rest of the environment variables in the `.env` that they fit to your preferences +5. To save the environment variables run `docker-compose up -d` +6. Well done! Get a coffee and enjoy Pingvin Share 🎉 ## ⚙️ Additional configurations