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

docs: Documents Rscript argument on README #15

Merged
merged 1 commit into from
Jan 12, 2024
Merged

docs: Documents Rscript argument on README #15

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
17 changes: 9 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,14 +131,15 @@ faucet --dir /path/to/plumber/api --ip-from x-forwarded-for
Every option / flag can also be set using an environment variable, this is useful
for example when using Docker.

| Option / Flag | Environment Variable |
| ------------- | -------------------- |
| `--dir` | `FAUCET_DIR` |
| `--host` | `FAUCET_HOST` |
| `--workers` | `FAUCET_WORKERS` |
| `--strategy` | `FAUCET_STRATEGY` |
| `--type` | `FAUCET_TYPE` |
| `--ip-from` | `FAUCET_IP_FROM` |
| Option / Flag | Environment Variable | Description |
| ------------- | -------------------- | ---------------------------------------------- |
| `--dir` | `FAUCET_DIR` | Path to application |
| `--host` | `FAUCET_HOST` | Host and port to bind the server to |
| `--workers` | `FAUCET_WORKERS` | Number of workers to spawn |
| `--strategy` | `FAUCET_STRATEGY` | Load balancing strategy |
| `--type` | `FAUCET_TYPE` | Type of application (shiny or plumber) |
| `--ip-from` | `FAUCET_IP_FROM` | Header or method to get the client IP address |
| `--rscript` | `FAUCET_RSCRIPT` | Path to Rscript executable |

## Installation

Expand Down