| | | | -------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Open Source** | [](https://github.com/MediaEase/MediaEase/blob/main/LICENSE) | | **Community** | [](https://github.com/MediaEase/MediaEase/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22) | | **CI/CD** | (coming soon) | | **Maintainer** | [](https://github.com/MediaEase) | | **Operating System** | Debian 12 (bookworm) | | **Architecture** | 64 Bits · ARM not supported | | **Tools** | [](https://github.com/Everduin94/better-commits) | | **Status** | [](https://github.com/mkenney/software-guides/blob/master/STABILITY-BADGES.md#alpha) |
Table of Contents
- [About](#about) - [Built With](#built-with) - [Getting Started](#getting-started) - [Prerequisites](#prerequisites) - [Installation](#installation) - [Roadmap](#roadmap) - [Support](#support) - [Project assistance](#project-assistance) - [Contributing](#contributing) - [Authors \& contributors](#authors--contributors) - [Security](#security) - [License](#license) - [Acknowledgements](#acknowledgements)About¶
**MediaEase** is a comprehensive solution designed to simplify the installation and management of media server applications on a dedicated Debian server. By providing an all-in-one platform, **MediaEase** automates the setup and maintenance of applications like Plex, Sonarr, and rTorrent, making the process accessible and user-friendly even for those with limited technical knowledge.
The primary goal of **MediaEase** is to save users time and effort by eliminating the need for complex manual configurations. It ensures a seamless experience, allowing users to focus on enjoying their media rather than dealing with the technical details of server management.
For a better read, and additional informations, you can check the [documentation here](https://mediaease.github.io/docs)
Screenshots| Home Page | Login Page | | :-------------------------------------------------------------------: | :--------------------------------------------------------------------: | |  | |
|
Built With¶
- Bash: For scripting and automating tasks.
- PHP: The core language for the backend logic.
- Composer: Dependency manager for PHP.
- Symfony: The PHP framework used to build the web application.
- NPM: Node package manager for managing frontend dependencies.
Getting Started¶
To get a local copy up and running, follow these simple steps.
Prerequisites¶
Before you begin, ensure you have met the following requirements:
- Operating System: Fresh Debian 12 (Bookworm) server. More distributions support will come later.
Installation¶
Please, refer to the Getting Started guide to know how to install MediaEase and customize your installation.
Roadmap¶
See the open issues for a list of proposed features (and known issues).
- Top Feature Requests (Add your votes using the 👍 reaction)
- Top Bugs (Add your votes using the 👍 reaction)
- Newest Bugs
Support¶
| Documentation | Status |
|---|---|
 [User Guides] |
Coming soon |
| [Api Reference] |
Coming soon |
| [Changelog] |
Coming soon |
| [Roadmap] |
open issues · GitHub Discussions |
| [Available Softwares] |
Coming soon |
Project assistance¶
If you want to say thank you or/and support active development of MediaEase:
- Add a GitHub Star to the project.
- Tweet about the MediaEase.
- Write interesting articles about the project on Dev.to, Medium or your personal blog.
Together, we can make MediaEase better!
Contributing¶
First off, thanks for taking the time to contribute! Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make will benefit everybody else and are greatly appreciated.
Please read our contribution guidelines, and thank you for being involved!
Authors & contributors¶
The original setup of this repository is by MediaEase.
For a full list of all authors and contributors, see the contributors page.
Security¶
MediaEase follows good practices of security, but 100% security cannot be assured. MediaEase is provided "as is" without any warranty. Use at your own risk.
For more information and to report security issues, please refer to our security documentation.
License¶
This project is licensed under the BSD license.
See LICENSE for more information.
Acknowledgements¶
[?] None Yet