doc: clarify parts with copyrighted code [skip ci]

This commit is contained in:
Nicolas Meienberger 2023-03-08 18:53:16 +01:00
parent 029b9a7ec2
commit 9cfd9d208a
6 changed files with 18 additions and 8 deletions

View file

@ -1,7 +1,9 @@
# Tipi — A personal homeserver for everyone # Tipi — A personal homeserver for everyone
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section --> <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
[![All Contributors](https://img.shields.io/badge/all_contributors-16-orange.svg?style=flat-square)](#contributors-) [![All Contributors](https://img.shields.io/badge/all_contributors-16-orange.svg?style=flat-square)](#contributors-)
<!-- ALL-CONTRIBUTORS-BADGE:END --> <!-- ALL-CONTRIBUTORS-BADGE:END -->
[![License](https://img.shields.io/github/license/meienberger/runtipi)](https://github.com/meienberger/runtipi/blob/master/LICENSE) [![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. 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 ## 🗣 Community

View file

@ -1,7 +1,4 @@
#!/usr/bin/env bash #!/usr/bin/env bash
# Required Notice: Copyright
# Umbrel (https://umbrel.com)
echo "Starting app script" echo "Starting app script"
source "${BASH_SOURCE%/*}/common.sh" source "${BASH_SOURCE%/*}/common.sh"
@ -57,6 +54,10 @@ else
fi fi
fi fi
# Function below has been modified from Umbrel
# Required Notice: Copyright
# Umbrel (https://umbrel.com)
compose() { compose() {
local app="${1}" local app="${1}"
shift shift

View file

@ -16,6 +16,9 @@ function write_log() {
echo "$(date) - ${message}" >>"${log_file}" echo "$(date) - ${message}" >>"${log_file}"
} }
# Function below is taken from Umbrel
# Required Notice: Copyright
# Umbrel (https://umbrel.com)
function derive_entropy() { function derive_entropy() {
SEED_FILE="${STATE_FOLDER}/seed" SEED_FILE="${STATE_FOLDER}/seed"
identifier="${1}" identifier="${1}"

View file

@ -93,6 +93,9 @@ if [[ "$OS" == "Darwin" ]]; then
sed_args=(-i '') sed_args=(-i '')
fi fi
# Function below is modified from Umbrel
# Required Notice: Copyright
# Umbrel (https://umbrel.com)
for template in ${ENV_FILE}; do for template in ${ENV_FILE}; do
sed "${sed_args[@]}" "s/<dns_ip>/${DNS_IP}/g" "${template}" sed "${sed_args[@]}" "s/<dns_ip>/${DNS_IP}/g" "${template}"
sed "${sed_args[@]}" "s/<internal_ip>/${INTERNAL_IP}/g" "${template}" sed "${sed_args[@]}" "s/<internal_ip>/${INTERNAL_IP}/g" "${template}"

View file

@ -244,6 +244,10 @@ ENV_FILE=$(mktemp)
[[ -f "${ROOT_FOLDER}/.env" ]] && rm -f "${ROOT_FOLDER}/.env" [[ -f "${ROOT_FOLDER}/.env" ]] && rm -f "${ROOT_FOLDER}/.env"
[[ -f "$ROOT_FOLDER/templates/env-sample" ]] && cp "$ROOT_FOLDER/templates/env-sample" "$ENV_FILE" [[ -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 for template in ${ENV_FILE}; do
sed -i "s/<dns_ip>/${DNS_IP}/g" "${template}" sed -i "s/<dns_ip>/${DNS_IP}/g" "${template}"
sed -i "s/<internal_ip>/${INTERNAL_IP}/g" "${template}" sed -i "s/<internal_ip>/${INTERNAL_IP}/g" "${template}"

View file

@ -10,9 +10,6 @@ ROOT_FOLDER="${PWD}"
ENV_FILE="${ROOT_FOLDER}/.env" ENV_FILE="${ROOT_FOLDER}/.env"
STORAGE_PATH=$(grep -v '^#' "${ENV_FILE}" | xargs -n 1 | grep STORAGE_PATH | cut -d '=' -f2) 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 # Stop all installed apps if there are any
apps_folder="${ROOT_FOLDER}/apps" apps_folder="${ROOT_FOLDER}/apps"
if [ "$(find "${apps_folder}" -maxdepth 1 -type d | wc -l)" -gt 1 ]; then if [ "$(find "${apps_folder}" -maxdepth 1 -type d | wc -l)" -gt 1 ]; then
@ -30,6 +27,6 @@ else
fi fi
kill_watcher kill_watcher
echo "Stopping Docker services..." echo "Stopping tipi..."
echo echo
docker compose down --remove-orphans --rmi local docker compose down --remove-orphans --rmi local