318 lines
6.5 KiB
Markdown
318 lines
6.5 KiB
Markdown
---
|
|
title: Introduction
|
|
description: Introduction to Serveex, a personal homelab project to self-host everyday services using Debian and Docker, replacing cloud services as Google, Apple or Netflix.
|
|
navigation:
|
|
icon: i-lucide-bookmark
|
|
---
|
|
|
|
|
|
:ellipsis{left=0px width=40rem top=10rem blur=140px zIndex=60}
|
|
## A Home Lab by a Beginner, for Beginners
|
|
|
|
|
|
|
|
**Serveex** is primarily a personal project aimed at hosting as many everyday services as possible at home, without relying on proprietary platforms (Google, Apple, Netflix, etc.). The goal was to experiment, learn, and document every step along the way. This is purely a scientific project and is not intended for production use.
|
|
|
|
A big thanks to **Nipah** for sharing his infinite knowledge and, above all, for his patience.
|
|
|
|
::note{icon=""}
|
|
📋 **Prerequisites:**
|
|
- Have [an online VPS](https://www.it-connect.fr/les-serveurs-prives-virtuels-vps-pour-les-debutants/) or a local machine: ideally a mini PC (you can find N100 models for around €100), but it also works on a laptop or [a virtual machine](https://openclassrooms.com/fr/courses/2035806-virtualisez-votre-architecture-et-vos-environnements-de-travail/6313946-installez-virtualbox). The [Freebox Delta/Ultra offer virtual machines](https://next.ink/3493/machines-virtuelles-et-freebox-delta-comment-heberger-votre-premiere-page-web/).
|
|
- Know how to configure [NAT rules on a router and assign DHCP leases](/general/networking/nat)
|
|
- Know how to configure the [DNS zone of a domain name](/general/networking/dns)
|
|
::
|
|
|
|
<div align="center">
|
|
<img src="/img/serveex/serveex.svg" align="center" width="700">
|
|
</div>
|
|
|
|
The goal is to be easily deployable and easy to migrate, so here is its structure:
|
|
|
|
### The Core of the Server
|
|
|
|
:::div{class="relative"}
|
|
:ellipsis{left=0px width=40rem top=10rem blur=140px}
|
|
:::
|
|
|
|
::card-group
|
|
::card{icon="i-logos-debian" title="Operating System" to="/serveex/core/installation"}
|
|
Install and configure Debian 13
|
|
::
|
|
|
|
::card{icon="i-logos-docker-icon" title="Using apps container" to="/serveex/core/docker"}
|
|
Install Docker
|
|
::
|
|
|
|
::card
|
|
---
|
|
icon: i-carbon-container-registry
|
|
title: Container manager
|
|
to: "/serveex/core/docker#installer-dockge-pour-gérer-et-déployer-les-conteneurs"
|
|
ui:
|
|
icon: text-[#74C2FF]
|
|
---
|
|
Install and deploy Dockge
|
|
::
|
|
|
|
::card
|
|
---
|
|
icon: i-simple-icons-wireguard
|
|
title: VPN
|
|
to: /serveex/security/wireguard
|
|
ui:
|
|
icon: text-[#88171A]
|
|
---
|
|
Install and deploy Wireguard
|
|
::
|
|
|
|
::card{icon="i-noto-globe-showing-americas" title="Reverse Proxy" to="/serveex/core/swag"}
|
|
Expose your services with SWAG
|
|
::
|
|
::
|
|
|
|
### Security
|
|
|
|
:::div{class="relative"}
|
|
:ellipsis{left=0px width=40rem top=10rem blur=140px}
|
|
:::
|
|
|
|
::card-group
|
|
|
|
|
|
::card{icon="i-noto-locked-with-key" title="Forward Auth" to="/serveex/security/tinyauth"}
|
|
Install and deploy TinyAuth
|
|
::
|
|
|
|
::card{icon="i-noto-identification-card" title="Passwordless SSO" to="/serveex/security/pocket-id"}
|
|
Install and deploy Pocket ID
|
|
::
|
|
|
|
::card{icon="i-logos-cloudflare-icon" title="Zero Trust" to="/serveex/security/cloudflare"}
|
|
Install and deploy Cloudflared
|
|
::
|
|
::
|
|
|
|
### Monitoring
|
|
|
|
:::div{class="relative"}
|
|
:ellipsis{left=0px width=40rem top=10rem blur=140px}
|
|
:::
|
|
|
|
::card-group
|
|
::card
|
|
---
|
|
icon: i-solar-pulse-linear
|
|
title: Service Status
|
|
to: /serveex/monitoring/uptime-kuma
|
|
ui:
|
|
icon: text-[#5CDD8B]
|
|
---
|
|
Install and deploy Uptime-Kuma
|
|
::
|
|
|
|
::card
|
|
---
|
|
icon: i-lucide-logs
|
|
title: Log Management
|
|
to: /serveex/monitoring/dozzle
|
|
ui:
|
|
icon: text-[#FFA600]
|
|
---
|
|
Install and deploy Dozzle
|
|
::
|
|
|
|
::card{icon="i-noto-rabbit" title="Connection Management" to="/serveex/monitoring/speedtest-tracker"}
|
|
Install and deploy Speedtest Tracker
|
|
::
|
|
|
|
::card
|
|
---
|
|
icon: i-lucide-chart-column-decreasing
|
|
title: Resource Status
|
|
to: /serveex/monitoring/beszel
|
|
ui:
|
|
icon: text-[#747bff]
|
|
---
|
|
Install and deploy Beszel
|
|
::
|
|
|
|
::card
|
|
---
|
|
icon: i-lucide-circle-power
|
|
title: Wake on Lan
|
|
to: /serveex/monitoring/upsnap
|
|
ui:
|
|
icon: text-[#5BDAFD]
|
|
---
|
|
Install and deploy UpSnap
|
|
::
|
|
::
|
|
|
|
### Media
|
|
|
|
:::div{class="relative"}
|
|
:ellipsis{left=0px width=40rem top=10rem blur=140px}
|
|
:::
|
|
|
|
::card-group
|
|
::card
|
|
---
|
|
icon: i-simple-icons-jellyfin
|
|
title: Media
|
|
to: /serveex/media/jellyfin
|
|
ui:
|
|
icon: text-[#00A4DC]
|
|
---
|
|
Install and deploy Jellyfin
|
|
::
|
|
|
|
::card
|
|
---
|
|
icon: i-cbi-qbittorrent
|
|
title: Seedbox
|
|
to: /serveex/media/qbittorrent
|
|
ui:
|
|
icon: text-[#2F67BA]
|
|
---
|
|
Install and deploy Qbittorrent
|
|
::
|
|
|
|
::card
|
|
---
|
|
icon: i-cbi-radarr
|
|
title: Automation
|
|
to: /serveex/media/servarr
|
|
ui:
|
|
icon: text-[#FFCB3D]
|
|
---
|
|
Install and deploy the Servarr stack
|
|
::
|
|
::
|
|
|
|
### Cloud Drive & Photos
|
|
|
|
:::div{class="relative"}
|
|
:ellipsis{left=0px width=40rem top=10rem blur=140px}
|
|
:::
|
|
|
|
::card-group
|
|
::card
|
|
---
|
|
icon: i-cib-nextcloud
|
|
title: Drive
|
|
to: /serveex/cloud/nextcloud
|
|
ui:
|
|
icon: text-[#0082C9]
|
|
---
|
|
Install and deploy Nextcloud
|
|
::
|
|
|
|
::card
|
|
---
|
|
icon: i-simple-icons-immich
|
|
title: Photos
|
|
to: /serveex/cloud/immich
|
|
ui:
|
|
icon: text-[#4250AF]
|
|
---
|
|
Install and deploy Immich
|
|
::
|
|
::
|
|
|
|
### Files & Sharing
|
|
|
|
:::div{class="relative"}
|
|
:ellipsis{left=0px width=40rem top=10rem blur=140px}
|
|
:::
|
|
|
|
::card-group
|
|
::card{icon="i-noto-open-file-folder" title="File Explorer" to="/serveex/files/file-browser-quantum"}
|
|
Install and deploy File Browser Quantum
|
|
::
|
|
|
|
::card
|
|
---
|
|
icon: i-carbon-share
|
|
title: Sharing
|
|
to: /serveex/files/pingvin
|
|
ui:
|
|
icon: text-[#46509E]
|
|
---
|
|
Install and deploy Pingvin
|
|
::
|
|
::
|
|
|
|
### Development Tools
|
|
|
|
:::div{class="relative"}
|
|
:ellipsis{left=0px width=40rem top=10rem blur=140px}
|
|
:::
|
|
|
|
::card-group
|
|
::card{icon="i-logos-visual-studio-code" title="Visual Studio Code" to="/serveex/development/code-server"}
|
|
Install and deploy code-server
|
|
::
|
|
|
|
::card
|
|
---
|
|
icon: i-simple-icons-forgejo
|
|
title: Git Repository
|
|
to: /serveex/development/forgejo
|
|
ui:
|
|
icon: text-[#FB923C]
|
|
---
|
|
Install and deploy Forgejo
|
|
::
|
|
|
|
::card{icon="i-noto-hammer-and-wrench" title="Tools" to="/serveex/development/it-tools"}
|
|
Install and deploy IT Tools
|
|
::
|
|
::
|
|
|
|
### Useful Applications
|
|
|
|
:::div{class="relative"}
|
|
:ellipsis{left=0px width=40rem top=10rem blur=140px}
|
|
:::
|
|
|
|
::card-group
|
|
::card
|
|
---
|
|
icon: i-cbi-adguard
|
|
title: Ad-blocking DNS and Filters
|
|
to: /serveex/apps/adguard
|
|
ui:
|
|
icon: text-[#68BC71]
|
|
---
|
|
Install and deploy Adguard Home
|
|
::
|
|
|
|
::card
|
|
---
|
|
icon: i-cbi-bitwarden
|
|
title: Password Manager
|
|
to: /serveex/apps/vaultwarden
|
|
ui:
|
|
icon: text-[#175DDC]
|
|
---
|
|
Install and deploy Vaultwarden
|
|
::
|
|
::
|
|
|
|
### Advanced
|
|
|
|
:::div{class="relative"}
|
|
:ellipsis{left=0px width=40rem top=10rem blur=140px}
|
|
:::
|
|
|
|
::card-group
|
|
::card{icon="i-noto-key" title="SSO & MFA" to="/serveex/advanced/authentik"}
|
|
Install and deploy Authentik
|
|
::
|
|
::
|
|
|
|
## Coming Soon
|
|
|
|
- Homepage, to have all your services at a glance and access them easily
|
|
- Zensical, how to write and organize your own documentation
|