From 9cfd9d208a077d01c2390592f3af32e871dcf3fa Mon Sep 17 00:00:00 2001 From: Nicolas Meienberger Date: Wed, 8 Mar 2023 18:53:16 +0100 Subject: [PATCH] doc: clarify parts with copyrighted code [skip ci] --- README.md | 4 +++- scripts/app.sh | 7 ++++--- scripts/common.sh | 3 +++ scripts/start-dev.sh | 3 +++ scripts/start.sh | 4 ++++ scripts/stop.sh | 5 +---- 6 files changed, 18 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index ca59f29d..8dd6b4a8 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,9 @@ # Tipi — A personal homeserver for everyone + [![All Contributors](https://img.shields.io/badge/all_contributors-16-orange.svg?style=flat-square)](#contributors-) + [![License](https://img.shields.io/github/license/meienberger/runtipi)](https://github.com/meienberger/runtipi/blob/master/LICENSE) @@ -141,7 +143,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 diff --git a/scripts/app.sh b/scripts/app.sh index 5960f847..ea94c780 100755 --- a/scripts/app.sh +++ b/scripts/app.sh @@ -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 diff --git a/scripts/common.sh b/scripts/common.sh index 84ba7b4b..f9baddec 100644 --- a/scripts/common.sh +++ b/scripts/common.sh @@ -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}" diff --git a/scripts/start-dev.sh b/scripts/start-dev.sh index ce40878f..93bdbe25 100755 --- a/scripts/start-dev.sh +++ b/scripts/start-dev.sh @@ -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}/g" "${template}" sed "${sed_args[@]}" "s//${INTERNAL_IP}/g" "${template}" diff --git a/scripts/start.sh b/scripts/start.sh index 0de85a5c..22728493 100755 --- a/scripts/start.sh +++ b/scripts/start.sh @@ -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}/g" "${template}" sed -i "s//${INTERNAL_IP}/g" "${template}" diff --git a/scripts/stop.sh b/scripts/stop.sh index cda90052..d6a62261 100755 --- a/scripts/stop.sh +++ b/scripts/stop.sh @@ -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