New Script: rwMarkable (#8215)

* 'Add new script' * Update rwmarkable.sh --------- Co-authored-by: push-app-to-main[bot] <203845782+push-app-to-main[bot]@users.noreply.github.com> Co-authored-by: Slaviša Arežina <58952836+tremor021@users.noreply.github.com>
2025-10-09 09:41:14 +02:00 · 2025-10-09 09:41:14 +02:00 · ec1391c233
commit ec1391c233
parent 32230b4b0e
4 changed files with 182 additions and 0 deletions
--- a/ct/headers/rwmarkable
+++ b/ct/headers/rwmarkable
@ -0,0 +1,6 @@
+                  __  ___           __         __    __   
+   ______      __/  |/  /___ ______/ /______ _/ /_  / /__ 
+  / ___/ | /| / / /|_/ / __ `/ ___/ //_/ __ `/ __ \/ / _ \
+ / /   | |/ |/ / /  / / /_/ / /  / ,< / /_/ / /_/ / /  __/
+/_/    |__/|__/_/  /_/\__,_/_/  /_/|_|\__,_/_.___/_/\___/ 
+                                                          
--- a/ct/rwmarkable.sh
+++ b/ct/rwmarkable.sh
@ -0,0 +1,74 @@
+#!/usr/bin/env bash
+source <(curl -s https://raw.githubusercontent.com/community-scripts/ProxmoxVE/main/misc/build.func)
+# 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
+
+APP="rwMarkable"
+var_tags="${var_tags:-tasks;notes}"
+var_cpu="${var_cpu:-2}"
+var_ram="${var_ram:-2048}"
+var_disk="${var_disk:-6}"
+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_config.tar ./data ./config
+    msg_ok "Backed up configuration & data"
+
+    NODE_VERSION="22" NODE_MODULE="yarn" setup_nodejs
+    CLEAN_INSTALL=1 fetch_and_deploy_gh_release "rwMarkable" "fccview/rwMarkable" "tarball" "latest" "/opt/rwmarkable"
+
+    msg_info "Updating app"
+    cd /opt/rwmarkable
+    $STD yarn --frozen-lockfile
+    $STD yarn next telemetry disable
+    $STD yarn build
+    msg_ok "Updated app"
+
+    msg_info "Restoring configuration & data"
+    mv /opt/app.env /opt/rwmarkable/.env
+    $STD tar -xf /opt/data_config.tar
+    msg_ok "Restored configuration & data"
+
+    msg_info "Restarting ${APP} service"
+    systemctl start rwmarkable
+    msg_ok "Restarted ${APP} service"
+    rm /opt/data_config.tar
+    msg_ok "Updated Successfully"
+  fi
+  exit
+}
+
+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}"
--- a/frontend/public/json/rwmarkable.json
+++ 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": 6,
+        "os": "debian",
+        "version": "13"
+      }
+    }
+  ],
+  "default_credentials": {
+    "username": null,
+    "password": null
+  },
+  "notes": []
+}
+
--- a/install/rwmarkable-install.sh
+++ b/install/rwmarkable-install.sh
@ -0,0 +1,66 @@
+#!/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 "Installing ${APPLICATION}"
+cd /opt/rwmarkable
+$STD yarn --frozen-lockfile
+$STD yarn next telemetry disable
+$STD yarn build
+mkdir -p data/{users,checklists,notes}
+
+cat <<EOF >/opt/rwmarkable/.env
+NODE_ENV=production
+# HTTPS=true
+
+# --- SSO with OIDC (optional)
+# SSO_MODE=oidc
+# OIDC_ISSUER=<your-oidc-issuer-url>
+# OIDC_CLIENT_ID=<oidc-client-id>
+# APP_URL=<https://app.domain.tld>
+# 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 "Installed ${APPLICATION}"
+
+msg_info "Creating Service"
+cat <<EOF >/etc/systemd/system/rwmarkable.service
+[Unit]
+Description=rwMarkable server
+After=network.target
+
+[Service]
+WorkingDirectory=/opt/rwmarkable
+EnvironmentFile=/opt/rwmarkable/.env
+ExecStart=yarn start
+Restart=on-abnormal
+
+[Install]
+WantedBy=multi-user.target
+EOF
+systemctl enable -q --now rwmarkable
+msg_ok "Created Service"
+
+motd_ssh
+customize
+
+msg_info "Cleaning up"
+$STD apt -y autoremove
+$STD apt -y autoclean
+$STD apt -y clean
+msg_ok "Cleaned"