runtipi/README.md
2024-01-24 14:44:12 +02:00

23 KiB

Tipi — A personal homeserver for everyone

All Contributors

License Version Issues Docker Pulls Docker Image Size Build Crowdin

💡 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

Preview

⚠️ 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 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 for installation instructions, documentation and guides.

Demo

You can try out a demo of Tipi at demo.runtipi.io using the following credentials:

username: user@runtipi.io
password: password

📚 Documentation

For a detailed guide on how to install Tipi. This amazing article by @kycfree Running a Home Server with Tipi

You can find more documentation and tutorials / FAQ on runtipi.io

❤️ 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.

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

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

🙏 Acknowledgements

  • Freepik - Thanks for providing a free logo for the project
  • Sentry - Thanks for providing error tracking for the project
  • Crowdin - Thanks for providing localization management for the project
  • CodeRabbit - Thanks for providing free AI code reviews in our Pull Requests

Contributors

Thanks goes to these wonderful people (emoji key):

Nicolas Meienberger
Nicolas Meienberger

💻 🚇 ⚠️ 📖
ArneNaessens
ArneNaessens

💻 🤔 ⚠️
DrMxrcy
DrMxrcy

💻 🤔 ⚠️ 🖋 📣 💬 👀
Cooper
Cooper

💻
JTruj1ll0923
JTruj1ll0923

💻
Stetsed
Stetsed

💻
Jones_Town
Jones_Town

💻
Rushi Chaudhari
Rushi Chaudhari

💻
Robert Blaine
Robert Blaine

💻
Seth For Privacy
Seth For Privacy

💻
Prajna
Prajna

💻
Justin Moy
Justin Moy

💻
dextreem
dextreem

💻
Brahim Hadriche
Brahim Hadriche

💻
Andrew Brereton
Andrew Brereton

🖋
Freddie Sackur
Freddie Sackur

💻 📖
Innocentius
Innocentius

🌍
Alex
Alex

💻
Ryan Wang
Ryan Wang

💻
simonandr
simonandr

🖋
iepure
iepure

🌍
Sergey Kodolov
Sergey Kodolov

🌍 💻
sclaren
sclaren

💻
mcmeel
mcmeel

💬 🤔 💻 📖
NoisyFridge
NoisyFridge

🌍
Bvoxl
Bvoxl

🌍
m-lab-0
m-lab-0

🌍
dannkunt
dannkunt

🌍
Schmanko
Schmanko

🌍
Nghia Lele
Nghia Lele

🌍
amusingimpala75
amusingimpala75

💻
David
David

🌍
Stavros
Stavros

🌍 💻 ⚠️ 📖
loxiry
loxiry

🌍
JigSaw
JigSaw

💻
DireMunchkin
DireMunchkin

💻
Fabio Cingottini
Fabio Cingottini

🌍
him
him

💻
CHALOPIN Clément
CHALOPIN Clément

💻
Geetansh Jindal
Geetansh Jindal

💻
Olivier Garcia
Olivier Garcia

💻
qcoudeyr
qcoudeyr

💻
Armand Gillot
Armand Gillot

💻
Jaffo73
Jaffo73

⚠️ 💻
Jorge Montejo
Jorge Montejo

💻
Frédéric Cilia
Frédéric Cilia

💻
Agustín Carrasco
Agustín Carrasco

💻
Thibault Claude
Thibault Claude

💻
Joshua Banks
Joshua Banks

💻 📖

Did you contribute and want to see your name listed in the README? Write a comment here This project follows the all-contributors specification. Contributions of any kind welcome!