❓ What is this

This is the third version of the Homelab

What does it include?

• Login System
  Every user who tries to access any page of the site must enter a username and password.
  After entering the credentials, if they are correct, the user's IP address is recorded and a login session is created for a pre-established duration (can be modified from the configs).
  Once the duration has expired, the user will have to log in again.
• Home
  It allows you to run commands on the site host, view component usage statistics and allows you to view your login session information.
• Music
  It allows you to create playlists and add songs from YouTube (through name, link and playlist) or import a playlist from Spotify (requires an app client ID and secret).
  This page has a discord RPC integration that you can install from the RPC folder; You can enable/disable this integration by changing RPCEnabled value.
• Accounting
  It allows you to keep an accounting within the site with the possibility of adding payments of two types (profit and loss), together with their addition date (date on which the payment was added to the site) and description.
• Agenda
  Allows you to have a to-do list and notes within the site.
• Compression
  It allows you to compress video and audio using various codecs.
  To use this on Windows you need to install ffmpeg.exe and add it inside the folder where the homelab is located.
  Some codecs are not supported by default on linux so you need to install them, this operation varies depending on the distro you're using. For Fedora i suggest to follow this tutorial.
• Configs It allows you to change the colors of the two themes (themes.css) of the site (light and dark), the configuration file (config.json) and to disconnect and/or see the users connected to the site.

💻 How to install

Install the Homelab ⚙️

To install the HomeLab you need to follow these steps:

1. Clone the Repository
2. Install Python (Tested with Python 3.11)
3. Install all the requirements
4. Setup the config.json

• Install Node.js (necessary for the Music section)
• Install ffmpeg.exe (necessary for the Compression section on Windows)

Use Discord RPC 🔊

To use Discord RPC for the Homelab Music section you need to follow these steps:

1. Install Python (Tested with Python 3.11)
2. Install all the requirements
3. Open Discord Developer Portal and create an App for the Homelab
4. Add the App Id inside RPC.py

The files needed to use Discord RPC are located in the /RPC folder.

• Credits

Images & Icons

• Login background image, System icon: Image by Freepik

• Logout icon: Icon by Afian Rochmah Afif – Flaticon

• Start icon: Icon by Gregor Cresnar - Flaticon

• Time icon: Icon by Freepik – Flaticon

• Add icon: Icon by Yudhi Restu – Flaticon

• Details icon: Icon by Fir3Ghost – Flaticon

• Image icon: From plDefault.webm by Superndre – Flaticon

• Shuffle icon: Icon by Pixel perfect – Flaticon

• Pencil icon: Icon by Anggara – Flaticon

• Delete icon: Icon by Ilham Fitrotul Hayat – Flaticon

• Add songs icon: Icon by bsd – Flaticon

• Next song icon: Icon by Abdul Allib – Flaticon

• Mute volume icon, Search icon: Icon by meaicon – Flaticon

• Volume icon: Icon by apien – Flaticon

• Eraser, Download, Upload, Undo icon – Icons8

• Droplet/Ink icon: Icon by yaicon – Freepik

• The images that were converted to .svg were converted by D'axel

Libraries & Tools

• Monaco Editor - License: MIT
• pytubefix - License: MIT
• flask – License: BSD-3-Clause
• psutil - License: BSD-3-Clause
• spotipy - License: MIT
• ffmpeg - License: GNU