Skip to content

Commit ee2f31f

Browse files
committed
docs: configuration page ru
1 parent 0fa5a03 commit ee2f31f

File tree

2 files changed

+157
-3
lines changed

2 files changed

+157
-3
lines changed

docs/.vitepress/locales/ru.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,10 +29,10 @@ export default defineConfig({
2929
],
3030
},
3131
{
32-
text: 'Reference',
32+
text: 'Ссылки',
3333
base: '/ru/reference',
3434
items: [
35-
{ text: 'Configuration', link: '/configuration' },
35+
{ text: 'Конфигурация', link: '/configuration' },
3636
],
3737
},
3838
{

docs/ru/reference/configuration.md

Lines changed: 155 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,155 @@
1-
# Configuration
1+
# Конфигурация
2+
3+
Сервисы, иконки, язык и прочие настройки задаются в едином файле `config.yml`.
4+
Его необходимо передать в docker контейнер, как это сделать указано в разделе [начало работы](../guide/getting-started.md).
5+
6+
## Заголовок
7+
8+
При желании вы можете настроить заголовок страницы.
9+
10+
```yaml
11+
title: Моя домашняя страница
12+
```
13+
14+
Значение по умолчанию: `Home Page`
15+
16+
## Язык
17+
18+
Установите нужный язык с помощью:
19+
20+
```yaml
21+
lang: ru
22+
```
23+
24+
Поддерживаемые значения: `en`, `ru`
25+
26+
Значение по умолчанию: `en`
27+
28+
## Тема оформления
29+
30+
Вы можете настроить фиксированные темы, передав опцию `theme`, как показано ниже:
31+
32+
```yaml
33+
theme: dark
34+
```
35+
36+
Поддерживаемые значения: `system`, `light`, `dark`, `deep`
37+
38+
Значение по умолчанию: `system`
39+
40+
## Поверка обновлений
41+
42+
Данный параметр отвечает за автоматическую проверку обновлений.
43+
Если появится новая версия, то внизу экрана появится сообщение с новой версией.
44+
45+
```yaml
46+
checkUpdates: true
47+
```
48+
49+
Значение по умолчанию: `true`
50+
51+
::: info Пояснение
52+
С параметром `true` автоматического обновления не будет.
53+
Если хотите, чтобы система могла обновляться сама, то рекомендуем воспользоваться [watchtower](https://containrrr.dev/watchtower/).
54+
:::
55+
56+
## Сервисы
57+
58+
Все сервисы, которые отображаются на главной странице задаются в данном параметре.
59+
Он поддерживает как список, так и группировку. Кол-во сервисов не ограниченно.
60+
61+
::: warning Список сервисов
62+
Полный список всех сервисов можно посмотреть в левой боковой колонке в разделе **Сервисы**.
63+
Рекомендуем начать ознакомления с [базового сервиса](../services/base.md), на котором основываются все остальные.
64+
:::
65+
66+
### Список
67+
```yaml
68+
services:
69+
- title: Home Assistant
70+
description: Автоматизация дома
71+
link: https://home-assistant.home.local/
72+
```
73+
74+
### Группировка
75+
76+
```yaml
77+
services:
78+
Группа 1:
79+
- title: Home Assistant
80+
description: Автоматизация дома
81+
link: https://home-assistant.home.local/
82+
Группа 2:
83+
- title: Home Assistant
84+
description: Автоматизация дома
85+
link: https://home-assistant.home.local/
86+
```
87+
88+
Это обязательный параметр и без него домашняя страница не отроется.
89+
Более развернутые примеры можно посмотреть ниже.
90+
91+
## Примеры
92+
93+
### Список
94+
95+
Конфигурация в которой все сервисы расположены на одном уровне.
96+
97+
::: code-group
98+
```yaml [config.yml]
99+
title: Моя домашняя страница
100+
services:
101+
- title: Home Assistant
102+
description: Автоматизация дома
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: Сетевое хранилище
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+
### Группировка
122+
123+
Простая конфигурация с создаем двух групп `Сервисы` и `Устройства`.
124+
125+
::: code-group
126+
```yaml [config.yml]
127+
title: Моя домашняя страница
128+
services:
129+
Сервисы:
130+
- title: Home Assistant
131+
description: Автоматизация дома
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+
Устройства:
140+
- title: Роутер
141+
description: Keenetic Peak
142+
link: http://192.168.1.1/
143+
icon:
144+
name: mdi:router-network
145+
bubble: true
146+
- title: Сетевое хранилище
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

Comments
 (0)