Update readme.md
This commit is contained in:
@@ -57,6 +57,34 @@ Demo: https://mydrive-demo.herokuapp.com/
|
||||
|
||||
## Screenshots
|
||||
|
||||
## Enviroment Variables
|
||||
|
||||
Create a config folder on the root of the project, and create a file with the name prod.env for the server. For the client variables create a .env.production file in the root of the project.
|
||||
|
||||
Server Enviroment Variables:
|
||||
|
||||
- MONGODB_URL (Required): Sets the MongoDB URL, this should also work with DocumentDB.
|
||||
- HTTP_PORT (Required): Sets the HTTP port number.
|
||||
- HTTPS_PORT (Required): Sets the HTTPS port number.
|
||||
- PASSWORD (Required): Sets the JWT password.
|
||||
- DB_TYPE (Required): Sets the Database Type, options include s3/mongo/fs.
|
||||
- NODE_ENV (Required): Must be set to 'production'.
|
||||
- SSL (Optional): Enables SSL, place certificate.crt, certificate.ca-bundle, and certificate.key at the root of the project.
|
||||
- FS_DIRECTORY (Optional/Required): Sets the directory for file data on the file system.
|
||||
- S3_ID (Optional/Required): Sets the Amazon S3 ID.
|
||||
- S3_KEY (Optional/Required): Sets the Amazon S3 Key.
|
||||
- S3_BUCKET (Optional/Required): Sets the Amazon Bucket.
|
||||
- ROOT (Optional): Uses a filesystem path, is used for storage space.
|
||||
- URL (Optional): Allows to specify URL to host on, this is usually not needed.
|
||||
- USE_DOCUMENT_DB (Optional): Enables documentDB, this is experimental.
|
||||
- DOCUMENT_DB_BUNDLE (Optional): Enables SSL with documentDB.
|
||||
- BLOCK_CREATE_ACCOUNT (Optional): Blocks the ability to create accounts.
|
||||
|
||||
Client Enviroment Variables
|
||||
|
||||
- REMOTE_URL (Required): Sets the Remote URL for the client.
|
||||
- DISABLE_STORAGE (Optional): Disables storage, use this if you're not using ROOT on the server.
|
||||
|
||||
### Wiki
|
||||
|
||||
For a more detailed list of myDrive features, including examples with images, visit the wiki here: https://github.com/subnub/myDrive/wiki
|
||||
|
||||
Reference in New Issue
Block a user