Skip to content

Commit c9b2415

Browse files
committed
docs: add documentation for theme options
1 parent 1bfbcbf commit c9b2415

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -114,9 +114,28 @@ Some env options are available for use this interface for **only one server**.
114114
- `SHOW_CATALOG_NB_TAGS`: Show number of tags per images on catalog page. This will produce + nb images requests, not recommended on large registries. (default: `false`).
115115
- `HISTORY_CUSTOM_LABELS`: Expose custom labels in history page, custom labels will be processed like maintainer label.
116116
- `USE_CONTROL_CACHE_HEADER`: Use `Control-Cache` header and set to `no-store, no-cache`. This will avoid some issues on multi-arch images (see [#260](https://github.com/Joxit/docker-registry-ui/issues/260)). This option requires registry configuration: `Access-Control-Allow-Headers` with `Cache-Control`. (default: `false`).
117+
- `THEME`: Chose your default theme, could be `dark`, `light` or `auto`. (default: `auto`). Since 2.4.0
118+
- `THEME_*`: See table in [Theme options](#theme-options) section. Since 2.4.0
117119

118120
There are some examples with [docker-compose](https://docs.docker.com/compose/) and docker-registry-ui as proxy [here](https://github.com/Joxit/docker-registry-ui/tree/main/examples/ui-as-proxy/) or docker-registry-ui as standalone [here](https://github.com/Joxit/docker-registry-ui/tree/main/examples/ui-as-standalone/).
119121

122+
### Theme options
123+
124+
This featureswas added to version 2.4.0. See more about this in [#283](https://github.com/Joxit/docker-registry-ui/pull/283).
125+
126+
| Environment variable | light theme value | dark theme value |
127+
| --- | --- | --- |
128+
| `THEME_PRIMARY_TEXT` | `#25313b` | `#8A9EBA` |
129+
| `THEME_NEUTRAL_TEXT` | `#777777` | `#36527A` |
130+
| `THEME_BACKGROUND` | `#ffffff` | `#22272e` |
131+
| `THEME_HOVER_BACKGROUND` | `#eeeeee` | `#30404D` |
132+
| `THEME_ACCENT_TEXT` | `#6680a1` | `#5684FF` |
133+
| `THEME_HEADER_TEXT` | `#ffffff` | `#ffffff` |
134+
| `THEME_HEADER_BACKGROUND` | `#25313b` | `#333A45` |
135+
| `THEME_FOOTER_TEXT` | `#ffffff` | `#ffffff` |
136+
| `THEME_FOOTER_NEUTRAL_TEXT` | `#999999` | `#999999` |
137+
| `THEME_FOOTER_BACKGROUND` | `#555555` | `#555555` |
138+
120139
## Using CORS
121140

122141
Your server should be configured to accept CORS.

0 commit comments

Comments
 (0)