⛺️ Tipi — A personal homeserver for everyone

⚠️ Tipi is still at an early stage of development and issues are to be expected. Feel free to open an issue or pull request if you find a bug.

Tipi is a personal homeserver orchestrator. It is running docker containers under the hood and provides a simple web interface to manage them. Every service comes with an opinionated configuration in order to remove the need for manual configuration and network setup.

Apps available

Anonaddy - Anonymous email forwarding
Filebrowser - Web File Browser
Freshrss - A free, self-hostable RSS aggregator
Invidious - An alternative front-end to YouTube
Jackett - API Support for your favorite torrent trackers
Jellyfin - A media server for your home collection
Joplin - Privacy focused note-taking app
n8n - Workflow Automation Tool
Nextcloud - A safe home for all your data
Pihole - A black hole for Internet advertisements
Radarr - Movie collection manager for Usenet and BitTorrent users.
Sonarr - TV show manager for Usenet and BitTorrent
Syncthing - Continuous File Synchronization
Tailscale - The easiest, most secure way to use WireGuard and 2FA.
Transmission - Fast, easy, and free BitTorrent client
Wireguard Easy - WireGuard VPN + Web-based Admin UI

🛠 Installation

Installation Requirements

Ubuntu 18.04 LTS or higher (or Debian 10)

Make sure your User ID is 1000 (verify it by running id -u) and ensure that your account is correctly permissioned to use docker.

Step 1. Download Tipi

Run this in an empty directory where you want to install Tipi.

git clone https://github.com/meienberger/runtipi.git

Step 2. Run Tipi

cd into the downloaded directory and run the start script.

cd runtipi && sudo ./scripts/start.sh

The script will prompt you the ip address of the dashboard once configured.

To stop Tipi, run the stop script.

sudo ./scripts/stop.sh

❤️ Contributing

Tipi is made to be very easy to plug in new apps. We welcome and appreciate new contributions.

If you want to support a new app or feature, you can:

Fork the repository and create a new branch for your changes.
Create a pull request.

📜 License

Tipi is licensed under the GNU General Public License v3.0. TL;DR — You may copy, distribute and modify the software as long as you track changes/dates in source files. Any modifications to or software including (via compiler) GPL-licensed code must also be made available under the GPL along with build & install instructions.

3.9 KiB Raw Blame History Unescape Escape