Home Server

My Home Server for file storage, photo, movie, tv management & serving, with many other bells and whistles.

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Service Links
4. Roadmap

About The Project

(back to top)

Built With

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• Docker

  # Add Docker's official GPG key:
  sudo apt-get update
  sudo apt-get install ca-certificates curl gnupg
  sudo install -m 0755 -d /etc/apt/keyrings
  curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo gpg --dearmor -o /etc/apt/keyrings/docker.gpg
  sudo chmod a+r /etc/apt/keyrings/docker.gpg
  
  # Add the repository to Apt sources:
  echo \
    "deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/docker.gpg] https://download.docker.com/linux/ubuntu \
    $(. /etc/os-release && echo "$VERSION_CODENAME") stable" | \
    sudo tee /etc/apt/sources.list.d/docker.list > /dev/null
  sudo apt-get update
  
  # Install the Docker package
  sudo apt-get install docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin

• MergerFS & SnapRAID
  • https://thenomadcode.tech/mergerfs-snapraid-is-the-new-raid-5

Installation

1. Clone the repo

   git clone https://github.com/CampAsAChamp/home-server.git

2. Start the main stack

   cd docker
   docker compose up -d

3. Start the Spotify stack

   cd spotify
   docker compose up -d

   i. Set up your Spotify Developers application if you haven't already https://github.com/Yooooomi/your_spotify?tab=readme-ov-file#creating-the-spotify-application
4. Start the Immich stack

   cd immich
   docker compose up -d

5. TODO: Create a command to start all of them together

(back to top)

Service Links

1. Portainer
2. Homer
3. Immich
4. File Browser
5. qBittorrent
6. Plex
7. Radarr (Movies)
8. Sonarr (TV)
9. Prowlarr
10. Jackett
11. Tautulli
12. Scrutiny
13. Your Spotify
14. Nginx Proxy Manager

(back to top)

Roadmap

• Wake On Lan support
• Save login passwords to Bitwarden
• Custom Nginx Proxy Manager theme
• Experiment with Traefik for Reverse Proxy with CORS

(back to top)