2022-05-07 06:27:26 +00:00
# ⛺️ Tipi — A personal homeserver for everyone
[](https://github.com/meienberger/runtipi/blob/master/LICENSE)
[](https://github.com/meienberger/runtipi/releases)
2022-05-16 09:33:42 +00:00
2022-05-18 12:34:44 +00:00
[](https://hub.docker.com/r/meienberger/tipi-dashboard/)
[](https://hub.docker.com/r/meienberger/tipi-dashboard/)
2022-05-07 06:27:26 +00:00
2022-05-16 09:33:42 +00:00
2022-06-02 08:09:08 +00:00
#### Join the discussion
2022-04-28 18:37:57 +00:00
2022-05-07 06:27:26 +00:00
> ⚠️ 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
2022-05-23 22:06:06 +00:00
- [Adguard Home ](https://github.com/AdguardTeam/AdGuardHome ) - Adguard Home DNS adblocker
2022-05-19 14:04:37 +00:00
- [Calibre-Web ](https://github.com/janeczku/calibre-web ) - Web Ebook Reader
2022-05-21 14:19:29 +00:00
- [Code-Server ](https://github.com/coder/code-server ) - Web VS Code
2022-05-07 06:27:26 +00:00
- [Filebrowser ](https://github.com/filebrowser/filebrowser ) - Web File Browser
- [Freshrss ](https://github.com/FreshRSS/FreshRSS ) - A free, self-hostable RSS aggregator
2022-05-23 22:06:06 +00:00
- [Gitea ](https://github.com/go-gitea/gitea ) - Gitea - A painless self-hosted Git service
- [Homarr ](https://github.com/ajnart/homarr ) - A homepage for your server
2022-05-25 20:59:06 +00:00
- [Home Assistant ](https://github.com/home-assistant/core ) - Open source home automation that puts local control and privacy first
2022-05-07 06:27:26 +00:00
- [Invidious ](https://github.com/iv-org/invidious ) - An alternative front-end to YouTube
- [Jackett ](https://github.com/Jackett/Jackett ) - API Support for your favorite torrent trackers
- [Jellyfin ](https://github.com/jellyfin/jellyfin ) - A media server for your home collection
- [Joplin ](https://github.com/laurent22/joplin ) - Privacy focused note-taking app
2022-05-23 22:06:06 +00:00
- [Libreddit ](https://github.com/spikecodes/libreddit ) - Private front-end for Reddit
2022-05-07 06:27:26 +00:00
- [n8n ](https://github.com/n8n-io/n8n ) - Workflow Automation Tool
- [Nextcloud ](https://github.com/nextcloud/server ) - A safe home for all your data
2022-05-23 22:06:06 +00:00
- [Nitter ](https://github.com/zedeus/nitter ) - Alternative Twitter front-end
2022-06-01 21:12:26 +00:00
- [Node-RED ](https://github.com/node-red/node-red ) - Low-code programming for event-driven applications
- [Photoprism ](https://github.com/photoprism/photoprism ) - AI-Powered Photos App for the Decentralized Web. We are on a mission to protect your freedom and privacy.
2022-05-07 06:27:26 +00:00
- [Pihole ](https://github.com/pi-hole/pi-hole ) - A black hole for Internet advertisements
2022-05-23 22:06:06 +00:00
- [Prowlarr ](https://github.com/Prowlarr/Prowlarr/ ) - A torrent/usenet indexer manager/proxy
- [Radarr ](https://github.com/Radarr/Radarr ) - Movie collection manager for Usenet and BitTorrent users
2022-05-07 06:27:26 +00:00
- [Sonarr ](https://github.com/Sonarr/Sonarr ) - TV show manager for Usenet and BitTorrent
- [Syncthing ](https://github.com/syncthing/syncthing ) - Continuous File Synchronization
2022-05-23 22:06:06 +00:00
- [Tailscale ](https://github.com/tailscale/tailscale ) - The easiest, most secure way to use WireGuard and 2FA
- [Tautulli ](https://github.com/Tautulli/Tautulli ) - A Python based monitoring and tracking tool for Plex Media Server
2022-05-07 06:27:26 +00:00
- [Transmission ](https://github.com/transmission/transmission ) - Fast, easy, and free BitTorrent client
- [Wireguard Easy ](https://github.com/WeeJeWel/wg-easy ) - WireGuard VPN + Web-based Admin UI
2022-05-23 05:47:58 +00:00
- [Vaultwarden ](https://github.com/dani-garcia/vaultwarden ) - Unofficial Bitwarden compatible server
2022-05-23 22:06:06 +00:00
2022-05-07 06:27:26 +00:00
## 🛠 Installation
2022-05-22 09:28:43 +00:00
2022-05-07 06:27:26 +00:00
### Installation Requirements
- Ubuntu 18.04 LTS or higher (or Debian 10)
### Step 1. Download Tipi
Run this in an empty directory where you want to install Tipi.
```bash
git clone https://github.com/meienberger/runtipi.git
```
### Step 2. Run Tipi
cd into the downloaded directory and run the start script.
```bash
2022-05-23 22:07:38 +00:00
cd runtipi
sudo ./scripts/start.sh
2022-05-07 06:27:26 +00:00
```
The script will prompt you the ip address of the dashboard once configured.
2022-05-18 19:09:51 +00:00
Tipi will run by default on port 80. To select another port you can run the start script with the `--port` argument
```bash
sudo ./scripts/start.sh --port 7000
```
2022-05-07 06:27:26 +00:00
To stop Tipi, run the stop script.
```bash
sudo ./scripts/stop.sh
```
## ❤️ Contributing
Tipi is made to be very easy to plug in new apps. We welcome and appreciate new contributions.
2022-05-20 16:04:02 +00:00
If you want to add a new app or feature, you can follow the [Contribution guide ](https://github.com/meienberger/runtipi/wiki/Contributing-to-Tipi ) for instructions on how to do so.
2022-05-07 06:27:26 +00:00
## 📜 License
[](https://github.com/meienberger/runtipi/blob/master/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.
2022-05-16 17:10:12 +00:00
## 🗣 Community
- [Matrix ](https://matrix.to/#/#runtipi:matrix.org )< br />
- [Twitter ](https://twitter.com/runtipi )
2022-05-17 22:57:43 +00:00
- [Telegram ](https://t.me/+72-y10MnLBw2ZGI0 )
