added env config instructions

ref #27
This commit is contained in:
Philipp Dormann 2021-03-31 19:03:07 +02:00
parent c178932d94
commit ba604f77e9
2 changed files with 15 additions and 7 deletions

View File

@ -4,7 +4,7 @@ runner selfservice portal
## ⚡ Development
### Requirements
- Node.js v14.15.0 or newer
- Node.js v14.16.0 or newer
- yarn package manager >= v1.22.10 < 2
### Recommended Extensions
@ -14,9 +14,17 @@ runner selfservice portal
### Fastest Dev Environment
- You can install the [Remote - Containers](https://github.com/Microsoft/vscode-remote-release) extension and use all recommended extensions and editor settings via the provided `./devcontainer/` config
## 🔨 environment config
### Manual Dev Environment
```
yarn && yarn dev --open
```
## 🔨 Environment config
- copy the `/public/env.sample.js` file to `/public/env.js`
- set the required environment variables
- `documentserver_key`: url to the [document server](https://git.odit.services/lfk/document-server) instance
- `baseurl`: url to the main instance
- see [@lfk/deployment](https://git.odit.services/lfk/deployment) for a complete deployment guide
- `baseurl`: url to the main lfk instance - WITH TRAILING SLASH
- see [@lfk/deployment](https://git.odit.services/lfk/deployment) for a complete deployment guide
- `baseurl_selfservice`: location of the selfservice instance - WITH TRAILING SLASH
- e.g. path: `/selfservice/`
- e.g. url: `https://example.com/selfservice/`

View File

@ -1,10 +1,10 @@
const config = {
// required
documentserver_key: '',
// required
// required, with trailing slash
baseurl: '',
// optional, will fallback to /selfservice
baseurl_selfservice: '/selfservice',
// optional, will fallback to /selfservice/
baseurl_selfservice: '/selfservice/',
// optional, will fallback to /imprint
url_imprint: '',
// optional, will fallback to /privacy