| __mocks__ | ||
| .devcontainer | ||
| .github | ||
| public | ||
| screenshots | ||
| scripts | ||
| src | ||
| templates | ||
| tests | ||
| traefik | ||
| .all-contributorsrc | ||
| .dockerignore | ||
| .env.example | ||
| .env.test | ||
| .eslintignore | ||
| .eslintrc.js | ||
| .gitignore | ||
| .prettierrc.js | ||
| CODE_OF_CONDUCT.md | ||
| docker-compose.dev.yml | ||
| docker-compose.rc.yml | ||
| docker-compose.test.yml | ||
| docker-compose.yml | ||
| Dockerfile | ||
| Dockerfile.dev | ||
| esbuild.js | ||
| jest.config.ts | ||
| LICENSE | ||
| next-env.d.ts | ||
| next.config.mjs | ||
| nodemon.json | ||
| package.json | ||
| pnpm-lock.yaml | ||
| README.md | ||
| reset.d.ts | ||
| sonar-project.properties | ||
| tsconfig.json | ||
Tipi — A personal homeserver for everyone
Join the discussion
⚠️ 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 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
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.
Some of the bash scripts located in the scripts folder contain some snippets from Umbrel's code. Therefore some parts of the code are licensed under the PolyForm Noncommercial License 1.0.0 license. These parts have been marked with a comment above to clearly identify it. If you were to use this code in your own project, you have to keep the copyright notice and follow the license guidelines. We are actively working on re-writing those parts in order to make them available under the GPL license like the rest of our code.
🗣 Community
Contributors ✨
Thanks goes to these wonderful people (emoji key):
This project follows the all-contributors specification. Contributions of any kind welcome!
