From e38aa65dadd95e38b74bb9a75c840f36b52b0064 Mon Sep 17 00:00:00 2001 From: Christian Winther Date: Wed, 6 Mar 2024 19:38:34 +0000 Subject: [PATCH 1/7] keep building for jippi-fork branch --- .github/workflows/docker.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/docker.yml b/.github/workflows/docker.yml index 8fdea53a1..0f62ad3bc 100644 --- a/.github/workflows/docker.yml +++ b/.github/workflows/docker.yml @@ -10,6 +10,7 @@ on: branches: - dev - staging + - jippi-fork tags: - "*" From 1892f68ebdfc0b75e033e507537abb9a4814527c Mon Sep 17 00:00:00 2001 From: Christian Winther Date: Sun, 10 Mar 2024 14:53:57 +0000 Subject: [PATCH 2/7] Add helper script to check minimum requirements --- docker/check-requirements | 112 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 112 insertions(+) create mode 100755 docker/check-requirements diff --git a/docker/check-requirements b/docker/check-requirements new file mode 100755 index 000000000..ad8d0ede4 --- /dev/null +++ b/docker/check-requirements @@ -0,0 +1,112 @@ +#!/bin/bash + +set -e -o errexit -o nounset -o pipefail + +# +# Colors +# + +declare -r RED="\e[31m" +declare -r GREEN="\e[32m" +declare -r YELLOW="\e[33m" +declare -r BLUE="\e[34m" +declare -r NO_COLOR="\e[0m" + +# +# Helper functions +# + +function highlight() { + local reset="${2:-$NO_COLOR}" + echo "${BLUE}$1${reset}" +} + +function action_start() { + echo -en "⚙️ $1: " +} + +function action_start_newline() { + action_start "$1" + echo +} + +function action_ok() { + echo -e "\n\t✅ ${GREEN}${*}${NO_COLOR}\n" +} + +function action_warn() { + echo -e "⚠️ ${YELLOW}${*}${NO_COLOR}" +} + +function action_error() { + echo -e "\n\t❌ ${RED}${*}${NO_COLOR}" >&2 +} + +function action_error_exit() { + action_error "${*}\n\n${RED}Aborting!${NO_COLOR}" + + exit 1 +} + +# +# Configuration +# + +declare -r min_docker_compose_version_arr=(2 17) +min_docker_compose_version=$( + IFS=. + echo "${min_docker_compose_version[*]}" +) + +# +# Help text +# + +DOCKER_HELP=" + +\tWe recommend installing Docker (and Compose) directly from Docker.com instead of your Operation System package registry. +\tPlease see $(highlight "https://docs.docker.com/engine/install/")${RED} for information on how to install Docker on your system. + +\tAlternatively, you can update *JUST* the Compose plugin by following the guide here: +\t$(highlight "https://docs.docker.com/compose/install/linux/#install-the-plugin-manually")${RED}. + +\tLearn more about Docker compose release history here: +\t$(highlight "https://docs.docker.com/compose/release-notes/")${RED}.${NO_COLOR}" +declare -r DOCKER_HELP + +# +# System checks +# + +echo -e "👋 ${GREEN}Hello!" +echo -e "" +echo -e "This script will check your system for the minimum requirements outlined in the Pixelfed Docker install guide" +echo -e "You can find the guide here ${BLUE}https://jippi.github.io/pixelfed-docs-next/pr-preview/pr-1/running-pixelfed/docker/prerequisites.html#software${GREEN}." +echo -e "${NO_COLOR}" + +action_start "Checking if [$(highlight "git")] command is available" +command -v git >/dev/null 2>&1 || { action_error_exit "I require the 'git' command, but it's not installed"; } +action_ok "git is installed" + +action_start "Checking if [$(highlight "docker")] command is available" +command -v docker >/dev/null 2>&1 || { action_error_exit "I require the 'docker' command, but it's not installed. ${DOCKER_HELP}"; } +action_ok "docker is installed" + +action_start "Checking if [$(highlight "docker compose")] command is available" +docker compose >/dev/null 2>&1 || { action_error_exit "I require the 'docker compose' command, but it's not installed. ${DOCKER_HELP}"; } +action_ok "docker compose is installed" + +compose_version=$(docker compose version --short) + +declare -a compose_version_arr +IFS="." read -r -a compose_version_arr <<<"$compose_version" + +action_start "Checking if [$(highlight "docker compose version")] major version (${min_docker_compose_version_arr[0]}) is acceptable" +[[ ${compose_version_arr[0]} -eq ${min_docker_compose_version_arr[0]} ]] || { action_error_exit "I require minimum Docker Compose major version ${min_docker_compose_version_arr[0]}.x.x - found ${compose_version}.${DOCKER_HELP}"; } +action_ok "You're using major version ${compose_version_arr[0]}" + +action_start "Checking if [$(highlight "docker compose version")] minor version (${min_docker_compose_version_arr[1]}) is acceptable" +[[ ${compose_version_arr[1]} -ge ${min_docker_compose_version_arr[1]} ]] || { action_error_exit "I require minimum Docker Compose minor version ${min_docker_compose_version_arr[0]}.${min_docker_compose_version_arr[1]} - found ${compose_version}.${DOCKER_HELP}"; } +action_ok "You're using minor version ${compose_version_arr[1]}" + +echo -e "🎉 ${GREEN}All checks passed, you should be ready to run Pixelfed on this server!${NO_COLOR}" From 56d47dd1bc7c6bb264e908a8b5fec5738ce68b2e Mon Sep 17 00:00:00 2001 From: Christian Winther Date: Sun, 10 Mar 2024 15:00:31 +0000 Subject: [PATCH 3/7] hide jippi-fork --- .github/workflows/docker.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/.github/workflows/docker.yml b/.github/workflows/docker.yml index 0f62ad3bc..8fdea53a1 100644 --- a/.github/workflows/docker.yml +++ b/.github/workflows/docker.yml @@ -10,7 +10,6 @@ on: branches: - dev - staging - - jippi-fork tags: - "*" From cc8c5ccd37c5ef0802846b348115e0df5c3ebd79 Mon Sep 17 00:00:00 2001 From: Christian Winther Date: Sun, 10 Mar 2024 15:11:54 +0000 Subject: [PATCH 4/7] docker: include convenience script reference --- docker/check-requirements | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/docker/check-requirements b/docker/check-requirements index ad8d0ede4..2a7c2a478 100755 --- a/docker/check-requirements +++ b/docker/check-requirements @@ -67,11 +67,18 @@ DOCKER_HELP=" \tWe recommend installing Docker (and Compose) directly from Docker.com instead of your Operation System package registry. \tPlease see $(highlight "https://docs.docker.com/engine/install/")${RED} for information on how to install Docker on your system. +\tA convinience script is provided by Docker to automate the installation that should work on all supported platforms: + +\t\t ${GREEN}\$${BLUE} curl -fsSL https://get.docker.com -o get-docker.sh +\t\t ${GREEN}\$${BLUE} sudo sh ./get-docker.sh +${RED} +\tPlease see $(highlight "https://docs.docker.com/engine/install/ubuntu/#install-using-the-convenience-script")${RED} for more information + \tAlternatively, you can update *JUST* the Compose plugin by following the guide here: -\t$(highlight "https://docs.docker.com/compose/install/linux/#install-the-plugin-manually")${RED}. +\t$(highlight "https://docs.docker.com/compose/install/linux/#install-the-plugin-manually")${RED} \tLearn more about Docker compose release history here: -\t$(highlight "https://docs.docker.com/compose/release-notes/")${RED}.${NO_COLOR}" +\t$(highlight "https://docs.docker.com/compose/release-notes/")${RED}${NO_COLOR}" declare -r DOCKER_HELP # From 4942f7fbd4c24ef96c13c22ab966ead8d7ae322d Mon Sep 17 00:00:00 2001 From: Christian Winther Date: Sun, 10 Mar 2024 15:13:45 +0000 Subject: [PATCH 5/7] docker: docs --- docker/check-requirements | 27 ++++++++++++++++++++++----- 1 file changed, 22 insertions(+), 5 deletions(-) diff --git a/docker/check-requirements b/docker/check-requirements index 2a7c2a478..6f283711f 100755 --- a/docker/check-requirements +++ b/docker/check-requirements @@ -91,29 +91,46 @@ echo -e "This script will check your system for the minimum requirements outline echo -e "You can find the guide here ${BLUE}https://jippi.github.io/pixelfed-docs-next/pr-preview/pr-1/running-pixelfed/docker/prerequisites.html#software${GREEN}." echo -e "${NO_COLOR}" +# git installed? action_start "Checking if [$(highlight "git")] command is available" -command -v git >/dev/null 2>&1 || { action_error_exit "I require the 'git' command, but it's not installed"; } +command -v git >/dev/null 2>&1 || { + action_error_exit "I require the 'git' command, but it's not installed" +} action_ok "git is installed" +# docker installed? action_start "Checking if [$(highlight "docker")] command is available" -command -v docker >/dev/null 2>&1 || { action_error_exit "I require the 'docker' command, but it's not installed. ${DOCKER_HELP}"; } +command -v docker >/dev/null 2>&1 || { + action_error_exit "I require the 'docker' command, but it's not installed. ${DOCKER_HELP}" +} action_ok "docker is installed" +# docker compose installed? action_start "Checking if [$(highlight "docker compose")] command is available" -docker compose >/dev/null 2>&1 || { action_error_exit "I require the 'docker compose' command, but it's not installed. ${DOCKER_HELP}"; } +docker compose >/dev/null 2>&1 || { + action_error_exit "I require the 'docker compose' command, but it's not installed. ${DOCKER_HELP}" +} action_ok "docker compose is installed" +# docker compose version is acceptable? compose_version=$(docker compose version --short) declare -a compose_version_arr IFS="." read -r -a compose_version_arr <<<"$compose_version" +## major version action_start "Checking if [$(highlight "docker compose version")] major version (${min_docker_compose_version_arr[0]}) is acceptable" -[[ ${compose_version_arr[0]} -eq ${min_docker_compose_version_arr[0]} ]] || { action_error_exit "I require minimum Docker Compose major version ${min_docker_compose_version_arr[0]}.x.x - found ${compose_version}.${DOCKER_HELP}"; } +[[ ${compose_version_arr[0]} -eq ${min_docker_compose_version_arr[0]} ]] || { + action_error_exit "I require minimum Docker Compose major version ${min_docker_compose_version_arr[0]}.x.x - found ${compose_version}.${DOCKER_HELP}" +} action_ok "You're using major version ${compose_version_arr[0]}" +## minor version action_start "Checking if [$(highlight "docker compose version")] minor version (${min_docker_compose_version_arr[1]}) is acceptable" -[[ ${compose_version_arr[1]} -ge ${min_docker_compose_version_arr[1]} ]] || { action_error_exit "I require minimum Docker Compose minor version ${min_docker_compose_version_arr[0]}.${min_docker_compose_version_arr[1]} - found ${compose_version}.${DOCKER_HELP}"; } +[[ ${compose_version_arr[1]} -ge ${min_docker_compose_version_arr[1]} ]] || { + action_error_exit "I require minimum Docker Compose minor version ${min_docker_compose_version_arr[0]}.${min_docker_compose_version_arr[1]} - found ${compose_version}.${DOCKER_HELP}" +} action_ok "You're using minor version ${compose_version_arr[1]}" +# Yay, everything is fine echo -e "🎉 ${GREEN}All checks passed, you should be ready to run Pixelfed on this server!${NO_COLOR}" From 3a1f4789e6e40d93ff8dd9af8b7e8b98c1b87e96 Mon Sep 17 00:00:00 2001 From: Christian Winther Date: Sun, 10 Mar 2024 15:15:08 +0000 Subject: [PATCH 6/7] docker: I => Pixelfed --- docker/check-requirements | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docker/check-requirements b/docker/check-requirements index 6f283711f..250a25c59 100755 --- a/docker/check-requirements +++ b/docker/check-requirements @@ -94,21 +94,21 @@ echo -e "${NO_COLOR}" # git installed? action_start "Checking if [$(highlight "git")] command is available" command -v git >/dev/null 2>&1 || { - action_error_exit "I require the 'git' command, but it's not installed" + action_error_exit "Pixelfed require the 'git' command, but it's not installed" } action_ok "git is installed" # docker installed? action_start "Checking if [$(highlight "docker")] command is available" command -v docker >/dev/null 2>&1 || { - action_error_exit "I require the 'docker' command, but it's not installed. ${DOCKER_HELP}" + action_error_exit "Pixelfed require the 'docker' command, but it's not installed. ${DOCKER_HELP}" } action_ok "docker is installed" # docker compose installed? action_start "Checking if [$(highlight "docker compose")] command is available" docker compose >/dev/null 2>&1 || { - action_error_exit "I require the 'docker compose' command, but it's not installed. ${DOCKER_HELP}" + action_error_exit "Pixelfed require the 'docker compose' command, but it's not installed. ${DOCKER_HELP}" } action_ok "docker compose is installed" @@ -121,14 +121,14 @@ IFS="." read -r -a compose_version_arr <<<"$compose_version" ## major version action_start "Checking if [$(highlight "docker compose version")] major version (${min_docker_compose_version_arr[0]}) is acceptable" [[ ${compose_version_arr[0]} -eq ${min_docker_compose_version_arr[0]} ]] || { - action_error_exit "I require minimum Docker Compose major version ${min_docker_compose_version_arr[0]}.x.x - found ${compose_version}.${DOCKER_HELP}" + action_error_exit "Pixelfed require minimum Docker Compose major version ${min_docker_compose_version_arr[0]}.x.x - found ${compose_version}.${DOCKER_HELP}" } action_ok "You're using major version ${compose_version_arr[0]}" ## minor version action_start "Checking if [$(highlight "docker compose version")] minor version (${min_docker_compose_version_arr[1]}) is acceptable" [[ ${compose_version_arr[1]} -ge ${min_docker_compose_version_arr[1]} ]] || { - action_error_exit "I require minimum Docker Compose minor version ${min_docker_compose_version_arr[0]}.${min_docker_compose_version_arr[1]} - found ${compose_version}.${DOCKER_HELP}" + action_error_exit "Pixelfed require minimum Docker Compose minor version ${min_docker_compose_version_arr[0]}.${min_docker_compose_version_arr[1]} - found ${compose_version}.${DOCKER_HELP}" } action_ok "You're using minor version ${compose_version_arr[1]}" From ad382f8f5596f1a1e50cb1acf99b457db13e67f9 Mon Sep 17 00:00:00 2001 From: Christian Winther Date: Sun, 10 Mar 2024 15:16:25 +0000 Subject: [PATCH 7/7] docker: cleanup script --- docker/check-requirements | 10 ---------- 1 file changed, 10 deletions(-) diff --git a/docker/check-requirements b/docker/check-requirements index 250a25c59..4da1d6427 100755 --- a/docker/check-requirements +++ b/docker/check-requirements @@ -8,7 +8,6 @@ set -e -o errexit -o nounset -o pipefail declare -r RED="\e[31m" declare -r GREEN="\e[32m" -declare -r YELLOW="\e[33m" declare -r BLUE="\e[34m" declare -r NO_COLOR="\e[0m" @@ -25,19 +24,10 @@ function action_start() { echo -en "⚙️ $1: " } -function action_start_newline() { - action_start "$1" - echo -} - function action_ok() { echo -e "\n\t✅ ${GREEN}${*}${NO_COLOR}\n" } -function action_warn() { - echo -e "⚠️ ${YELLOW}${*}${NO_COLOR}" -} - function action_error() { echo -e "\n\t❌ ${RED}${*}${NO_COLOR}" >&2 }