Skip to content

Commit

Permalink
docs: getting started page ru
Browse files Browse the repository at this point in the history
  • Loading branch information
hywax committed Jan 4, 2024
1 parent 00c626a commit 68964a6
Show file tree
Hide file tree
Showing 2 changed files with 62 additions and 2 deletions.
2 changes: 1 addition & 1 deletion docs/.vitepress/locales/ru.ts
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ export default defineConfig({
base: '/ru/guide',
items: [
{ text: 'Что такое Mafl?', link: '/what-is' },
{ text: 'Getting Started', link: '/getting-started' },
{ text: 'Начало работы', link: '/getting-started' },
{ text: 'Deployment', link: '/deployment' },
],
},
Expand Down
62 changes: 61 additions & 1 deletion docs/ru/guide/getting-started.md
Original file line number Diff line number Diff line change
@@ -1 +1,61 @@
# Getting Started
# Начало работы

## Docker

Этот образ Docker опубликован как в Docker Hub, так и в реестре контейнеров GitHub.
В зависимости от ваших предпочтений и потребностей, вы можете ссылаться как на `hywax/mafl`, так и на `ghcr.io/hywax/mafl`.

### Docker compose

::: code-group
```yaml [docker-compose.yml]
version: '3.8'

services:
mafl:
image: hywax/mafl
restart: unless-stopped
ports:
- '3000:3000'
volumes:
- ./config.yml:/app/data/config.yml
```
:::

### Docker run
```shell
docker run -p 3000:3000 -v ./config.yml:/app/data/config.yml hywax/mafl
```

### Docker volumes

Все возможные пути в контейнер. Обязательно нужно указывать файл конфига `config.yml`, все остальное можно оставить по умолчанию.

| Путь | Тип | Описание |
|------------------------|-------|----------------------------------------------------------------------------|
| `/app/data/config.yml` | Файл | Основная конфигурация приложения - [подробнее](../reference/configuration) |
| `/app/public/icons` | Папка | Папка для локальных иконок - [подробнее](../reference/icons) |
| `/app/public/favicons` | Папка | Папка для значков приложения - [подробнее](../reference/favicons) |

## Node

Первым делом клонируйте репозиторий:

```shell
git clone https://github.com/hywax/mafl.git
```

Затем установите зависимости и соберите исходники (Я использую `yarn`, вы можете использовать `npm` или `pnpm`, если хотите):

```shell
yarn install
yarn build
```

Наконец, запустите сервер:

```shell
yarn preview
```

Приложение запустится с базовой конфигурацией, которая находится в папке `data`.

0 comments on commit 68964a6

Please sign in to comment.