diff --git a/README.md b/README.md
index 8a87603..efb02a7 100644
--- a/README.md
+++ b/README.md
@@ -32,8 +32,8 @@ if __name__ == '__main__':
```
### Env Variables
-> :bulb: Environment variables can be loaded from any file. _Defaults to `.env`_
-> Set the env var `env_file` to the filename to use custom `.env` files
+> :bulb: Environment variables can be loaded from any file. _Filename defaults to `.env`_
+> To use custom filenames, set the env var `env_file` as `key` and the _filename_ as its `value`
**Mandatory**
- **USERNAME**: Any username of choice.
@@ -46,7 +46,7 @@ if __name__ == '__main__':
- **VIDEO_PORT**: Port number to host the application. Defaults to `8000`
- **FILE_FORMATS**: Sequence of supported video file formats. Defaults to `(.mp4, .mov)`
- **WORKERS**: Number of workers to spin up the `uvicorn` server. Defaults to `1`
-- **WEBSITE**: Website to add to CORS configuration. _Required only if tunneled via CDN_
+- **WEBSITE**: List of websites (_supports regex_) to add to CORS configuration. _Required only if tunneled via CDN_
- **AUTO_THUMBNAIL**: Boolean flag to auto generate thumbnail images for preview. Defaults to `True`
## Coding Standards
diff --git a/docs/README.html b/docs/README.html
index dfe99cc..6c94745 100644
--- a/docs/README.html
+++ b/docs/README.html
@@ -76,8 +76,8 @@
-:bulb: Environment variables can be loaded from any file. Defaults to
+.env
-Set the env varenv_file
to the filename to use custom.env
files:bulb: Environment variables can be loaded from any file. Filename defaults to
.env
+To use custom filenames, set the env varenv_file
askey
and the filename as itsvalue
Mandatory
diff --git a/docs/README.md b/docs/README.md index 8a87603..efb02a7 100644 --- a/docs/README.md +++ b/docs/README.md @@ -32,8 +32,8 @@ if __name__ == '__main__': ``` ### Env Variables -> :bulb: Environment variables can be loaded from any file. _Defaults to `.env`_
-> Set the env var `env_file` to the filename to use custom `.env` files +> :bulb: Environment variables can be loaded from any file. _Filename defaults to `.env`_
+> To use custom filenames, set the env var `env_file` as `key` and the _filename_ as its `value` **Mandatory** - **USERNAME**: Any username of choice. @@ -46,7 +46,7 @@ if __name__ == '__main__': - **VIDEO_PORT**: Port number to host the application. Defaults to `8000` - **FILE_FORMATS**: Sequence of supported video file formats. Defaults to `(.mp4, .mov)` - **WORKERS**: Number of workers to spin up the `uvicorn` server. Defaults to `1` -- **WEBSITE**: Website to add to CORS configuration. _Required only if tunneled via CDN_ +- **WEBSITE**: List of websites (_supports regex_) to add to CORS configuration. _Required only if tunneled via CDN_ - **AUTO_THUMBNAIL**: Boolean flag to auto generate thumbnail images for preview. Defaults to `True` ## Coding Standards diff --git a/docs/_sources/README.md.txt b/docs/_sources/README.md.txt index 8a87603..efb02a7 100644 --- a/docs/_sources/README.md.txt +++ b/docs/_sources/README.md.txt @@ -32,8 +32,8 @@ if __name__ == '__main__': ``` ### Env Variables -> :bulb: Environment variables can be loaded from any file. _Defaults to `.env`_
-> Set the env var `env_file` to the filename to use custom `.env` files +> :bulb: Environment variables can be loaded from any file. _Filename defaults to `.env`_
+> To use custom filenames, set the env var `env_file` as `key` and the _filename_ as its `value` **Mandatory** - **USERNAME**: Any username of choice. @@ -46,7 +46,7 @@ if __name__ == '__main__': - **VIDEO_PORT**: Port number to host the application. Defaults to `8000` - **FILE_FORMATS**: Sequence of supported video file formats. Defaults to `(.mp4, .mov)` - **WORKERS**: Number of workers to spin up the `uvicorn` server. Defaults to `1` -- **WEBSITE**: Website to add to CORS configuration. _Required only if tunneled via CDN_ +- **WEBSITE**: List of websites (_supports regex_) to add to CORS configuration. _Required only if tunneled via CDN_ - **AUTO_THUMBNAIL**: Boolean flag to auto generate thumbnail images for preview. Defaults to `True` ## Coding Standards diff --git a/docs/genindex.html b/docs/genindex.html index 9dbadfc..a1d5655 100644 --- a/docs/genindex.html +++ b/docs/genindex.html @@ -225,6 +225,8 @@P