Skip to content

Commit

Permalink
Point to Github pages documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
wkramer committed Jun 3, 2024
1 parent 0866c43 commit 47a068f
Showing 1 changed file with 1 addition and 24 deletions.
25 changes: 1 addition & 24 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,5 @@
# Delft Fews Web Operator Client

## Project setup

## Customize configuration
See [Configuration Reference](https://cli.vuejs.org/config/).

### Application Configuration

The application configuration is stored in the `.env` or the `public/app-config.json` file. All settings are provided as a key-value pair.
Settings in the `.env` file are parsed on build time, while settings in the `app-config.json` are handled on run-time.
The following settings can be provided:

| Key | Description |
|-----------------------------------------|-----------------------------------------------------------------------------------------------------------------------|
| `VUE_APP_FEWS_WEBSERVICES_URL` | Url of the FewsWebServices, e.g. "https://rwsos-dataservices-ont.avi.deltares.nl/iwp/FewsWebServices" |
| `VUE_APP_REQUEST_HEADER_AUTHORIZATION` | 'Bearer': pass OIDC `id_token` as bearer for request to the FewsWebServices |
| | 'Off': no Authorization request header |
| `VUE_APP_AUTH_AUTHORITY` | Url of the OIDC authority, e.g. "https://login.microsoftonline.com/MYTENANTID/". |
| | If not configured the web oc can be accessed without authentication. |
| `VUE_APP_AUTH_METADATA_URL` | Url of the OIDC meta data, e.g. "https://login.microsoftonline.com/MYTENANTID/v2.0/.well-known/openid-configuration". |
| `VUE_APP_AUTH_SCOPE` | Scope, e.g. "openid profile email Offline_Access api://myclientid/Delft-FEWSWebServices". |
| `VUE_APP_REQUEST_HEADER_AUTHORIZATION` | Url of the OIDC meta data, e.g. "https://login.microsoftonline.com/MYTENANTID/v2.0/.well-known/openid-configuration". |
| `VUE_APP_MAPBOX_TOKEN` | Mapbox token. Can be retrieved from: https://account.mapbox.com/access-tokens. |

For general documentation about the Web OC, please see:

[Documentation](docs/)
[Documentation](https://deltares.github.io/fews-web-oc/)

0 comments on commit 47a068f

Please sign in to comment.