From db69de8c56d228d010fcf70062e8b1094b18e244 Mon Sep 17 00:00:00 2001 From: hywax Date: Sun, 31 Dec 2023 16:10:28 +0500 Subject: [PATCH] docs(getting-started): update list --- README.md | 22 ++++++++++++++++++++-- 1 file changed, 20 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index dfceac0..c6a7974 100644 --- a/README.md +++ b/README.md @@ -27,11 +27,29 @@ Mafl is an intuitive service for organizing your homepage. Customize Mafl to you ### Docker -... +This Docker image is published to both Docker Hub and the GitHub container registry. Depending on your preferences and needs, you can reference both `hywax/mafl` as well as `ghcr.io/hywax/mafl`. + +```yaml +version: '3.8' + +services: + mafl: + image: hywax/mafl + restart: unless-stopped + ports: + - '3000:3000' + volumes: + - ./config.yml:/app/config/config.yml +``` ### Node -... +1. Clone repository: `git clone https://github.com/hywax/mafl.git` +2. Go to the application folder: `cd mafl` +3. Configure `...` +4. Install dependencies: `yarn install` +5. Build application: `yarn build` +6. Run `yarn preview` ### Proxmox