Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
romeq committed Jun 24, 2023
1 parent fcb7cd7 commit 2c785aa
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 6 deletions.
25 changes: 25 additions & 0 deletions .env.example
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
#
# --- General settings ---
#
MONGO_URI="mongodb://<username>:<password>@host:27017/params"
SITE_URL="http://127.0.0.1"
TRUST_PROXY=0
SECRET=keyboard cat
ABUSEIPDB_KEY="<somerandomsecretkey>"
DATA_DIR="placeToStoreDocuments"
ALLOW_REGISTER=false # whether to allow new registrations

#
# --- Mail settings ---
#
MAIL_ENABLED=true
MAIL_HOST=http://mail.somehost.net
MAIL_USER=noreply
MAIL_PASSWORD=somesecurepassword
MAIL_PORT=465
MAIL_SECURE=true
# DKIM settings
DKIM_ENABLED=true
DKIM_HOST=http://somehost.net
DKIM_KEYSELECTOR=2019
DKIM_PRIVATEKEY_FILE=my_dkim_private_key
7 changes: 1 addition & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,9 +65,4 @@ Since the project uses typescript you cannot just start the project with `node .

## Configuration variables

| Key | Description |
| --- | ----------- |
| mongo_uri | Example: `mongodb+srv://user:pass@host/database`. This is the URI that MongoDB tries to connect to. It should be in format `mongodb+src://<user>:<password>@<hostname>/<database>` |
| site_url | Example: `http://localhost:3000`. The app parser required info from it. |
| trust_proxy | Number of proxies to trust (handy when using reverse proxy). |
| secret | Should be something random and unique. |
see `.env.example`

0 comments on commit 2c785aa

Please sign in to comment.