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. ✨
251 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 e40ffd121d WIP: Test continuous logs during install
2022-05-23 19:42:22 +00:00
.github Fix workflow trigger 2022-05-23 06:49:05 +02:00
.husky Add husky pre-commit hook 2022-05-12 21:20:05 +02:00
.vscode Automatic commit 2022-04-07 10:34:18 +02:00
ansible Merge develop 2022-05-17 23:21:25 +02:00
app-data Test gluetun config 2022-03-30 21:26:01 +02:00
apps Fix invidious initalization 2022-05-23 21:06:48 +02:00
media Fix invidious initalization 2022-05-23 21:06:48 +02:00
packages WIP: Test continuous logs during install 2022-05-23 19:42:22 +00:00
screenshots WIP: Authentication 2022-04-29 19:42:25 +00:00
scripts Fix invidious initalization 2022-05-23 21:06:48 +02:00
state Remove apps status from source control 2022-04-15 12:37:51 +00:00
templates Allow custom port 2022-05-18 20:13:58 +02:00
traefik Tailscale app 2022-04-28 18:18:00 +00:00
.gitignore Fix invidious initalization 2022-05-23 21:06:48 +02:00
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md 2022-05-13 14:04:16 +00:00
docker-compose.dev.yml ADD: Docker-compose dev environment 2022-05-17 19:29:12 +02:00
docker-compose.rc.yml Allow custom port 2022-05-18 20:13:58 +02:00
docker-compose.yml Enable CORS for custom port 2022-05-18 20:33:57 +02:00
LICENSE Create LICENSE 2022-04-22 10:22:43 +00:00
package.json Bump version 2022-05-23 08:15:40 +02:00
pnpm-lock.yaml Update dependencies 2022-05-17 20:50:35 +02:00
pnpm-workspace.yaml Switch to PNPM Workspaces for internal packages management 2022-05-07 08:03:22 +00:00
README.md Resolve conflicts 2022-05-23 07:51:57 +02:00
VERSION Bump version 2022-05-23 08:15:40 +02:00

README.md

⛺️ Tipi — A personal homeserver for everyone

License Version Issues Docker Pulls Docker Image Size RunsOn RunsOn Build 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

  • Calibre-Web - Web Ebook Reader
  • Code-Server - Web VS Code
  • Filebrowser - Web File Browser
  • Freshrss - A free, self-hostable RSS aggregator
  • Invidious - An alternative front-end to YouTube
  • Homarr - A homepage for your server.
  • 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
  • Adguard Home - Adguard Home DNS adblocker
  • Libreddit - Private front-end for Reddit
  • Nitter - Alternative Twitter front-end
  • Vaultwarden - Unofficial Bitwarden compatible server
  • Prowlarr - A torrent/usenet indexer manager/proxy
  • Gitea - Gitea - A painless self-hosted Git service.

🛠 Installation

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.

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