|
1 | 1 | # Configuration
|
| 2 | + |
| 3 | +Services, icons, language and other settings are set in a single `config.yml` file. |
| 4 | +It must be transferred to the docker container, as described in [Getting Started](../guide/getting-started.md). |
| 5 | + |
| 6 | +## Title |
| 7 | + |
| 8 | +You can customize the page header if you wish. |
| 9 | + |
| 10 | +```yaml |
| 11 | +title: My Home Page |
| 12 | +``` |
| 13 | +
|
| 14 | +Default: `Mafl Home Page` |
| 15 | + |
| 16 | +## Language |
| 17 | + |
| 18 | +Set the desired language with: |
| 19 | + |
| 20 | +```yaml |
| 21 | +lang: ru |
| 22 | +``` |
| 23 | + |
| 24 | +Values: `en`, `ru` |
| 25 | + |
| 26 | +Default: `en` |
| 27 | + |
| 28 | +## Theme |
| 29 | + |
| 30 | +You can customize fixed themes by passing the `theme` option as shown below: |
| 31 | + |
| 32 | +```yaml |
| 33 | +theme: dark |
| 34 | +``` |
| 35 | + |
| 36 | +Values: `system`, `light`, `dark`, `deep`, `sepia` |
| 37 | + |
| 38 | +Default: `system` |
| 39 | + |
| 40 | +## Check updates |
| 41 | + |
| 42 | +This option is responsible for automatically checking for updates. |
| 43 | +If a new version appears, a message with the new version will appear at the bottom of the screen. |
| 44 | + |
| 45 | +```yaml |
| 46 | +checkUpdates: true |
| 47 | +``` |
| 48 | + |
| 49 | +Default: `true` |
| 50 | + |
| 51 | +::: info Info |
| 52 | +With the `true` parameter there will be no automatic update. |
| 53 | +If you want the system to be able to update itself, we recommend using [watchtower](https://containrrr.dev/watchtower/). |
| 54 | +::: |
| 55 | + |
| 56 | +## Services |
| 57 | + |
| 58 | +All services that are displayed on the home page are set in this parameter. |
| 59 | +It supports both list and grouping. The number of services is not limited. |
| 60 | + |
| 61 | +::: warning Services list |
| 62 | +A full list of all services can be viewed in the left sidebar under **Services**. |
| 63 | +We recommend to start familiarization with [base service](../services/base.md), on which all other services are based. |
| 64 | +::: |
| 65 | + |
| 66 | +### Flat |
| 67 | +```yaml |
| 68 | +services: |
| 69 | + - title: Home Assistant |
| 70 | + description: Home automation |
| 71 | + link: https://home-assistant.home.local/ |
| 72 | +``` |
| 73 | + |
| 74 | +### Groups |
| 75 | + |
| 76 | +```yaml |
| 77 | +services: |
| 78 | + Group 1: |
| 79 | + - title: Home Assistant |
| 80 | + description: Home automation |
| 81 | + link: https://home-assistant.home.local/ |
| 82 | + Group 2: |
| 83 | + - title: Home Assistant |
| 84 | + description: Home automation |
| 85 | + link: https://home-assistant.home.local/ |
| 86 | +``` |
| 87 | + |
| 88 | +This is a required parameter, without it the homepage will not open. |
| 89 | +You can see more detailed examples below. |
| 90 | + |
| 91 | +## Examples |
| 92 | + |
| 93 | +### Flat list |
| 94 | + |
| 95 | +A configuration in which all services are located at the same level. |
| 96 | + |
| 97 | +::: code-group |
| 98 | +```yaml [config.yml] |
| 99 | +title: My Home Page |
| 100 | +services: |
| 101 | + - title: Home Assistant |
| 102 | + description: Home automation |
| 103 | + link: https://home-assistant.home.local/ |
| 104 | + icon: |
| 105 | + name: simple-icons:homeassistant |
| 106 | + bubble: true |
| 107 | + color: '#3dbcf3' |
| 108 | + status: |
| 109 | + enabled: true |
| 110 | + - title: NAS |
| 111 | + description: Synology DS223 |
| 112 | + link: https://nas.home.local/ |
| 113 | + icon: |
| 114 | + name: mdi:nas |
| 115 | + bubble: true |
| 116 | + status: |
| 117 | + enabled: true |
| 118 | +``` |
| 119 | +::: |
| 120 | + |
| 121 | +### Group list |
| 122 | + |
| 123 | +A simple configuration with the creation of two groups `Services` and `Devices`. |
| 124 | + |
| 125 | +::: code-group |
| 126 | +```yaml [config.yml] |
| 127 | +title: My Home Page |
| 128 | +services: |
| 129 | + Services: |
| 130 | + - title: Home Assistant |
| 131 | + description: Home automation |
| 132 | + link: https://home-assistant.home.local/ |
| 133 | + icon: |
| 134 | + name: simple-icons:homeassistant |
| 135 | + bubble: true |
| 136 | + color: '#3dbcf3' |
| 137 | + status: |
| 138 | + enabled: true |
| 139 | + Devices: |
| 140 | + - title: Router |
| 141 | + description: Keenetic Peak |
| 142 | + link: http://192.168.1.1/ |
| 143 | + icon: |
| 144 | + name: mdi:router-network |
| 145 | + bubble: true |
| 146 | + - title: NAS |
| 147 | + description: Synology DS223 |
| 148 | + link: https://nas.home.local/ |
| 149 | + icon: |
| 150 | + name: mdi:nas |
| 151 | + bubble: true |
| 152 | + status: |
| 153 | + enabled: true |
| 154 | +``` |
| 155 | +::: |
0 commit comments