Skip to content

Commit

Permalink
docs(en): getting started page
Browse files Browse the repository at this point in the history
  • Loading branch information
hywax committed Jan 20, 2024
1 parent 575e0c5 commit 093962c
Showing 1 changed file with 60 additions and 0 deletions.
60 changes: 60 additions & 0 deletions docs/guide/getting-started.md
Original file line number Diff line number Diff line change
@@ -1 +1,61 @@
# Getting Started

## Docker

This Docker image is published in both Docker Hub and the GitHub container registry.
Depending on your preferences and needs, you can refer to both `hywax/mafl` and `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

All possible paths to the container. It is mandatory to specify the `config.yml` config file, everything else can be left by default.

| Путь | Тип | Описание |
|------------------------|--------|--------------------------------------------------------|
| `/app/data/config.yml` | File | App configuration - [more](../reference/configuration) |
| `/app/public/icons` | Folder | Local icons - [more](../reference/icons) |
| `/app/public/favicons` | Folder | Favicon icons - [more](../reference/favicons) |

## Node

Clone the repository:

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

Then install the dependencies and build the sources (I use `yarn`, you can use `npm` or `pnpm` if you want):

```shell
yarn install
yarn build
```

Finally, start the server:

```shell
yarn preview
```

The application will start with a basic configuration, which is located in the `data` folder.

0 comments on commit 093962c

Please sign in to comment.