https://github.com/jarmos-san/homelab

🧪 The repository containing management resources for my homelab
https://github.com/jarmos-san/homelab

homelab

Last synced: 13 days ago
JSON representation

🧪 The repository containing management resources for my homelab

• Host: GitHub
• URL: https://github.com/jarmos-san/homelab
• Owner: Jarmos-san
• License: mit
• Created: 2022-05-23T09:16:06.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-12-22T20:26:41.000Z (about 1 month ago)
• Last Synced: 2024-12-22T21:26:24.845Z (about 1 month ago)
• Topics: homelab
• Homepage:
• Size: 112 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Homelab Server

[![QA Checks](https://github.com/Jarmos-san/homelab/actions/workflows/qa-checks.yml/badge.svg)](https://github.com/Jarmos-san/homelab/actions/workflows/qa-checks.yml)

![GitHub](https://img.shields.io/github/license/Jarmos-san/homelab?style=flat-square&logo=GitHub&label=License)

![GitHub repo size](https://img.shields.io/github/repo-size/Jarmos-san/homelab?style=flat-sqare&logo=GitHub)

![X (formerly Twitter) Follow](https://img.shields.io/twitter/follow/Jarmosan)

**DISCLAIMER**: This is a **work-in-progress** project!

This repository holds the contents for setting up a personal

[Home Server](https://en.wikipedia.org/wiki/Home_server). You can run the

following command to automate the setup procedure at one go;

```console

curl -fsSL https://tinyurl.com/setup-homelab | bash

```

The server will be powered by [Debian](https://www.debian.org/) (or a distro

based on Debian like [Ubuntu Server](https://ubuntu.com/server)) and the tools

installed on the server will be managed by [Docker](https://www.docker.com).

There is also an [automation script](./setup) which downloads and sets up some

of the necessary tools for the server before the services can be setup.

That said, following are a list of tools I plan on adding to the server;

| Software Name                                                | Reasons for Inclusion                                                         |

| ------------------------------------------------------------ | ----------------------------------------------------------------------------- |

| [Sonarr](https://sonarr.tv) (_unplanned_)                    | For automatic downloading of my favourite animes & TV shows                   |

| [Prowlarr](https://wiki.servarr.com/prowlarr) (_unplanned_)  | For managing the indexes under a single banner                                |

| [Radarr](https://radarr.video) (_unplanned_)                 | For downloading my favourite movies whenever they are available               |

| [Lidarr](https://lidarr.audio) (_unplanned_)                 | For automatic downloading & local archival of songs                           |

| [Jeyllfin](https://jellyfin.org) (_unplanned_)               | For managing all the media downloaded using the aforementioned tools          |

| [Homepage](https://github.com/benphelps/homepage)            | For managing the containerised applications right within an accesible browser |

| [AdGuard Home](https://github.com/AdguardTeam/AdGuardHome)   | For network-wide adblocking and malware filtering                             |

| [Transmission BitTorrent Client](https://transmissionbt.com) | To download and seed Torrent files                                            |

| Some URL Shortener (**TBD**)                                 |                                                                               |

...more such tools will be added to the list as & when the need arises!

**NOTE**: Most of the aforementioned Container Images will be grabbed from

[LinuxServer.io](https://www.linuxserver.io/) since those are community

maintained and are specifically configured for usage within server environments!