Skip to content

Commit

Permalink
Update example env and readme
Browse files Browse the repository at this point in the history
  • Loading branch information
nakedmcse committed Mar 20, 2024
1 parent 640eb87 commit 04149fe
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 10 deletions.
8 changes: 1 addition & 7 deletions .envExample
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,4 @@ HTTPS_PORT=4000
SESSION_KEY=YourSessionKey
NODE_ENV=development
BASE_URL=http://localhost:8081
FILE_SIZE_UPLOAD_LIMIT_MB=512
BLOCKED_MIME_TYPES=application/x-dosexec,application/x-executable,application/x-hdf5,application/x-java-archive,application/vnd.rar
USE_CLOUDFLARE=false
MAX_URL_LENGTH=4096
CAPTCHA_SERVICE=reCAPTCHA
CAPTCHA_SITE_KEY=Put-Your-Google-V2-Recaptcha-Site-Key-Here
CAPTCHA_SECRET_KEY=Put-Your-Google-V2-Recaptcha-Secret-Key-Here
FILE_SIZE_UPLOAD_LIMIT_MB=512
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,7 @@ Required Settings

| Setting | Description |
|---------------------------|-------------------------------------------------------------------------------|
| BLOCKED_MIME_TYPES | Comma seperated list of MIME types that will be blocked from being uploaded |
| FILE_SIZE_UPLOAD_LIMIT_MB | Limit on size of file allowed to be uploaded |
| MAX_URL_LENGTH | Maximum URL length that can be specified |
| SALT | 8 Characters defining salt for encryption (if not set encryption is disabled) |
| SESSION_KEY | Replace 'YourSessionKey' with a random string to use as the session key |

> **Note Well** the file size sets the time to live for a file, so files close to the upload limit will only be hosted
Expand All @@ -36,6 +33,7 @@ Optional Settings

| Setting | Description |
|--------------------|------------------------------------------------------------------------------------------------------------------------------------------------------|
| BLOCKED_MIME_TYPES | Comma seperated list of MIME types that will be blocked from being uploaded |
| CLAM_PATH | The path to your Clam Antivirus installation |
| MS_DEFENDER_PATH | The path to your MS Defender Antivirus installation |
| UPLOAD_SECRET | A secret passcode you can set, when used as on the upload as a query paramater `secret_token`, the file will have no expiry and will persist forever |
Expand All @@ -45,6 +43,8 @@ Optional Settings
| CAPTCHA_SERVICE | Select the captcha service you want to use on login (see list of available values below) |
| CAPTCHA_SITE_KEY | The site key from the selected captcha service |
| CAPTCHA_SECRET_KEY | The secret key from the selected captcha service |
| SALT | 8 Characters defining salt for encryption (if not set encryption is disabled) |
| MAX_URL_LENGTH | Maximum URL length that can be specified |

The available `CAPTCHA_SERVICE` values are:

Expand Down

0 comments on commit 04149fe

Please sign in to comment.