Skip to content

Commit 68964a6

Browse files
committed
docs: getting started page ru
1 parent 00c626a commit 68964a6

File tree

2 files changed

+62
-2
lines changed

2 files changed

+62
-2
lines changed

docs/.vitepress/locales/ru.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ export default defineConfig({
2424
base: '/ru/guide',
2525
items: [
2626
{ text: 'Что такое Mafl?', link: '/what-is' },
27-
{ text: 'Getting Started', link: '/getting-started' },
27+
{ text: 'Начало работы', link: '/getting-started' },
2828
{ text: 'Deployment', link: '/deployment' },
2929
],
3030
},

docs/ru/guide/getting-started.md

Lines changed: 61 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,61 @@
1-
# Getting Started
1+
# Начало работы
2+
3+
## Docker
4+
5+
Этот образ Docker опубликован как в Docker Hub, так и в реестре контейнеров GitHub.
6+
В зависимости от ваших предпочтений и потребностей, вы можете ссылаться как на `hywax/mafl`, так и на `ghcr.io/hywax/mafl`.
7+
8+
### Docker compose
9+
10+
::: code-group
11+
```yaml [docker-compose.yml]
12+
version: '3.8'
13+
14+
services:
15+
mafl:
16+
image: hywax/mafl
17+
restart: unless-stopped
18+
ports:
19+
- '3000:3000'
20+
volumes:
21+
- ./config.yml:/app/data/config.yml
22+
```
23+
:::
24+
25+
### Docker run
26+
```shell
27+
docker run -p 3000:3000 -v ./config.yml:/app/data/config.yml hywax/mafl
28+
```
29+
30+
### Docker volumes
31+
32+
Все возможные пути в контейнер. Обязательно нужно указывать файл конфига `config.yml`, все остальное можно оставить по умолчанию.
33+
34+
| Путь | Тип | Описание |
35+
|------------------------|-------|----------------------------------------------------------------------------|
36+
| `/app/data/config.yml` | Файл | Основная конфигурация приложения - [подробнее](../reference/configuration) |
37+
| `/app/public/icons` | Папка | Папка для локальных иконок - [подробнее](../reference/icons) |
38+
| `/app/public/favicons` | Папка | Папка для значков приложения - [подробнее](../reference/favicons) |
39+
40+
## Node
41+
42+
Первым делом клонируйте репозиторий:
43+
44+
```shell
45+
git clone https://github.com/hywax/mafl.git
46+
```
47+
48+
Затем установите зависимости и соберите исходники (Я использую `yarn`, вы можете использовать `npm` или `pnpm`, если хотите):
49+
50+
```shell
51+
yarn install
52+
yarn build
53+
```
54+
55+
Наконец, запустите сервер:
56+
57+
```shell
58+
yarn preview
59+
```
60+
61+
Приложение запустится с базовой конфигурацией, которая находится в папке `data`.

0 commit comments

Comments
 (0)