Testing WikiJS

2025-03-18 13:21:01 +01:00 · 2025-03-18 13:21:01 +01:00 · 2641f64f65
commit 2641f64f65
parent f63e5f69e4
3 changed files with 211 additions and 0 deletions
--- a/ct/wikijs.sh
+++ b/ct/wikijs.sh
@ -0,0 +1,77 @@
+#!/usr/bin/env bash
+source <(curl -s https://raw.githubusercontent.com/community-scripts/ProxmoxVE/main/misc/build.func)
+# Copyright (c) 2021-2025 tteck
+# Author: tteck (tteckster)
+# License: MIT | https://github.com/community-scripts/ProxmoxVE/raw/main/LICENSE
+# Source: https://js.wiki/
+
+APP="Wikijs"
+var_tags="wiki"
+var_cpu="2"
+var_ram="2048"
+var_disk="10"
+var_os="debian"
+var_version="12"
+var_unprivileged="1"
+
+header_info "$APP"
+variables
+color
+catch_errors
+
+function update_script() {
+    header_info
+    check_container_storage
+    check_container_resources
+    if [[ ! -d /opt/wikijs ]]; then
+        msg_error "No ${APP} Installation Found!"
+        exit
+    fi
+    RELEASE=$(curl -s https://api.github.com/repos/Requarks/wiki/releases/latest | grep "tag_name" | awk '{print substr($2, 3, length($2)-4) }')
+    if [[ "${RELEASE}" != "$(cat /opt/${APP}_version.txt)" ]] || [[ ! -f /opt/${APP}_version.txt ]]; then
+        msg_info "Verifying whether ${APP}' new release is v3.x+ and current install uses SQLite."
+        SQLITE_INSTALL=$([ -f /opt/wikijs/db.sqlite ] && echo "true" || echo "false")
+        if [[ "${SQLITE_INSTALL}" == "true" && "${RELEASE}" =~ ^3.* ]]; then
+            echo "SQLite is not supported in v3.x+, currently there is no update path availble."
+            exit
+        fi
+        msg_ok "There is an update path available for ${APP} to v${RELEASE}"
+
+        msg_info "Stopping ${APP}"
+        systemctl stop wikijs
+        msg_ok "Stopped ${APP}"
+
+        msg_info "Updating ${APP}"
+        mkdir /opt/wikijs-backup
+        $SQLITE_INSTALL && cp /opt/wikijs/db.sqlite /opt/wikijs-backup
+        cp -R /opt/wikijs/{config.yml,/data} /opt/wikijs-backup
+        rm -rf /opt/wikijs/*
+        cd /opt/wikijs
+        wget -q "https://github.com/requarks/wiki/releases/download/v${RELEASE}/wiki-js.tar.gz"
+        tar -xzf wiki-js.tar.gz
+        cp -R /opt/wikijs-backup/* /opt/wikijs
+        msg_ok "Updated ${APP}"
+
+        msg_info "Starting ${APP}"
+        systemctl start wikijs
+        msg_ok "Started ${APP}"
+
+        msg_info "Cleaning Up"
+        rm -rf /opt/wikijs/wiki-js.tar.gz
+        rm -rf /opt/wikijs-backup
+        msg_ok "Cleanup Completed"
+        msg_ok "Updated Successfully"
+    else
+        msg_ok "No update required. ${APP} is already at v${RELEASE}"
+    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/wikijs.json
+++ b/frontend/public/json/wikijs.json
@ -0,0 +1,34 @@
+{
+    "name": "Wiki.js",
+    "slug": "wikijs",
+    "categories": [
+        12
+    ],
+    "date_created": "2024-05-02",
+    "type": "ct",
+    "updateable": true,
+    "privileged": false,
+    "interface_port": 3000,
+    "documentation": null,
+    "website": "https://js.wiki/",
+    "logo": "https://static.requarks.io/logo/wikijs-butterfly.svg",
+    "description": "Wiki.js is a free, open-source, and modern wiki application built using Node.js. It is designed to be fast, easy to use, and flexible, with a range of features for collaboration, knowledge management, and content creation. Wiki.js supports Markdown syntax for editing pages, and includes features such as version control, page history, and access control, making it easy to manage content and collaborate with others. The software is fully customizable, with a range of themes and extensions available, and can be deployed on a local server or in the cloud, making it an ideal choice for small teams and organizations looking to create and manage a wiki. Wiki.js provides a modern, user-friendly interface, and supports a range of data sources, including local file systems, databases, and cloud storage services.",
+    "install_methods": [
+        {
+            "type": "default",
+            "script": "ct/wikijs.sh",
+            "resources": {
+                "cpu": 2,
+                "ram": 2048,
+                "hdd": 7,
+                "os": "debian",
+                "version": "12"
+            }
+        }
+    ],
+    "default_credentials": {
+        "username": null,
+        "password": null
+    },
+    "notes": []
+}
--- a/install/wikijs-install.sh
+++ b/install/wikijs-install.sh
@ -0,0 +1,100 @@
+#!/usr/bin/env bash
+
+# Copyright (c) 2021-2025 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 \
+  sudo \
+  mc \
+  gpg
+msg_ok "Installed Dependencies"
+
+msg_info "Setting up Node.js Repository"
+mkdir -p /etc/apt/keyrings
+curl -fsSL https://deb.nodesource.com/gpgkey/nodesource-repo.gpg.key | gpg --dearmor -o /etc/apt/keyrings/nodesource.gpg
+echo "deb [signed-by=/etc/apt/keyrings/nodesource.gpg] https://deb.nodesource.com/node_22.x nodistro main" >/etc/apt/sources.list.d/nodesource.list
+msg_ok "Set up Node.js Repository"
+
+msg_info "Setting up PostgreSQL Repository"
+curl -fsSL https://www.postgresql.org/media/keys/ACCC4CF8.asc | gpg --dearmor -o /etc/apt/trusted.gpg.d/postgresql.gpg
+echo "deb https://apt.postgresql.org/pub/repos/apt bookworm-pgdg main" >/etc/apt/sources.list.d/pgdg.list
+msg_ok "Set up PostgreSQL Repository"
+
+msg_info "Installing Node.js"
+$STD apt-get update
+$STD apt-get install -y nodejs
+$STD npm install --global yarn
+$STD npm install -g node-gyp
+msg_ok "Installed Node.js"
+
+msg_info "Setting up PostgreSQL"
+$STD apt-get install -y postgresql-17
+DB_NAME="wiki"
+DB_USER="wikijs_user"
+DB_PASS="$(openssl rand -base64 18 | tr -dc 'a-zA-Z0-9' | cut -c1-13)"
+$STD sudo -u postgres psql -c "CREATE ROLE $DB_USER WITH LOGIN PASSWORD '$DB_PASS';"
+$STD sudo -u postgres psql -c "CREATE DATABASE $DB_NAME WITH OWNER $DB_USER ENCODING 'UTF8' TEMPLATE template0;"
+$STD sudo -u postgres psql -c "CREATE EXTENSION IF NOT EXISTS pg_trgm;" $DB_NAME
+$STD sudo -u postgres psql -c "ALTER ROLE $DB_USER SET client_encoding TO 'utf8';"
+$STD sudo -u postgres psql -c "ALTER ROLE $DB_USER SET default_transaction_isolation TO 'read committed';"
+$STD sudo -u postgres psql -c "ALTER ROLE $DB_USER SET timezone TO 'UTC';"
+{
+  echo "WikiJS-Credentials"
+  echo "WikiJS Database User: $DB_USER"
+  echo "WikiJS Database Password: $DB_PASS"
+  echo "WikiJS Database Name: $DB_NAME"
+} >>~/wikijs.creds
+msg_ok "Set up PostgreSQL"
+
+msg_info "Setup Wiki.js"
+RELEASE=$(curl -s https://api.github.com/repos/Requarks/wiki/releases/latest | grep "tag_name" | awk '{print substr($2, 3, length($2)-4) }')
+mkdir /opt/wikijs
+cd /opt/wikijs
+wget -q "https://github.com/requarks/wiki/releases/download/v${RELEASE}/wiki-js.tar.gz"
+tar -xzf wiki-js.tar.gz
+mv /opt/wikijs/config.sample.yml /opt/wikijs/config.yml
+sed -i -E 's|^( *user: ).*|\1'"$DB_USER"'|' /opt/wikijs/config.yml
+sed -i -E 's|^( *pass: ).*|\1'"$DB_PASS"'|' /opt/wikijs/config.yml
+echo "${RELEASE}" >"/opt/${APPLICATION}_version.txt"
+msg_ok "Installed Wiki.js"
+
+msg_info "Creating Service"
+cat <<EOF >/etc/systemd/system/wikijs.service
+[Unit]
+Description=Wiki.js
+After=network.target
+
+[Service]
+Type=simple
+ExecStart=/usr/bin/node server
+Restart=always
+User=root
+Environment=NODE_ENV=production
+WorkingDirectory=/opt/wikijs
+
+[Install]
+WantedBy=multi-user.target
+EOF
+systemctl enable -q --now wikijs
+msg_ok "Created Service"
+
+motd_ssh
+customize
+
+msg_info "Cleaning up"
+rm -f /opt/wikijs/wiki-js.tar.gz
+$STD apt-get -y autoremove
+$STD apt-get -y autoclean
+msg_ok "Cleaned"