From 62139d987d7de93110bdec4f9f7c85695c24c52b Mon Sep 17 00:00:00 2001 From: Dominik Siebel Date: Tue, 3 Dec 2024 16:16:29 +0100 Subject: [PATCH 1/6] new script: silverbullet --- ct/silverbullet.sh | 99 +++++++++++++++++++++++++++++++++ install/silverbullet-install.sh | 69 +++++++++++++++++++++++ json/silverbullet.json | 34 +++++++++++ 3 files changed, 202 insertions(+) create mode 100644 ct/silverbullet.sh create mode 100644 install/silverbullet-install.sh create mode 100644 json/silverbullet.json diff --git a/ct/silverbullet.sh b/ct/silverbullet.sh new file mode 100644 index 00000000..2ea90f6a --- /dev/null +++ b/ct/silverbullet.sh @@ -0,0 +1,99 @@ +#!/usr/bin/env bash +source <(curl -s https://raw.githubusercontent.com/community-scripts/ProxmoxVE/main/misc/build.func) +# Copyright (c) 2021-2024 tteck +# Author: tteck (tteckster) +# License: MIT +# https://github.com/community-scripts/ProxmoxVE/raw/main/LICENSE + +function header_info { +clear +cat <<"EOF" + _ __ __ ____ __ + _____(_) / _____ _____/ /_ __ __/ / /__ / /_ + / ___/ / / | / / _ \/ ___/ __ \/ / / / / / _ \/ __/ + (__ ) / /| |/ / __/ / / /_/ / /_/ / / / __/ /_ +/____/_/_/ |___/\___/_/ /_.___/\__,_/_/_/\___/\__/ + +EOF +} +header_info +echo -e "Loading..." +APP="Silverbullet" +var_disk="2" +var_cpu="1" +var_ram="512" +var_os="debian" +var_version="12" +variables +color +catch_errors + +function default_settings() { + CT_TYPE="1" + PW="" + CT_ID=$NEXTID + HN=$NSAPP + DISK_SIZE="$var_disk" + CORE_COUNT="$var_cpu" + RAM_SIZE="$var_ram" + BRG="vmbr0" + NET="dhcp" + GATE="" + APT_CACHER="" + APT_CACHER_IP="" + DISABLEIP6="no" + MTU="" + SD="" + NS="" + MAC="" + VLAN="" + SSH="no" + VERB="no" + echo_default +} + +function update_script() { + header_info + check_container_storage + check_container_resources + + service_path="/etc/systemd/system/silverbullet.service" + if [[ ! -d /opt/silverbullet || ! -f "${service_path}" ]]; then msg_error "No ${APP} Installation Found!"; exit; fi + + RELEASE=$(curl -s https://api.github.com/repos/silverbulletmd/silverbullet/releases/latest | grep "tag_name" | awk '{print substr($2, 2, length($2)-3) }') + if [[ ! -f "/opt/silverbullet/${APP}_version.txt" || "${RELEASE}" != "$(cat /opt/silverbullet/${APP}_version.txt)" ]]; then + msg_info "Stopping ${APP}" + systemctl stop silverbullet.service + msg_ok "Stopped ${APP}" + + msg_info "Updating ${APP} to ${RELEASE}" + wget -q https://github.com/silverbulletmd/silverbullet/releases/download/${RELEASE}/silverbullet-server-linux-x86_64.zip + unzip silverbullet-server-linux-x86_64.zip &>/dev/null + mv silverbullet /opt/silverbullet/bin/ + chmod +x /opt/silverbullet/bin/silverbullet + ln -sf /opt/silverbullet/bin/silverbullet /usr/local/bin/silverbullet + echo "${RELEASE}" >/opt/silverbullet/${APP}_version.txt + msg_ok "Updated ${APP}" + + msg_info "Starting ${APP}" + systemctl start silverbullet.service + sleep 1 + if systemctl status silverbullet.service &>/dev/null ; then + msg_ok "Started ${APP}" + msg_ok "Updated Successfully" + else + msg_error "Failed to start ${APP}" + fi + else + msg_ok "No update required. ${APP} is already at ${RELEASE}" + fi + exit +} + +start +build_container +description + +msg_ok "Completed Successfully!\n" +echo -e "${APP} should be reachable by going to the following URL. + ${BL}http://${IP}:3000${CL} \n" diff --git a/install/silverbullet-install.sh b/install/silverbullet-install.sh new file mode 100644 index 00000000..a7a28374 --- /dev/null +++ b/install/silverbullet-install.sh @@ -0,0 +1,69 @@ +#!/usr/bin/env bash + +# Copyright (c) 2021-2024 tteck +# Author: tteck (tteckster) +# License: MIT +# https://github.com/community-scripts/ProxmoxVE/raw/main/LICENSE + +source /dev/stdin <<< "$FUNCTIONS_FILE_PATH" +color +verb_ip6 +catch_errors +setting_up_container +network_check +update_os + +msg_info "Installing Dependencies" +$STD apt-get install -y curl +$STD apt-get install -y sudo +$STD apt-get install -y mc +msg_ok "Installed Dependencies" + +RELEASE=$(curl -s https://api.github.com/repos/silverbulletmd/silverbullet/releases/latest | grep "tag_name" | awk '{print substr($2, 2, length($2)-3) }') + +msg_info "Installing ${APPLICATION}" +mkdir -p /opt/silverbullet/bin /opt/silverbullet/space +wget -q https://github.com/silverbulletmd/silverbullet/releases/download/${RELEASE}/silverbullet-server-linux-x86_64.zip +unzip silverbullet-server-linux-x86_64.zip &>/dev/null +mv silverbullet /opt/silverbullet/bin/ +chmod +x /opt/silverbullet/bin/silverbullet +ln -s /opt/silverbullet/bin/silverbullet /usr/local/bin/silverbullet +echo "${RELEASE}" >/opt/silverbullet/${APPLICATION}_version.txt +msg_ok "Installed ${APPLICATION}" + +msg_info "Creating Service" +service_path="/etc/systemd/system/silverbullet.service" + +echo "[Unit] +Description=Silverbullet Daemon +After=syslog.target network.target + +[Service] +User=root +Type=simple +ExecStart=/opt/silverbullet/bin/silverbullet --hostname 0.0.0.0 --port 3000 /opt/silverbullet/space +WorkingDirectory=/opt/silverbullet +Restart=on-failure + +[Install] +WantedBy=multi-user.target" >$service_path +systemctl enable --now -q silverbullet +msg_ok "Created Service" + +msg_info "Starting ${APPLICATION}" +systemctl start silverbullet.service +sleep 1 +if systemctl status silverbullet.service &>/dev/null ; then + msg_ok "Started ${APPLICATION}" +else + msg_error "Failed to start ${APPLICATION}" +fi + +motd_ssh +customize + +msg_info "Cleaning up" +$STD apt-get -y autoremove +$STD apt-get -y autoclean +rm silverbullet-server-linux-x86_64.zip +msg_ok "Cleaned" diff --git a/json/silverbullet.json b/json/silverbullet.json new file mode 100644 index 00000000..9acd9421 --- /dev/null +++ b/json/silverbullet.json @@ -0,0 +1,34 @@ +{ + "name": "Silverbullet", + "slug": "silverbullet", + "categories": [ + 14 + ], + "date_created": "2024-12-03", + "type": "ct", + "updateable": true, + "privileged": false, + "interface_port": 3000, + "documentation": null, + "website": "https://silverbullet.md", + "logo": "https://silverbullet.md/.client/logo.png", + "description": "SilverBullet is a note-taking application optimized for people with a hacker mindset.", + "install_methods": [ + { + "type": "default", + "script": "ct/silverbullet.sh", + "resources": { + "cpu": 1, + "ram": 512, + "hdd": 2, + "os": "debian", + "version": "12" + } + } + ], + "default_credentials": { + "username": null, + "password": null + }, + "notes": [] +} From d717694746d1c8457613c0f5656b4279a1edb6bb Mon Sep 17 00:00:00 2001 From: Dominik Siebel Date: Tue, 3 Dec 2024 16:45:38 +0100 Subject: [PATCH 2/6] update copyright and author information --- ct/silverbullet.sh | 4 ++-- install/silverbullet-install.sh | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/ct/silverbullet.sh b/ct/silverbullet.sh index 2ea90f6a..95f19bee 100644 --- a/ct/silverbullet.sh +++ b/ct/silverbullet.sh @@ -1,7 +1,7 @@ #!/usr/bin/env bash source <(curl -s https://raw.githubusercontent.com/community-scripts/ProxmoxVE/main/misc/build.func) -# Copyright (c) 2021-2024 tteck -# Author: tteck (tteckster) +# Copyright (c) 2021-2024 community-scripts ORG +# Author: Dominik Siebel (dsiebel) # License: MIT # https://github.com/community-scripts/ProxmoxVE/raw/main/LICENSE diff --git a/install/silverbullet-install.sh b/install/silverbullet-install.sh index a7a28374..d621a1ae 100644 --- a/install/silverbullet-install.sh +++ b/install/silverbullet-install.sh @@ -1,7 +1,7 @@ #!/usr/bin/env bash -# Copyright (c) 2021-2024 tteck -# Author: tteck (tteckster) +# Copyright (c) 2021-2024 community-scripts ORG +# Author: Dominik Siebel (dsiebel) # License: MIT # https://github.com/community-scripts/ProxmoxVE/raw/main/LICENSE From 05407606b7814d7ddb540125f7a27f98c7cc46ed Mon Sep 17 00:00:00 2001 From: Dominik Siebel Date: Tue, 3 Dec 2024 22:13:51 +0100 Subject: [PATCH 3/6] address code review comments and suggestions --- ct/silverbullet.sh | 18 +++++++----------- install/silverbullet-install.sh | 29 ++++++++++------------------- 2 files changed, 17 insertions(+), 30 deletions(-) diff --git a/ct/silverbullet.sh b/ct/silverbullet.sh index 95f19bee..3e294b38 100644 --- a/ct/silverbullet.sh +++ b/ct/silverbullet.sh @@ -56,31 +56,27 @@ function update_script() { header_info check_container_storage check_container_resources - - service_path="/etc/systemd/system/silverbullet.service" - if [[ ! -d /opt/silverbullet || ! -f "${service_path}" ]]; then msg_error "No ${APP} Installation Found!"; exit; fi - + if [[ ! -d /opt/silverbullet ]]; then msg_error "No ${APP} Installation Found!"; exit; fi RELEASE=$(curl -s https://api.github.com/repos/silverbulletmd/silverbullet/releases/latest | grep "tag_name" | awk '{print substr($2, 2, length($2)-3) }') - if [[ ! -f "/opt/silverbullet/${APP}_version.txt" || "${RELEASE}" != "$(cat /opt/silverbullet/${APP}_version.txt)" ]]; then + if [[ ! -f "/opt/${APP}_version.txt" || "${RELEASE}" != "$(cat /opt/${APP}_version.txt)" ]]; then msg_info "Stopping ${APP}" - systemctl stop silverbullet.service + systemctl stop silverbullet msg_ok "Stopped ${APP}" - msg_info "Updating ${APP} to ${RELEASE}" + msg_info "Updating ${APP} to v${RELEASE}" wget -q https://github.com/silverbulletmd/silverbullet/releases/download/${RELEASE}/silverbullet-server-linux-x86_64.zip unzip silverbullet-server-linux-x86_64.zip &>/dev/null mv silverbullet /opt/silverbullet/bin/ chmod +x /opt/silverbullet/bin/silverbullet - ln -sf /opt/silverbullet/bin/silverbullet /usr/local/bin/silverbullet echo "${RELEASE}" >/opt/silverbullet/${APP}_version.txt msg_ok "Updated ${APP}" msg_info "Starting ${APP}" - systemctl start silverbullet.service + systemctl start silverbullet sleep 1 - if systemctl status silverbullet.service &>/dev/null ; then + if systemctl status silverbullet &>/dev/null ; then msg_ok "Started ${APP}" - msg_ok "Updated Successfully" + msg_ok "Updated ${APP} to v${RELEASE}" else msg_error "Failed to start ${APP}" fi diff --git a/install/silverbullet-install.sh b/install/silverbullet-install.sh index d621a1ae..153a6d1a 100644 --- a/install/silverbullet-install.sh +++ b/install/silverbullet-install.sh @@ -14,9 +14,10 @@ network_check update_os msg_info "Installing Dependencies" -$STD apt-get install -y curl -$STD apt-get install -y sudo -$STD apt-get install -y mc +$STD apt-get install -y \ + curl \ + sudo \ + mc msg_ok "Installed Dependencies" RELEASE=$(curl -s https://api.github.com/repos/silverbulletmd/silverbullet/releases/latest | grep "tag_name" | awk '{print substr($2, 2, length($2)-3) }') @@ -24,17 +25,15 @@ RELEASE=$(curl -s https://api.github.com/repos/silverbulletmd/silverbullet/relea msg_info "Installing ${APPLICATION}" mkdir -p /opt/silverbullet/bin /opt/silverbullet/space wget -q https://github.com/silverbulletmd/silverbullet/releases/download/${RELEASE}/silverbullet-server-linux-x86_64.zip -unzip silverbullet-server-linux-x86_64.zip &>/dev/null -mv silverbullet /opt/silverbullet/bin/ +unzip -q -d /opt/silverbullet/bin/ silverbullet-server-linux-x86_64.zip chmod +x /opt/silverbullet/bin/silverbullet -ln -s /opt/silverbullet/bin/silverbullet /usr/local/bin/silverbullet -echo "${RELEASE}" >/opt/silverbullet/${APPLICATION}_version.txt +echo "${RELEASE}" >/opt/${APPLICATION}_version.txt msg_ok "Installed ${APPLICATION}" msg_info "Creating Service" -service_path="/etc/systemd/system/silverbullet.service" -echo "[Unit] +cat </etc/systemd/system/silverbullet.service +[Unit] Description=Silverbullet Daemon After=syslog.target network.target @@ -46,19 +45,11 @@ WorkingDirectory=/opt/silverbullet Restart=on-failure [Install] -WantedBy=multi-user.target" >$service_path +WantedBy=multi-user.target +EOF systemctl enable --now -q silverbullet msg_ok "Created Service" -msg_info "Starting ${APPLICATION}" -systemctl start silverbullet.service -sleep 1 -if systemctl status silverbullet.service &>/dev/null ; then - msg_ok "Started ${APPLICATION}" -else - msg_error "Failed to start ${APPLICATION}" -fi - motd_ssh customize From 575c24625ab9614f58e4f06d2564088b4ff41e53 Mon Sep 17 00:00:00 2001 From: Dominik Siebel Date: Tue, 3 Dec 2024 22:27:54 +0100 Subject: [PATCH 4/6] fix: overwrite existing binary on unzip --- install/silverbullet-install.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/install/silverbullet-install.sh b/install/silverbullet-install.sh index 153a6d1a..a22c7414 100644 --- a/install/silverbullet-install.sh +++ b/install/silverbullet-install.sh @@ -25,7 +25,7 @@ RELEASE=$(curl -s https://api.github.com/repos/silverbulletmd/silverbullet/relea msg_info "Installing ${APPLICATION}" mkdir -p /opt/silverbullet/bin /opt/silverbullet/space wget -q https://github.com/silverbulletmd/silverbullet/releases/download/${RELEASE}/silverbullet-server-linux-x86_64.zip -unzip -q -d /opt/silverbullet/bin/ silverbullet-server-linux-x86_64.zip +unzip -oq -d /opt/silverbullet/bin/ silverbullet-server-linux-x86_64.zip chmod +x /opt/silverbullet/bin/silverbullet echo "${RELEASE}" >/opt/${APPLICATION}_version.txt msg_ok "Installed ${APPLICATION}" From dd04e15e6056bb25399257ad34122f863afa154e Mon Sep 17 00:00:00 2001 From: Dominik Siebel Date: Tue, 3 Dec 2024 22:28:04 +0100 Subject: [PATCH 5/6] address remaining review comments --- ct/silverbullet.sh | 10 ++-------- 1 file changed, 2 insertions(+), 8 deletions(-) diff --git a/ct/silverbullet.sh b/ct/silverbullet.sh index 3e294b38..6eaa0157 100644 --- a/ct/silverbullet.sh +++ b/ct/silverbullet.sh @@ -69,17 +69,11 @@ function update_script() { mv silverbullet /opt/silverbullet/bin/ chmod +x /opt/silverbullet/bin/silverbullet echo "${RELEASE}" >/opt/silverbullet/${APP}_version.txt - msg_ok "Updated ${APP}" + msg_ok "Updated ${APP} to v${RELEASE}" msg_info "Starting ${APP}" systemctl start silverbullet - sleep 1 - if systemctl status silverbullet &>/dev/null ; then - msg_ok "Started ${APP}" - msg_ok "Updated ${APP} to v${RELEASE}" - else - msg_error "Failed to start ${APP}" - fi + msg_ok "Started ${APP}" else msg_ok "No update required. ${APP} is already at ${RELEASE}" fi From 68164f859a7fbee47077094fd94356e6c8703b12 Mon Sep 17 00:00:00 2001 From: Dominik Siebel Date: Tue, 3 Dec 2024 22:32:28 +0100 Subject: [PATCH 6/6] add documenation link --- json/silverbullet.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/json/silverbullet.json b/json/silverbullet.json index 9acd9421..fd82f036 100644 --- a/json/silverbullet.json +++ b/json/silverbullet.json @@ -9,7 +9,7 @@ "updateable": true, "privileged": false, "interface_port": 3000, - "documentation": null, + "documentation": "https://silverbullet.md/Manual", "website": "https://silverbullet.md", "logo": "https://silverbullet.md/.client/logo.png", "description": "SilverBullet is a note-taking application optimized for people with a hacker mindset.",