iio/pingvin-share
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: add ALLOW_UNAUTHENTICATED_SHARES to README

Browse Source
This commit is contained in:
Elias Schneider
2022-10-24 09:12:12 +02:00
parent 7237928844
commit af6e2b61c0
2 changed files with 9 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
.env.example
View File

@@ -4,8 +4,8 @@
APP_URL=http://localhost:3000 APP_URL=http://localhost:3000
SHOW_HOME_PAGE=true SHOW_HOME_PAGE=true
ALLOW_REGISTRATION=true ALLOW_REGISTRATION=true
MAX_FILE_SIZE=1000000000
ALLOW_UNAUTHENTICATED_SHARES=false ALLOW_UNAUTHENTICATED_SHARES=false
MAX_FILE_SIZE=1000000000
# SECURITY # SECURITY
JWT_SECRET=long-random-string JWT_SECRET=long-random-string

3
README.md
View File

@@ -29,10 +29,11 @@ The website is now listening available on `http://localhost:3000`, have fun with
### Environment variables ### Environment variables
| Variable | Description | Possible values | | Variable | Description | Possible values |
| -------------------- | ------------------------------------------------------------------------------------------- | --------------- | | ------------------------------ | ------------------------------------------------------------------------------------------- | --------------- |
| `APP_URL` | On which URL Pingvin Share is available. E.g http://localhost or https://pingvin-share.com. | URL | | `APP_URL` | On which URL Pingvin Share is available. E.g http://localhost or https://pingvin-share.com. | URL |
| `SHOW_HOME_PAGE` | Whether the Pingvin Share home page should be shown. | true/false | | `SHOW_HOME_PAGE` | Whether the Pingvin Share home page should be shown. | true/false |
| `ALLOW_REGISTRATION` | Whether a new user can create a new account. | true/false | | `ALLOW_REGISTRATION` | Whether a new user can create a new account. | true/false |
| `ALLOW_UNAUTHENTICATED_SHARES` | Whether a user can create a share without being signed in. | true/false |
| `MAX_FILE_SIZE` | Maximum allowed size per file in bytes. | Number | | `MAX_FILE_SIZE` | Maximum allowed size per file in bytes. | Number |
| `JWT_SECRET` | Long random string to sign the JWT's. | Random string | | `JWT_SECRET` | Long random string to sign the JWT's. | Random string |