Skip to content

Commit

Permalink
docs(getting-started): update list
Browse files Browse the repository at this point in the history
  • Loading branch information
hywax committed Dec 31, 2023
1 parent 9c24483 commit db69de8
Showing 1 changed file with 20 additions and 2 deletions.
22 changes: 20 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down

0 comments on commit db69de8

Please sign in to comment.