Browse Source

Doc update

master
Joshua Rubingh 9 months ago
parent
commit
2fe812abd3
  1. 10
      README.md

10
README.md

@ -1,10 +1,10 @@ @@ -1,10 +1,10 @@
# VRE Broker
# Research Workspace Broker
[![Build Status](https://drones.web.rug.nl/api/badges/VRE/Broker/status.svg)](https://drones.web.rug.nl/VRE/Broker)
Research Workspaces Broker is the hart of the [Research Workspace system](/VRE). This is an API that is handling all the actions and requests from either a web interface of direct API.
Research Workspaces Broker is the hart of the [Research Workspace](/VRE). This is an API that is handling all the actions and requests from either a web interface of direct API.
This API is part of the [Research workspace system](/VRE) created by the [Rijksuniversiteit Groningen](https://www.rug.nl).
This API is part of the [Research workspace](/VRE) created by the [Rijksuniversiteit Groningen](https://www.rug.nl).
This API is responsible for:
@ -368,10 +368,10 @@ VRW_API_EMAIL=vrw+no-reply@rug.nl @@ -368,10 +368,10 @@ VRW_API_EMAIL=vrw+no-reply@rug.nl
# The IP number of the Load balancer which may change the IP address based on X-Forwarded-For in NGINX
NGINX_REAL_IP_SOURCE_IP=127.0.0.1
# The config file that is created by Kubernets which holds all the valid IP addresses that is allowed to overwrite the IP address of the client. Mostly loadbalancers
# The config file that is created by Kubernetes which holds all the valid IP addresses that is allowed to overwrite the IP address of the client. Mostly load balancers
# Leave empty to disable this security measure
NGINX_REAL_IP_LIST=
# The config file that is created by Kubernets which holds all the valid IP addresses to access the admin
# The config file that is created by Kubernetes which holds all the valid IP addresses to access the admin
# Leave empty to disable this security measure
NGINX_VALID_ADMIN_IP_LIST=
```
Loading…
Cancel
Save