diff --git a/README.md b/README.md index c3c7f3b..af1e225 100644 --- a/README.md +++ b/README.md @@ -90,10 +90,9 @@ If you want to run WYGIWYH locally, on your env file: You can now access localhost:OUTBOUND_PORT > [!NOTE] -> If you're planning on running this behind Tailscale or other similar service also add your machine given IP to `DJANGO_ALLOWED_HOSTS` +> - If you're planning on running this behind Tailscale or other similar service also add your machine given IP to `DJANGO_ALLOWED_HOSTS` +> - If you're going to use another IP that isn't localhost, add it to `DJANGO_ALLOWED_HOSTS`, without `http://` -> [!NOTE] -> If you're going to use another IP that isn't localhost, add it to `DJANGO_ALLOWED_HOSTS`, without `http://` ## Building from source Features are only added to main when ready, if you want to run the latest version, you must build from source. @@ -106,6 +105,24 @@ All the required Dockerfiles are [here](https://github.com/eitchtee/WYGIWYH/tree WYGIWYH and WYGIWYH--Procrastinate should be available on the Unraid Store. You need both for all features. +## Enviroment Variables + +| variable | type | default | explanation | +|-------------------------------|-------------|-----------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| DJANGO_ALLOWED_HOSTS | string | localhost 127.0.0.1 | A list of space separated domains and IPs representing the host/domain names that WYGIWYH site can serve. [Click here](https://docs.djangoproject.com/en/5.1/ref/settings/#allowed-hosts) for more details | +| HTTPS_ENABLED | true\|false | false | Whether to use secure cookies. If this is set to true, the cookie will be marked as “secure”, which means browsers may ensure that the cookie is only sent under an HTTPS connection | +| URL | string | http://localhost http://127.0.0.1 | A list of space separated domains and IPs (with the protocol) representing the trusted origins for unsafe requests (e.g. POST). [Click here](https://docs.djangoproject.com/en/5.1/ref/settings/#csrf-trusted-origins ) for more details | +| SECRET_KEY | string | "" | This is used to provide cryptographic signing, and should be set to a unique, unpredictable value. | +| DEBUG | true\|false | false | Turns DEBUG mode on or off, this is useful to gather more data about possible errors you're having. Don't use in production. | +| SQL_DATABASE | string | None *required | The name of your postgres database | +| SQL_USER | string | user | The username used to connect to your postgres database | +| SQL_PASSWORD | string | password | The password used to connect to your postgres database | +| SQL_HOST | string | localhost | The adress used to connect to your postgres database | +| SQL_PORT | string | 5432 | The port used to connect to your postgres database | +| SESSION_EXPIRY_TIME | int | 2678400 (31 days) | The age of session cookies, in seconds. E.g. how long you will stay logged in | +| ENABLE_SOFT_DELETE | true\|false | false | Whether to enable transactions soft delete, if enabled, deleted transactions will remain in the database. Useful for imports and avoiding duplicate entries. | +| KEEP_DELETED_TRANSACTIONS_FOR | int | 365 | Time in days to keep soft deleted transactions for. If 0, will keep all transactions indefinitely. Only works if ENABLE_SOFT_DELETE is true. | + # How it works Check out our [Wiki](https://github.com/eitchtee/WYGIWYH/wiki) for more information.