update readme examples to yaml

This commit is contained in:
William Welling
2021-12-14 18:01:34 -06:00
parent bbb8d708b9
commit 0afa7c5bab

View File

@@ -18,15 +18,13 @@ Configuration options can be overridden by setting environment variables.
When you start dspace-angular on node, it spins up an http server on which it listens for incoming connections. You can define the ip address and port the server should bind itsself to, and if ssl should be enabled not. By default it listens on `localhost:4000`. If you want it to listen on all your network connections, configure it to bind itself to `0.0.0.0`. When you start dspace-angular on node, it spins up an http server on which it listens for incoming connections. You can define the ip address and port the server should bind itsself to, and if ssl should be enabled not. By default it listens on `localhost:4000`. If you want it to listen on all your network connections, configure it to bind itself to `0.0.0.0`.
To change this configuration, change the options `ui.host`, `ui.port` and `ui.ssl` in the appropriate configuration file (see above): To change this configuration, change the options `ui.host`, `ui.port` and `ui.ssl` in the appropriate configuration file (see above):
```
{ ```yaml
"ui": { ui:
"ssl": false, ssl: false
"host": "localhost", host: localhost
"port": 4000, port: 4000
"nameSpace": "/" nameSpace: /
}
}
``` ```
Alternately you can set the following environment variables. If any of these are set, it will override all configuration files: Alternately you can set the following environment variables. If any of these are set, it will override all configuration files:
@@ -47,14 +45,12 @@ or
## DSpace's REST endpoint ## DSpace's REST endpoint
dspace-angular connects to your DSpace installation by using its REST endpoint. To do so, you have to define the ip address, port and if ssl should be enabled. You can do this in a configuration file (see above) by adding the following options: dspace-angular connects to your DSpace installation by using its REST endpoint. To do so, you have to define the ip address, port and if ssl should be enabled. You can do this in a configuration file (see above) by adding the following options:
``` ```yaml
{ rest:
"rest": { ssl: true
"ssl": true, host: api7.dspace.org
"host": "api7.dspace.org", port: 443
"port": 443, nameSpace: /server
"nameSpace": "/server"
}
} }
``` ```