Skip to content

Commit

Permalink
added env desc to readme
Browse files Browse the repository at this point in the history
Signed-off-by: Prati28 <[email protected]>
  • Loading branch information
psankhe28 committed Aug 10, 2024
1 parent c9a50d7 commit e592571
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ File handler utilizing TUS and MinIO with DRS-Filer integration.
- [Basic Usage](#basic-usage)
- [Installation](#installation)
- [Development](#development)
- [Environment Variables](#environment-variables)
- [Contributing](#contributing)
- [Code of Conduct](#code-of-conduct)
- [Versioning](#versioning)
Expand Down Expand Up @@ -157,6 +158,14 @@ make u
> **Note**: This is not the complete list of commands, run `make` to find out if
> more have been added.
## Environment Variables
### `TUS_FOCA_CONFIG_PATH`
- **Description:** Specifies the path to the configuration file for the FOCA app.
- **Usage:** The FOCA app uses this environment variable to locate the configuration file. If not set, the app will use a default configuration path.
- **Error Handling:** If the configuration file is not found at the specified path or the default path, a `FileNotFoundError` will be raised.
## Contributing
This project is a community effort and lives off _your_ contributions, be it in
Expand Down Expand Up @@ -213,4 +222,4 @@ To get in touch with us, please use one of the following routes:
[license]: LICENSE
[logo-elixir]: images/logo-elixir.svg
[logo-elixir-cloud-aai]: images/logo-elixir-cloud-aai.svg
[semver]: https://semver.org/
[semver]: https://semver.org/

0 comments on commit e592571

Please sign in to comment.