Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Updated README.md #16

Merged
merged 1 commit into from
Oct 31, 2022
Merged

Updated README.md #16

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 1 addition & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,6 @@ Example documentation available here: https://tj-actions.github.io/schemaspy/

<!-- AUTO-DOC-INPUT:END -->


## Using Docker image

Run
Expand All @@ -91,16 +90,12 @@ docker pull ghcr.io/tj-actions/schemaspy:2.1

> NOTE: The entrypoint is the `entrypoint.sh` script which requires certain environment variables to be set.


### Example usage with environment variables

```
docker run -v "$PWD:/docs" ghcr.io/tj-actions/schemaspy:2.1 -e INPUT_HOST=localhost -e INPUT_PORT=5432 -e INPUT_DATABASE_TYPE=pgsql -e INPUT_USER=test_user -e INPUT_PASSWORD=test_user_password -e INPUT_ALL=true
```
docker run -v "$PWD:/docs" ghcr.io/tj-actions/schemaspy:2.1 -e INPUT_HOST=localhost -e INPUT_PORT=5432 -e INPUT_DATABASE_TYPE=pgsql -e INPUT_USER=test_user -e INPUT_PASSWORD=test_user_password -e INPUT_ALL=true

For more information on each environment variable please refer to the [inputs](#inputs). A general rule would be to prefix the environment variable with `INPUT_` and uppercase of any specific input separated by underscores.


* Free software: [MIT license](LICENSE)

If you feel generous and want to show some extra appreciation:
Expand Down