| .github | ||
| .husky | ||
| app-data | ||
| apps | ||
| media | ||
| packages | ||
| repos | ||
| screenshots | ||
| scripts | ||
| state | ||
| templates | ||
| traefik | ||
| .all-contributorsrc | ||
| .dockerignore | ||
| .gitignore | ||
| CODE_OF_CONDUCT.md | ||
| commitlint.config.js | ||
| docker-compose.dev.yml | ||
| docker-compose.rc.yml | ||
| docker-compose.yml | ||
| Dockerfile | ||
| Dockerfile.dev | ||
| jest.config.js | ||
| LICENSE | ||
| package.json | ||
| pnpm-lock.yaml | ||
| pnpm-workspace.yaml | ||
| README.md | ||
| 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. 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.
Check our demo instance : demo.runtipi.com / username: user@runtipi.com / password: runtipi
Apps available
See the list of apps available and submit your requests in the App Store repo
🛠 Installation
Installation Requirements
Ubuntu 18.04 LTS or higher is recommended. However other major Linux distribution are supported but may lead to installation issues. Please file an issue if you encounter one.
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
Custom settings
You can change the default settings by creating a settings.json file. The file should be located in the state directory. This file will make your changes persist across restarts. Example file:
{
"dnsIp": "9.9.9.9",
"domain": "mydomain.com"
}
Available settings:
dnsIp- The IP address of the DNS server to use. Default:9.9.9.9domain- The domain name to use for the dashboard. Default:localhostport- The port to use for the dashboard. Default:80sslPort- The port to use for the dashboard with SSL. Default:443listenIp- The IP address to listen on. Default:automatically detectedstoragePath- The path to use for storing data. Default:runtipi/app-data
Linking a domain to your dashboard
If you want to link a domain to your dashboard, you can do so by providing the --domain option in the start script.
sudo ./scripts/start.sh --domain mydomain.com
You can also specify it in the settings.json file as shown in the previous section to keep the setting saved across restarts.
A Let's Encrypt certificate will be generated and installed automatically. Make sure to have ports 80 and 443 open on your firewall and that your domain has an A record pointing to your server IP.
Please note that this setting will only expose the dashboard. If you want to expose other apps, you need to configure them individually. You cannot use the --domain option to expose apps.
This option will only work if you keep the default port 80 and 443 for the dashboard.
Uninstalling Tipi
Make sure Tipi is completely stopped and then remove the runtipi directory.
sudo ./scripts/stop.sh
cd ..
sudo rm -rf runtipi
📚 Documentation
For a detailed guide on how to install Tipi. This amazing article by @kycfree1 Running a Home Server with Tipi
You can find more documentation and tutorials / FAQ in the Wiki.
❤️ 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.
The bash script app.sh located in the scripts folder contains some snippets from Umbrel's code. Therefore some parts of the code are licensed under the PolyForm Noncommercial License 1.0.0 license. You can for now consider the whole file under this license. 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!