beenull/runtipi
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
Tipi is a homeserver for everyone! One command setup, one click installs for your favorites self-hosted apps. ✨
72 commits 68 branches 144 tags 14 MiB
TypeScript 95%
JavaScript 2.4%
Shell 1.5%
Dockerfile 0.5%
SCSS 0.5%
Other 0.1%
Find a file
Nicolas Meienberger 2d71de5c10 Update README
2022-05-07 08:27:26 +02:00
.vscode Automatic commit 2022-04-07 10:34:18 +02:00
ansible Fix build issues 2022-05-04 06:51:29 +00:00
app-data Test gluetun config 2022-03-30 21:26:01 +02:00
apps Fix build issues 2022-05-04 06:51:29 +00:00
dashboard Fix build issues 2022-05-04 06:51:29 +00:00
media Fix remove app sudo rights 2022-05-03 20:55:55 +00:00
screenshots WIP: Authentication 2022-04-29 19:42:25 +00:00
scripts Update README 2022-05-07 08:27:26 +02:00
state Remove apps status from source control 2022-04-15 12:37:51 +00:00
system-api Update README 2022-05-07 08:27:26 +02:00
templates Update README 2022-05-07 08:27:26 +02:00
traefik Tailscale app 2022-04-28 18:18:00 +00:00
.gitignore Update README 2022-05-07 08:27:26 +02:00
clean.sh Add Ansible config 2022-04-07 22:13:36 +02:00
docker-compose.yml Tailscale app 2022-04-28 18:18:00 +00:00
LICENSE Create LICENSE 2022-04-22 10:22:43 +00:00
README.md Update README 2022-05-07 08:27:26 +02:00

README.md

⛺️ Tipi — A personal homeserver for everyone

License Version RunsOn RunsOn

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.

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

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.