include master commits into develop
This commit is contained in:
Nicolas Meienberger
commit
d05efcc4ce
7 changed files with 30 additions and 101 deletions
103
README.md
103
README.md
|
|
@ -1,7 +1,9 @@
|
|||
# Tipi — A personal homeserver for everyone
|
||||
|
||||
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
|
||||
|
||||
[](#contributors-)
|
||||
|
||||
<!-- ALL-CONTRIBUTORS-BADGE:END -->
|
||||
|
||||
[](https://github.com/meienberger/runtipi/blob/master/LICENSE)
|
||||
|
|
@ -23,6 +25,10 @@
|
|||
|
||||
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/meienberger/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) for installation instructions, documentation and guides.
|
||||
|
||||
## Demo
|
||||
|
||||
You can try out a demo of Tipi at [demo.runtipi.com](https://demo.runtipi.com) using the following credentials:
|
||||
|
|
@ -30,108 +36,17 @@ You can try out a demo of Tipi at [demo.runtipi.com](https://demo.runtipi.com) u
|
|||
username: user@runtipi.com
|
||||
password: runtipi
|
||||
|
||||
## 🛠 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.
|
||||
|
||||
### Download and install Tipi
|
||||
|
||||
Download the latest version of Tipi:
|
||||
|
||||
```bash
|
||||
curl -L https://setup.runtipi.com | bash
|
||||
```
|
||||
|
||||
The script will prompt you the ip address of the dashboard once configured.
|
||||
|
||||
### Commands
|
||||
|
||||
If you already installed Tipi, you can start it manually by running the `start.sh` script in the `runtipi` folder.
|
||||
|
||||
```bash
|
||||
cd runtipi
|
||||
sudo ./scripts/start.sh
|
||||
```
|
||||
|
||||
Tipi will run by default on port 80. To select another port you can run the start script with the `--port` argument
|
||||
|
||||
```bash
|
||||
sudo ./scripts/start.sh --port 7000
|
||||
```
|
||||
|
||||
To stop Tipi, run the stop script.
|
||||
|
||||
```bash
|
||||
sudo ./scripts/stop.sh
|
||||
```
|
||||
|
||||
### Update Tipi
|
||||
|
||||
To update Tipi to the latest version, run the update script.
|
||||
|
||||
```bash
|
||||
sudo ./scripts/system.sh update
|
||||
```
|
||||
|
||||
### Custom settings
|
||||
|
||||
You can change the default settings by creating a `settings.json` file. The file should be located in the `runtipi/state` directory. This file will make your changes persist across restarts. Example file:
|
||||
|
||||
```json
|
||||
{
|
||||
"dnsIp": "9.9.9.9",
|
||||
"domain": "mydomain.com"
|
||||
}
|
||||
```
|
||||
|
||||
Available settings:
|
||||
|
||||
- `dnsIp` - The IP address of the DNS server to use. Default: `9.9.9.9`
|
||||
- `domain` - The domain name to use for the dashboard. Default: `localhost`
|
||||
- `port` - The port to use for the dashboard. Default: `80`
|
||||
- `sslPort` - The port to use for the dashboard with SSL. Default: `443`
|
||||
- `listenIp` - The IP address to listen on. Default: `automatically detected`
|
||||
- `storagePath` - 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.
|
||||
|
||||
```bash
|
||||
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.
|
||||
|
||||
```bash
|
||||
sudo ./scripts/stop.sh
|
||||
cd ..
|
||||
sudo rm -rf runtipi
|
||||
```
|
||||
|
||||
## 📚 Documentation
|
||||
|
||||
For a detailed guide on how to install Tipi. This amazing article by @kycfree [Running a Home Server with Tipi](https://kyc3.life/running-a-home-server-with-tipi/)
|
||||
|
||||
You can find more documentation and tutorials / FAQ in the [Wiki](https://github.com/meienberger/runtipi/wiki).
|
||||
You can find more documentation and tutorials / FAQ on [runtipi.io](https://www.runtipi.io/docs/introduction)
|
||||
|
||||
## ❤️ 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://github.com/meienberger/runtipi/wiki/Adding-your-own-app) for instructions on how to do so.
|
||||
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.
|
||||
|
||||
|
|
@ -141,7 +56,7 @@ We are looking for contributions of all kinds. If you know design, development,
|
|||
|
||||
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](https://github.com/getumbrel/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.
|
||||
Some of the bash scripts located in the `scripts` folder contain some snippets from [Umbrel](https://github.com/getumbrel/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
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,4 @@
|
|||
#!/usr/bin/env bash
|
||||
# Required Notice: Copyright
|
||||
# Umbrel (https://umbrel.com)
|
||||
|
||||
echo "Starting app script"
|
||||
|
||||
source "${BASH_SOURCE%/*}/common.sh"
|
||||
|
|
@ -57,6 +54,10 @@ else
|
|||
fi
|
||||
fi
|
||||
|
||||
|
||||
# Function below has been modified from Umbrel
|
||||
# Required Notice: Copyright
|
||||
# Umbrel (https://umbrel.com)
|
||||
compose() {
|
||||
local app="${1}"
|
||||
shift
|
||||
|
|
|
|||
|
|
@ -16,6 +16,9 @@ function write_log() {
|
|||
echo "$(date) - ${message}" >>"${log_file}"
|
||||
}
|
||||
|
||||
# Function below is taken from Umbrel
|
||||
# Required Notice: Copyright
|
||||
# Umbrel (https://umbrel.com)
|
||||
function derive_entropy() {
|
||||
SEED_FILE="${STATE_FOLDER}/seed"
|
||||
identifier="${1}"
|
||||
|
|
|
|||
|
|
@ -84,6 +84,11 @@ mkdir -p media/torrents/watch
|
|||
mkdir -p media/torrents/completed
|
||||
mkdir -p media/torrents/incomplete
|
||||
|
||||
mkdir -p media/usenet
|
||||
mkdir -p media/usenet/watch
|
||||
mkdir -p media/usenet/completed
|
||||
mkdir -p media/usenet/incomplete
|
||||
|
||||
mkdir -p media/data
|
||||
mkdir -p media/data/books
|
||||
mkdir -p media/data/movies
|
||||
|
|
@ -91,6 +96,7 @@ mkdir -p media/data/music
|
|||
mkdir -p media/data/tv
|
||||
mkdir -p media/data/podcasts
|
||||
mkdir -p media/data/images
|
||||
mkdir -p media/data/roms
|
||||
|
||||
## remove downloaded folder
|
||||
rm -rf runtipi-"${LATEST_VERSION}"
|
||||
|
|
|
|||
|
|
@ -93,6 +93,9 @@ if [[ "$OS" == "Darwin" ]]; then
|
|||
sed_args=(-i '')
|
||||
fi
|
||||
|
||||
# Function below is modified from Umbrel
|
||||
# Required Notice: Copyright
|
||||
# Umbrel (https://umbrel.com)
|
||||
for template in ${ENV_FILE}; do
|
||||
sed "${sed_args[@]}" "s/<dns_ip>/${DNS_IP}/g" "${template}"
|
||||
sed "${sed_args[@]}" "s/<internal_ip>/${INTERNAL_IP}/g" "${template}"
|
||||
|
|
|
|||
|
|
@ -244,6 +244,10 @@ ENV_FILE=$(mktemp)
|
|||
[[ -f "${ROOT_FOLDER}/.env" ]] && rm -f "${ROOT_FOLDER}/.env"
|
||||
[[ -f "$ROOT_FOLDER/templates/env-sample" ]] && cp "$ROOT_FOLDER/templates/env-sample" "$ENV_FILE"
|
||||
|
||||
|
||||
# Function below is modified from Umbrel
|
||||
# Required Notice: Copyright
|
||||
# Umbrel (https://umbrel.com)
|
||||
for template in ${ENV_FILE}; do
|
||||
sed -i "s/<dns_ip>/${DNS_IP}/g" "${template}"
|
||||
sed -i "s/<internal_ip>/${INTERNAL_IP}/g" "${template}"
|
||||
|
|
|
|||
|
|
@ -10,9 +10,6 @@ ROOT_FOLDER="${PWD}"
|
|||
ENV_FILE="${ROOT_FOLDER}/.env"
|
||||
STORAGE_PATH=$(grep -v '^#' "${ENV_FILE}" | xargs -n 1 | grep STORAGE_PATH | cut -d '=' -f2)
|
||||
|
||||
export DOCKER_CLIENT_TIMEOUT=240
|
||||
export COMPOSE_HTTP_TIMEOUT=240
|
||||
|
||||
# Stop all installed apps if there are any
|
||||
apps_folder="${ROOT_FOLDER}/apps"
|
||||
if [ "$(find "${apps_folder}" -maxdepth 1 -type d | wc -l)" -gt 1 ]; then
|
||||
|
|
@ -30,6 +27,6 @@ else
|
|||
fi
|
||||
|
||||
kill_watcher
|
||||
echo "Stopping Docker services..."
|
||||
echo "Stopping tipi..."
|
||||
echo
|
||||
docker compose down --remove-orphans --rmi local
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue