https://github.com/meienberger/runtipi

Runtipi is a homeserver for everyone! One command setup, one click installs for your favorites self-hosted apps. ✨
https://github.com/meienberger/runtipi

homeserver linux self-hosted

Last synced: 28 days ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/meienberger/runtipi
• Owner: runtipi
• License: gpl-3.0
• Created: 2022-03-26T15:16:57.000Z (over 2 years ago)
• Default Branch: develop
• Last Pushed: 2024-05-02T00:36:47.000Z (5 months ago)
• Last Synced: 2024-05-02T00:53:31.877Z (5 months ago)
• Topics: homeserver, linux, self-hosted
• Language: TypeScript
• Homepage: https://www.runtipi.io/
• Size: 13.8 MB
• Stars: 6,895
• Watchers: 36
• Forks: 225
• Open Issues: 51
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# Tipi — A personal homeserver for everyone

[![All Contributors](https://img.shields.io/badge/all_contributors-52-orange.svg?style=flat-square)](#contributors-)

[![License](https://img.shields.io/github/license/runtipi/runtipi)](https://github.com/runtipi/runtipi/blob/master/LICENSE)

[![Version](https://img.shields.io/github/v/release/runtipi/runtipi?color=%235351FB&label=version)](https://github.com/runtipi/runtipi/releases)

![Issues](https://img.shields.io/github/issues/runtipi/runtipi)

[![Docker Pulls](https://badgen.net/docker/pulls/meienberger/runtipi?icon=docker&label=pulls)](https://hub.docker.com/r/meienberger/runtipi/)

[![Docker Image Size](https://badgen.net/docker/size/meienberger/runtipi?icon=docker&label=image%20size)](https://hub.docker.com/r/meienberger/runtipi/)

![Build](https://github.com/runtipi/runtipi/workflows/Tipi%20CI/badge.svg)

[![Crowdin](https://badges.crowdin.net/runtipi/localized.svg)](https://crowdin.com/project/runtipi)

> 💡 Tipi is built with TypeScript, Next.js app router and Drizzle ORM! If you want to collaborate on a cool project, join the discussion on Discord!

#### Join the community

[![Discord](https://img.shields.io/discord/976934649643294750?label=discord&logo=discord)](https://discord.gg/Bu9qEPnHsc)

![Preview](https://raw.githubusercontent.com/runtipi/runtipi/develop/screenshots/appstore.png)

> ⚠️ Tipi is built and maintained by volunteers. There is no guarantee of support or security when you use Tipi. While the system is considered stable, it is still in active development and may contain bugs.

Tipi is a personal homeserver orchestrator that makes it easy to manage and run multiple services on a single server. It is based on Docker and comes with a simple web interface to manage your services. Tipi is designed to be easy to use, so you don't have to worry about manual configuration or networking. Simply install Tipi on your server and use the web interface to add and manage services. You can see a list of available services in the [App Store repo](https://github.com/runtipi/runtipi-appstore) and request new ones if you don't see what you need. To get started, follow the installation instructions below.

## Getting started

Visit our website [runtipi.io](https://www.runtipi.io/docs/getting-started/installation?utm_source=github&utm_medium=README&utm_campaign=getting-started) for installation instructions, documentation and guides.

## Demo

You can try out a demo of Tipi at [demo.runtipi.io](https://demo.runtipi.io) using the following credentials:

    username: [email protected]

    password: password

## 📚 Documentation

You can find more documentation and tutorials / FAQ on [runtipi.io](https://www.runtipi.io/docs/introduction?utm_source=github&utm_medium=README&utm_campaign=main-repo-docs)

## ❤️ 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](https://www.runtipi.io/docs/contributing/adding-a-new-app) for instructions on how to do so.

We are looking for contributions of all kinds. If you know design, development, or have ideas for new features, please get in touch.

## 📜 License

[![License](https://img.shields.io/github/license/runtipi/runtipi)](https://github.com/runtipi/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.

## 🗣 Community

- [Twitter](https://twitter.com/runtipi)

- [Discord](https://discord.gg/Bu9qEPnHsc)

## 🙏 Acknowledgements

- [GitHub](https://github.com) - Thanks for generously giving us access to your full product suite

- [Freepik](https://www.flaticon.com/free-icons/tipi) - Thanks for providing a free logo for the project

- [Sentry](https://sentry.io) - Thanks for providing error tracking for the project

- [Crowdin](https://crowdin.com) - Thanks for providing localization management for the project

- [CodeRabbit](https://coderabbit.ai/) - Thanks for providing free AI code reviews in our Pull Requests

## 🔀 Server Actions - Component Flow

[![Server Actions - Component Flow](https://nextjs.apidiagram.com/github/runtipi/runtipi/diagram.svg)](https://nextjs.apidiagram.com/github/runtipi/runtipi)

## ✨ Contributors

Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

  

    

      
Nicolas Meienberger
💻 🚇 ⚠️ 📖

      
ArneNaessens
💻 🤔 ⚠️

      
DrMxrcy
💻 🤔 ⚠️ 🖋 📣 💬 👀

      
Cooper
💻

      
JTruj1ll0923
💻

      
Stetsed
💻

      
Jones_Town
💻

    

    

      
Rushi Chaudhari
💻

      
Robert Blaine
💻

      
Seth For Privacy
💻

      
Prajna
💻

      
Justin Moy
💻

      
dextreem
💻

      
Brahim Hadriche
💻

    

    

      
Andrew Brereton
🖋

      
Freddie Sackur
💻 📖

      
Innocentius
🌍

      
Alex
💻

      
Ryan Wang
💻

      
simonandr
🖋

      
iepure
🌍

    

    

      
Sergey Kodolov
🌍 💻

      
sclaren
💻

      
mcmeel
💬 🤔 💻 📖

      
NoisyFridge
🌍

      
Bvoxl
🌍

      
m-lab-0
🌍

      
dannkunt
🌍

    

    

      
Schmanko
🌍

      
Nghia Lele
🌍

      
amusingimpala75
💻

      
David
🌍

      
Stavros
🌍 💻 ⚠️ 📖

      
loxiry
🌍

      
JigSaw
💻

    

    

      
DireMunchkin
💻

      
Fabio Cingottini
🌍

      
him
💻

      
CHALOPIN Clément
💻

      
Geetansh Jindal
💻

      
Olivier Garcia
💻

      
qcoudeyr
💻

    

    

      
Armand Gillot
💻

      
Jaffo73
⚠️ 💻

      
Jorge Montejo
💻

      
Frédéric Cilia
💻

      
Agustín Carrasco
💻

      
Thibault Claude
💻

      
Joshua Banks
💻 📖

    

    

      
hex-developer
💻

      
Gabriel Farias Nunes
🌍

      
Boogie Cigdemoglu
📖

    

  

Did you contribute and want to see your name listed in the README? Write a comment [here](https://github.com/runtipi/runtipi/issues/380)

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!