How do I add my own custom service to Mafl?

You'll need to create a custom service by extending the base service in YAML, referencing the documentation for structure, but detailed development guides are minimal, so some coding knowledge is required.

Mafl vs Heimdall – which is better for a self-hosted dashboard?

Mafl is more minimalistic and privacy-focused with YAML configuration, while Heimdall offers more pre-built widgets and a GUI setup. Choose Mafl for lightweight customization, Heimdall for easier out-of-the-box functionality.

Can I use Mafl to display data from my private APIs?

Yes, but it requires custom service development in YAML, as Mafl doesn't natively support arbitrary APIs; you'll need to handle backend logic and data formatting manually.

How to change themes in Mafl without editing YAML?

Themes are configured via YAML only; there's no built-in theme switcher UI, so you must edit the config.yml file directly or use community-shared themes from the documentation.

Is Mafl good for team dashboards with multiple users?

No, Mafl is designed for individual use with single-user configuration; it lacks features like user authentication, permissions, or collaborative editing for team environments.

What happens if Mafl's real-time services go down?

The dashboard may display stale or error data for services like Weather or IP API, as Mafl relies on backend requests; you'd need to implement fallbacks or error handling in custom configurations.

Open-Awesome

Mafl

MITTypeScriptv0.15.4Self-Hosted

A minimalistic, customizable homepage service with interactive cards, privacy-focused backend requests, and multi-language support.

Visit Website GitHub

754 stars61 forks0 contributors

What is Mafl?

Mafl is a minimalistic and flexible homepage service that lets users create a customized, interactive dashboard. It solves the problem of cluttered or non-personalized start pages by offering configurable services, real-time data cards, and privacy-focused backend requests. Users can organize their most-used services, weather, IP information, and more into a single efficient interface.

Target Audience

Individuals and tech enthusiasts who want a self-hosted, privacy-respecting homepage dashboard that they can fully customize to streamline their daily workflows and access key information quickly.

Value Proposition

Developers choose Mafl for its emphasis on privacy, ease of setup with YAML, and the ability to self-host a fast, interactive homepage without relying on third-party analytics or bloated interfaces.

Overview

Minimalistic flexible homepage

Use Cases

Best For

Creating a personalized start page with live data like weather and IP information
Self-hosting a privacy-focused dashboard that avoids third-party tracking
Organizing bookmarks and web services into grouped, tagged categories
Building a lightweight, installable PWA homepage for quick access
Customizing homepage themes and icons to match personal or brand aesthetics
Setting up a multi-language dashboard for teams or multilingual users

Not Ideal For

Users needing a large library of pre-built widgets like calendars or news feeds without custom coding
Teams requiring multi-user collaboration features or shared dashboard editing
Non-technical users who prefer a graphical interface over YAML configuration
Projects demanding extensive third-party service integrations out of the box

Pros & Cons

Pros

Privacy-First Backend

All third-party requests are handled server-side, preventing client-side data leakage, as emphasized in the features for protecting user privacy.

Real-Time Interactive Cards

Services like IP API and Weather provide live updates without manual refresh, making the dashboard dynamic and useful for quick info access.

Multi-Language Community Support

Supports multiple languages with contributions from users, allowing for global accessibility and easy addition of new locales via documentation.

Easy YAML Configuration

Setup requires only a few lines of YAML, simplifying deployment and customization, as shown in the getting started examples.

Docker and PWA Ready

Pre-built Docker images ensure easy deployment on various platforms, and PWA support enables installable, offline-capable applications.

Cons

Limited Service Ecosystem

The README lists only three core services (IP API, Weather, Base), so users needing diverse integrations must develop custom solutions or wait for community additions.

YAML-Only Configuration Barrier

There's no graphical UI for setup; all customization requires editing YAML files, which can be daunting for users unfamiliar with syntax and prone to errors.

Sparse Advanced Documentation

While basic setup is covered, the README links to external docs; advanced topics like custom service development may lack detailed guidance, limiting extensibility.

Frequently Asked Questions

Related Projects

netdata

The fastest path to AI-powered full stack observability, even for lean teams.

Stars80,463

Forks6,627

Last commit13 hours ago

Portainer

Making Docker and Kubernetes management easy.

A fancy, easy-to-use and reactive self-hosted docker compose.yaml stack-oriented manager

Stars24,285

Forks821

Last commit4 months ago

Theia

Eclipse Theia is a cloud & desktop IDE framework implemented in TypeScript.

Stars21,674

Forks2,892