Tipi is a homeserver for everyone! One command setup, one click installs for your favorites self-hosted apps. ✨

Find a file

Nicolas Meienberger 35db4a00d9 upd: delete db when cleaning [skip ci]		2022-07-26 21:19:39 +00:00
.github	Don't create release tags before publishing images [skip ci]	2022-07-20 19:33:52 +02:00
.husky	Add lint:fix script	2022-06-23 00:08:49 +02:00
.vscode	Automatic commit	2022-04-07 10:34:18 +02:00
app-data	Test gluetun config	2022-03-30 21:26:01 +02:00
apps	fix: Add DNS setting to overseerr [skip ci]	2022-07-26 19:51:22 +00:00
media	Update README [skip ci]	2022-07-26 20:28:05 +02:00
packages	Recovery plan for failed migrations	2022-07-26 20:46:45 +00:00
screenshots	[ImgBot] Optimize images	2022-06-14 07:18:19 +00:00
scripts	upd: delete db when cleaning [skip ci]	2022-07-26 21:19:39 +00:00
state	Remove apps status from source control	2022-04-15 12:37:51 +00:00
templates	Static postgres host in docker	2022-07-06 11:15:35 +02:00
traefik	Tailscale app	2022-04-28 18:18:00 +00:00
.all-contributorsrc	docs: update .all-contributorsrc [skip ci]	2022-06-22 12:08:26 +00:00
.dockerignore	App actions GraphQL	2022-06-22 21:28:48 +02:00
.gitignore	Update README [skip ci]	2022-07-26 20:28:05 +02:00
CODE_OF_CONDUCT.md	Create CODE_OF_CONDUCT.md	2022-05-13 14:04:16 +00:00
docker-compose.dev.yml	Switch esbuild to SWC	2022-07-06 23:03:45 +02:00
docker-compose.rc.yml	Add DNS settings to main api	2022-07-26 21:13:42 +00:00
docker-compose.yml	Add DNS settings to main api	2022-07-26 21:13:42 +00:00
Dockerfile	chore: Remove useless packages	2022-06-30 15:52:55 +02:00
Dockerfile.dev	add: Portainer app	2022-07-25 21:45:15 +02:00
jest.config.js	Test app configs	2022-05-24 18:45:16 +02:00
LICENSE	Create LICENSE	2022-04-22 10:22:43 +00:00
package.json	Bump version	2022-07-26 20:34:06 +02:00
pnpm-lock.yaml	Error handling [skip ci]	2022-07-20 20:11:41 +00:00
pnpm-workspace.yaml	Switch to PNPM Workspaces for internal packages management	2022-05-07 08:03:22 +00:00
README.md	Merge pull request #141 from meienberger/app/portainer	2022-07-26 20:30:32 +02:00
sonar-project.properties	ADD: sonar-project.properties file	2022-07-05 11:42:49 +02:00
tsconfig.json	Test app configs	2022-05-24 18:45:16 +02:00

README.md

⛺️ Tipi — A personal homeserver for everyone

Join the discussion

⚠️ 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.

Check our demo instance : 95.179.210.152 / username: user@runtipi.com / password: runtipi

Apps available

Adguard Home - Adguard Home DNS adblocker
Calibre-Web - Web Ebook Reader
Code-Server - Web VS Code
Filebrowser - Web File Browser
Firefly III - A personal finances manager
Freshrss - A free, self-hostable RSS aggregator
Gitea - Gitea - A painless self-hosted Git service
Homarr - A homepage for your server
Home Assistant - Open source home automation that puts local control and privacy first
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
Libreddit - Private front-end for Reddit
Mealie - Self-hosted recipe manager and meal planner.
n8n - Workflow Automation Tool
Nextcloud - A safe home for all your data
Nitter - Alternative Twitter front-end
Node-RED - Low-code programming for event-driven applications
Overseerr - Request management and media discovery tool for the Plex ecosystem
Photoprism - AI-Powered Photos App for the Decentralized Web. We are on a mission to protect your freedom and privacy.
Pihole - A black hole for Internet advertisements
Plex - Stream Movies & TV Shows
Portainer - Making Docker and Kubernetes management easy.
Prowlarr - A torrent/usenet indexer manager/proxy
Radarr - Movie collection manager for Usenet and BitTorrent users
Readarr - Book Manager and Automation (Sonarr for Ebooks)
Resilio Sync - Fast, reliable, and simple file sync and share solution
Sonarr - TV show manager for Usenet and BitTorrent
Syncthing - Continuous File Synchronization
Tailscale - The easiest, most secure way to use WireGuard and 2FA
Tautulli - A Python based monitoring and tracking tool for Plex Media Server
Transmission - Fast, easy, and free BitTorrent client
Wireguard Easy - WireGuard VPN + Web-based Admin UI
Vaultwarden - Unofficial Bitwarden compatible server

🛠 Installation

Installation Requirements

Ubuntu 18.04 LTS or higher is recommended. However other major Linux distribution are supported but may lead to installation issues. Please file an issue if you encounter one.

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. Tipi will run by default on port 80. To select another port you can run the start script with the --port argument

sudo ./scripts/start.sh --port 7000

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 add a new app or feature, you can follow the Contribution guide for instructions on how to do so.

📜 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.