Skip to content

Commit

Permalink
docs: new env vars
Browse files Browse the repository at this point in the history
  • Loading branch information
woodjme committed Jul 17, 2024
1 parent 1863924 commit 7b2b59a
Showing 1 changed file with 15 additions and 13 deletions.
28 changes: 15 additions & 13 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -169,19 +169,21 @@ To configure Google Sheets, the following environment variables must be set:

You must provide `UNIFI_USER`, `UNIFI_PASS`, and `UNIFI_CONTROLLER_URL` for the application to start.

| Name | Example | Description |
| :---------------------- | :------------------------------------: | -------------------------------------------: |
| `UNIFI_USER` | `ubnt` | Your Unifi controller username |
| `UNIFI_PASS` | `password` | Your Unifi controller password |
| `UNIFI_CONTROLLER_URL` | `https://unifi.guestgate.cloud` | Your Unifi controller URL |
| `UNIFI_CONTROLLER_TYPE` | `standalone OR integrated` | Your Unifi controller URL |
| `UNIFI_SITE_IDENTIFIER` | `default` | The site identifier in your Unifi controller |
| `SESSION_SECRET` | `myrandomstring` | A secret for the express user session |
| `AUTH` | `none OR userInfo OR simple OR custom` | The auth page you want to display |
| `REDIRECTURL` | `/success.html` | The page to redirect to after auth |
| `LOG_AUTH_DRIVER` | `googlesheets` | The driver to use to capture user data |
| `LOG_AUTH_$DRIVER_$OPT` | `n/a` | Options set for each log_auth driver |
| `PORT` | `80` | The port to run the application on |
| Name | Example | Description |
| :---------------------- | :------------------------------------: | -----------------------------------------------: |
| `UNIFI_USER` | `ubnt` | Your Unifi controller username |
| `UNIFI_PASS` | `password` | Your Unifi controller password |
| `UNIFI_CONTROLLER_URL` | `https://unifi.guestgate.cloud` | Your Unifi controller URL |
| `UNIFI_CONTROLLER_TYPE` | `standalone OR integrated` | Your Unifi controller URL |
| `UNIFI_SITE_IDENTIFIER` | `default` | The site identifier in your Unifi controller |
| `SESSION_SECRET` | `myrandomstring` | A secret for the express user session |
| `AUTH` | `none OR userInfo OR simple OR custom` | The auth page you want to display |
| `REDIRECTURL` | `/success.html` | The page to redirect to after auth |
| `SERVER_SIDE_REDIRECT` | `false` | Should the server redirect the client after auth |
| `SHOW_CONNECTING` | `true` | Should the connecting page be displayed |
| `LOG_AUTH_DRIVER` | `googlesheets` | The driver to use to capture user data |
| `LOG_AUTH_$DRIVER_$OPT` | `n/a` | Options set for each log_auth driver |
| `PORT` | `80` | The port to run the application on |

### UNIFI_USER

Expand Down

0 comments on commit 7b2b59a

Please sign in to comment.