File tree 1 file changed +60
-0
lines changed
1 file changed +60
-0
lines changed Original file line number Diff line number Diff line change 1
1
# Getting Started
2
+
3
+ ## Docker
4
+
5
+ This Docker image is published in both Docker Hub and the GitHub container registry.
6
+ Depending on your preferences and needs, you can refer to both ` hywax/mafl ` and ` 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
+ All possible paths to the container. It is mandatory to specify the ` config.yml ` config file, everything else can be left by default.
33
+
34
+ | Путь | Тип | Описание |
35
+ | ------------------------| --------| --------------------------------------------------------|
36
+ | ` /app/data/config.yml ` | File | App configuration - [ more] ( ../reference/configuration ) |
37
+ | ` /app/public/icons ` | Folder | Local icons - [ more] ( ../reference/icons ) |
38
+ | ` /app/public/favicons ` | Folder | Favicon icons - [ more] ( ../reference/favicons ) |
39
+
40
+ ## Node
41
+
42
+ Clone the repository:
43
+
44
+ ``` shell
45
+ git clone https://github.com/hywax/mafl.git
46
+ ```
47
+
48
+ Then install the dependencies and build the sources (I use ` yarn ` , you can use ` npm ` or ` pnpm ` if you want):
49
+
50
+ ``` shell
51
+ yarn install
52
+ yarn build
53
+ ```
54
+
55
+ Finally, start the server:
56
+
57
+ ``` shell
58
+ yarn preview
59
+ ```
60
+
61
+ The application will start with a basic configuration, which is located in the ` data ` folder.
You can’t perform that action at this time.
0 commit comments