Skip to content

Commit 288160e

Browse files
committed
docs: customization options
1 parent 50f7d39 commit 288160e

File tree

2 files changed

+36
-0
lines changed

2 files changed

+36
-0
lines changed

README.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,34 @@ ENV | default value | description
3232
`GROUP_MAPPINGS` | `None` | Expressions for group name mapping
3333

3434

35+
## Customization
36+
37+
You can add a custom logo and a custom background image by setting the following `config` options:
38+
39+
```json
40+
"config": {
41+
"background_image_url": "<url>",
42+
"logo_image_url": "<url>"
43+
}
44+
```
45+
46+
The specified URLs can be absolute or relative. For relative URLs, you can write i.e.
47+
48+
```json
49+
"config": {
50+
"background_image_url": "/auth/static/background.jpg",
51+
"logo_image_url": "/auth/static/logo.jpg"
52+
}
53+
```
54+
55+
where `/auth` is the service mountpoint and place your custom images inside the `static` subfolder of the auth-service, or, if using docker and docker-compose, mount them accordingly:
56+
57+
qwc-auth-service:
58+
[...]
59+
volumes:
60+
- ./volumes/assets/Background.jpg:/srv/qwc_service/static/background.jpg
61+
- ./volumes/assets/logo.png:/srv/qwc_service/static/logo.jpg
62+
3563
Usage
3664
-----
3765

schemas/qwc-ldap-auth.json

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,14 @@
3333
}
3434
}
3535
]
36+
},
37+
"logo_image_url": {
38+
"description": "URL to a logo image to show in the login form. Default: `null`",
39+
"type": "string"
40+
},
41+
"background_image_url": {
42+
"description": "URL to a background image for the login page. Default: `null`",
43+
"type": "string"
3644
}
3745
},
3846
"required": [

0 commit comments

Comments
 (0)