kamp/pingvin-share
1
0
Fork 0
mirror of https://github.com/stonith404/pingvin-share.git synced 2024-07-02 07:20:38 +02:00
Code

Update setup instructions

Browse Source
This commit is contained in:
Elias Schneider 2022-05-12 16:07:18 +02:00
parent d05bea4a7e
commit 51e8d3eaf5
No known key found for this signature in database
GPG Key ID: D5EC1C72D93244FD
2 changed files with 13 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
.env.example
View File

@ -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"
# 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

6
README.md
View File

@ -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