Skip to content

Frieren is a micro-framework designed for use in routers and Single Board Computers (SBCs). This framework is built to be lightweight, efficient, and easy to integrate into various hardware projects.

License

Notifications You must be signed in to change notification settings

xchwarze/frieren

Repository files navigation

Frieren: The micro-framework for security gadgets

Panel

Description

Frieren is an advanced micro-framework and application stack crafted for developing security gadgets and tools on routers and Single Board Computers (SBCs). It integrates a lightweight PHP backend with a responsive React frontend, aiming to offer an efficient, modular, and easily adaptable framework for security-focused applications.
The project also features a scaffolding tool for developing new modules with UMD libraries, further enhancing the Frieren ecosystem.

Components

  • Frieren API Backend: A PHP micro-framework that excels in performance, offering features like a mini ORM, CORS configuration, session management, and more.
  • Frieren Web Frontend: Utilizes modern web technologies for a responsive and intuitive user interface, integrating seamlessly with the Frieren backend services.
  • Frieren Module Template: Facilitates the creation of new modules, extending the capabilities of the Frieren project with reusable and distributable components.

Features Across the Ecosystem

  • Efficient database interactions and robust session management.
  • Pre-configured CORS setup for hassle-free cross-origin requests.
  • Modular design for easy maintenance and scalability.
  • Optimized React stack for a minimal footprint and enhanced performance.
  • Support for third-party modules, fostering an extendable ecosystem.

Related Repositories

  • Frieren Modules: Contains community-developed modules based on the frieren-module-template. This repository is a resource for users looking to extend the functionality of their Frieren installation with additional features.
  • Frieren Release: Hosts the installers for deploying precompiled versions of Frieren. This repository is ideal for users who wish to install Frieren quickly and easily without going through the build process.

Installation

Frieren can be installed quickly using an automated script or compiled manually for more control over the installation process. Frieren is currently fully supported only on OpenWRT platforms (official OpenWrt and not any of its forks).

Quick Installation

For a quick and easy installation, execute the following command in your terminal. This script will handle all necessary configurations and setup steps:

wget -qO- https://raw.githubusercontent.com/xchwarze/frieren-release/master/install/install-openwrt.sh | sh

Manual Compilation

Each component within the Frieren project (frieren-back, frieren-front and frieren-module-template) has its own detailed README.md file with specific build and installation instructions. Please refer to these files in their respective directories for more detailed guidance.

Module Development

The frieren-module-template serves as a comprehensive scaffolding tool, specifically designed to streamline the development of UMD modules fully integrated within the Frieren ecosystem. This template simplifies the process of creating and integrating modular features, which are both reusable and distributable, thus significantly enhancing the project ecosystem.

License

The Frieren project is licensed under the LGPL-3.0-only License, emphasizing open-source collaboration and distribution.

Contributing

The Frieren project welcomes contributions. Your input helps enhance the project, whether through new features, improvements to the frontend experience, or the development of modules.

Authors, Acknowledgments, and Contact

  • Lead Developer: DSR! - xchwarze@gmail.com
  • Contributors: A heartfelt thank you to all contributors for supporting and growing the Frieren project.

Support the Development

We're constantly working on new features and improvements for Frieren, and your support can make a big difference! If you find value in Frieren and want to help us continue innovating, consider making a donation. Your contributions will directly fund the acquisition of testing hardware and support the ongoing development of robust security solutions. Send your donation via Binance or for a more engaged experience, where you can receive exclusive updates and builds, join us on Patreon.

patreon binance-qr

About

Frieren is a micro-framework designed for use in routers and Single Board Computers (SBCs). This framework is built to be lightweight, efficient, and easy to integrate into various hardware projects.

Topics

Resources

License

Stars

Watchers

Forks