From 823bbca9afed7714271defabfc286e4fbe304342 Mon Sep 17 00:00:00 2001 From: vhsdream Date: Tue, 30 Sep 2025 13:35:58 -0400 Subject: [PATCH] Add rwMarkable --- ct/rwmarkable.sh | 75 ++++++++++++++++++++++++++++ frontend/public/json/rwmarkable.json | 36 +++++++++++++ install/rwmarkable-install.sh | 67 +++++++++++++++++++++++++ 3 files changed, 178 insertions(+) create mode 100644 ct/rwmarkable.sh create mode 100644 frontend/public/json/rwmarkable.json create mode 100644 install/rwmarkable-install.sh diff --git a/ct/rwmarkable.sh b/ct/rwmarkable.sh new file mode 100644 index 00000000..c7579db9 --- /dev/null +++ b/ct/rwmarkable.sh @@ -0,0 +1,75 @@ +#!/usr/bin/env bash +source <(curl -s https://raw.githubusercontent.com/community-scripts/ProxmoxVED/main/misc/build.func) +# Copyright (c) 2021-2025 community-scripts ORG +# Author: vhsdream +# License: MIT | https://github.com/community-scripts/ProxmoxVED/raw/main/LICENSE +# Source: https://github.com/fccview/rwMarkable + +APP="rwMarkable" +var_tags="${var_tags:-tasks;notes}" +var_cpu="${var_cpu:-2}" +var_ram="${var_ram:-2048}" +var_disk="${var_disk:-4}" +var_os="${var_os:-debian}" +var_version="${var_version:-13}" +var_unprivileged="${var_unprivileged:-1}" + +header_info "$APP" +variables +color +catch_errors + +function update_script() { + header_info + check_container_storage + check_container_resources + + if [[ ! -d /opt/rwmarkable ]]; then + msg_error "No ${APP} Installation Found!" + exit + fi + + if check_for_gh_release "rwMarkable" "fccview/rwMarkable"; then + msg_info "Stopping ${APP}" + systemctl stop rwmarkable + msg_ok "Stopped ${APP}" + + msg_info "Backing up configuration & data" + cd /opt/rwmarkable + cp ./.env /opt/app.env + $STD tar -cf /opt/data.tar ./data + msg_ok "Backed up configuration & data" + + NODE_VERSION="22" NODE_MODULE="yarn" setup_nodejs + cd /opt + export CLEAN_INSTALL=1 + fetch_and_deploy_gh_release "rwMarkable" "fccview/rwMarkable" "tarball" "latest" "/opt/rwmarkable" + + msg_info "Updating app" + export NEXT_TELEMETRY_DISABLE=1 + export NODE_ENV=production + cd /opt/rwmarkable + $STD yarn --frozen-lockfile + $STD yarn build + msg_ok "Updated app" + + msg_info "Restoring configuration & data" + mv /opt/app.env /opt/rwmarkable/.env + $STD tar xf /opt/data.tar + msg_ok "Restored configuration & data" + + msg_info "Restarting ${APP} service" + systemctl start rwmarkable + msg_ok "Restarted ${APP} service" + fi + +} + +start +build_container +description + +msg_ok "Completed Successfully!\n" +echo -e "${CREATING}${GN}${APP} setup has been successfully initialized!${CL}" +echo -e "${INFO}${YW} Access it using the following URL:${CL}" +echo -e "${TAB}${GATEWAY}${BGN}http://${IP}:3000${CL}" diff --git a/frontend/public/json/rwmarkable.json b/frontend/public/json/rwmarkable.json new file mode 100644 index 00000000..8eaed9ac --- /dev/null +++ b/frontend/public/json/rwmarkable.json @@ -0,0 +1,36 @@ +{ + "name": "rwMarkable", + "slug": "rwmarkable", + "categories": [ + 12 + ], + "date_created": "2024-10-02", + "type": "ct", + "updateable": true, + "privileged": false, + "interface_port": 3000, + "documentation": "https://github.com/fccview/rwMarkable/blob/main/README.md", + "website": "https://github.com/fccview/rwMarkable", + "logo": "https://cdn.jsdelivr.net/gh/selfhst/icons/webp/rwmarkable.webp", + "config_path": "/opt/rwmarkable/.env", + "description": "A simple, self-hosted app for your checklists and notes. Tired of bloated, cloud-based to-do apps? rwMarkable is a lightweight alternative for managing your personal checklists and notes. It's built with Next.js 14, is easy to deploy, and keeps all your data on your own server.", + "install_methods": [ + { + "type": "default", + "script": "ct/rwmarkable.sh", + "resources": { + "cpu": 2, + "ram": 2048, + "hdd": 4, + "os": "debian", + "version": "13" + } + } + ], + "default_credentials": { + "username": null, + "password": null + }, + "notes": [] +} + diff --git a/install/rwmarkable-install.sh b/install/rwmarkable-install.sh new file mode 100644 index 00000000..e74c21eb --- /dev/null +++ b/install/rwmarkable-install.sh @@ -0,0 +1,67 @@ +#!/usr/bin/env bash + +# Copyright (c) 2021-2025 community-scripts ORG +# Author: vhsdream +# License: MIT | https://github.com/community-scripts/ProxmoxVE/raw/main/LICENSE +# Source: https://github.com/fccview/rwMarkable + +source /dev/stdin <<<"$FUNCTIONS_FILE_PATH" +color +verb_ip6 +catch_errors +setting_up_container +network_check +update_os + +NODE_VERSION="22" NODE_MODULE="yarn" setup_nodejs +fetch_and_deploy_gh_release "rwMarkable" "fccview/rwMarkable" "tarball" "latest" "/opt/rwmarkable" + +msg_info "Building app" +cd /opt/rwmarkable +export NEXT_TELEMETRY_DISABLE=1 +export NODE_ENV=production +$STD yarn --frozen-lockfile +$STD yarn build +# maybe move some stuff around so the app is in a sensible spot? +msg_ok "Successfully built app" + +msg_info "Creating .env file" +cat </opt/rwmarkable/.env +NODE_ENV=production +# HTTPS=true + +# --- SSO with OIDC (optional) +# SSO_MODE=oidc +# OIDC_ISSUER= +# OIDC_CLIENT_ID= +# APP_URL= +# SSO_FALLBACK_LOCAL=true # Allow both SSO and normal login +# OIDC_CLIENT_SECRET=your_client_secret # Enable confidential client mode with client authentication +# OIDC_ADMIN_GROUPS=admins # Map provider groups to admin role +EOF +msg_ok "Created .env file" + +msg_info "Creating rwMarkable Service" +cat </etc/systemd/system/rwmarkable.service +[Unit] +Description=rwMarkable server +After=network.target + +[Service] +WorkingDirectory=/opt/rwmarkable +EnvironmentFile=/opt/rwmarkable/.env +ExecStart=yarn start +Restart=unless-stopped + +[Install] +WantedBy=multi-user.target +EOF +systemctl enable -q --now rwmarkable +msg_ok "Created rwMarkable Service" +motd_ssh +customize + +msg_info "Cleaning up" +$STD apt-get -y autoremove +$STD apt-get -y autoclean +msg_ok "Cleaned"