From 6bd0987f0d0ba6a9dd5bebff2e3afb734f68f26c Mon Sep 17 00:00:00 2001 From: subnub Date: Sun, 8 Mar 2020 14:50:13 -0400 Subject: [PATCH] updated readme with env variable guide --- readme.md | 26 ++++++++++++++++++++++++-- 1 file changed, 24 insertions(+), 2 deletions(-) diff --git a/readme.md b/readme.md index 757a6e3..5a3a80c 100755 --- a/readme.md +++ b/readme.md @@ -44,6 +44,30 @@ Note: If you do not have or want to use a HTTPS certificate, run "npm run build: - That's It! Now just Create a new account. +## Enviroment Variables + +The npm run init command will create the needed env variables, but if you would like to create them manually, structure the files like so. + +Backend variables: Stored in /config/prod.env + +MONGODB_URL= +PASSWORD= +HTTP_PORT= +HTTPS_PORT= +URL= +FULL_URL= +ROOT= + +Optional: +KEY= + +The KEY variable is optional, without it the server will prompt you for a password on startup, with a KEY the server will skip prompting for the password, use a KEY if you want to use myDrive with docker, or similar tools. + +Frontend variables: Stored on the root of the project .env.production + +PORT= +REMOTE_URL= + ## Built In Server Tools MyDrive comes with some built in NPM scripts for server management, this includes: @@ -63,8 +87,6 @@ MyDrive comes with some built in NPM scripts for server management, this include - Run Tests: Command "npm run test", Starts unit testing. - - ## Video I created a short YouTube video, showing off myDrives design and features: https://youtu.be/0YKU5CZHG4I