️ Tipi is a homeserver for everyone! One command setup, one click installs for your favorites self-hosted apps.
Go to file
Nicolas Meienberger 64c39ce23d feat(apps): allow https protocol
Some apps like portainer require the https protocol to open then. New config option to allow setting
the https protocol
2022-08-23 21:40:57 +02:00
.github ci: remove apps tests from pipeline 2022-08-04 23:05:47 +02:00
.husky test: apps.resolver 2022-08-10 22:09:23 +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 feat(api): copy app files locally instead of reading from repo 2022-08-09 20:44:07 +02:00
media revert folder rename for audiobooks 2022-08-03 08:20:11 +02:00
packages feat(apps): allow https protocol 2022-08-23 21:40:57 +02:00
repos wip: external repo for apps [skip ci] 2022-08-03 22:36:27 +02:00
screenshots [ImgBot] Optimize images 2022-06-14 07:18:19 +00:00
scripts feat(dashboard): display more accurate info about updates 2022-08-12 09:26:12 +02:00
state Remove apps status from source control 2022-04-15 12:37:51 +00:00
templates fix: clone scripts 2022-08-11 19:22:02 +00:00
traefik Tailscale app 2022-04-28 18:18:00 +00:00
.all-contributorsrc custom contribution type for apps [skip ci] 2022-08-02 08:56:30 +02:00
.dockerignore App actions GraphQL 2022-06-22 21:28:48 +02:00
.gitignore feat(api): copy app files locally instead of reading from repo 2022-08-09 20:44:07 +02:00
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md 2022-05-13 14:04:16 +00:00
commitlint.config.js test(wip): apps.resolver 2022-07-27 22:15:41 +02:00
docker-compose.dev.yml fix(migration): user query runner for broken entities recovery to avoid type issues 2022-08-17 07:31:55 +02:00
docker-compose.rc.yml fix: clone scripts 2022-08-11 19:22:02 +00:00
docker-compose.yml fix: clone scripts 2022-08-11 19:22:02 +00:00
Dockerfile wip: external repo for apps [skip ci] 2022-08-03 22:36:27 +02:00
Dockerfile.dev wip: external repo for apps [skip ci] 2022-08-03 22:36:27 +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 chore: bump version 2022-08-11 20:13:24 +02:00
pnpm-lock.yaml feat: cron job to update repo periodically 2022-08-11 20:02:32 +02: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 #155 from meienberger/release/0.5.0 2022-08-16 19:22:49 +00: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

Tipi — A personal homeserver for everyone

All Contributors

License Version Issues Docker Pulls Docker Image Size Build codecov

Join the discussion

Discord Matrix

Preview

⚠️ 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
  • Booksonic - A server for streaming your audiobooks
  • 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
  • Ghost - Ghost - Turn your audience into a business
  • 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

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.

🗣 Community

Contributors

Thanks goes to these wonderful people (emoji key):


Nicolas Meienberger

💻 🚇 ⚠️ 📖

ArneNaessens

💻 🤔 ⚠️

DrMxrcy

💻 🤔 ⚠️

Cooper

💻

JTruj1ll0923

💻

Stetsed

💻

Jones_Town

💻

Rushi Chaudhari

💻

This project follows the all-contributors specification. Contributions of any kind welcome!