Merge pull request #1512 from PouletteMC/feature/surrealdb

New LXC: SurrealDB
This commit is contained in:
CanbiZ (MickLesk)
2026-03-27 13:58:04 +01:00
committed by GitHub
3 changed files with 153 additions and 0 deletions

55
ct/surrealdb.sh Normal file
View File

@@ -0,0 +1,55 @@
#!/usr/bin/env bash
source <(curl -fsSL https://raw.githubusercontent.com/community-scripts/ProxmoxVED/main/misc/build.func)
# Copyright (c) 2021-2026 community-scripts ORG
# Author: PouletteMC
# License: MIT | https://github.com/community-scripts/ProxmoxVED/raw/main/LICENSE
# Source: https://surrealdb.com
APP="SurrealDB"
var_tags="${var_tags:-database;nosql}"
var_cpu="${var_cpu:-2}"
var_ram="${var_ram:-1024}"
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 [[ ! -f /opt/surrealdb/surreal ]]; then
msg_error "No SurrealDB Installation Found!"
exit
fi
if check_for_gh_release "surrealdb" "surrealdb/surrealdb"; then
msg_info "Stopping Service"
systemctl stop surrealdb
msg_ok "Stopped Service"
fetch_and_deploy_gh_release "surrealdb" "surrealdb/surrealdb" "prebuild" "latest" "/opt/surrealdb" "surreal-v*.linux-amd64.tgz"
chmod +x /opt/surrealdb/surreal
msg_info "Starting Service"
systemctl start surrealdb
msg_ok "Started Service"
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}:8000${CL}"

42
frontend/public/json/surrealdb.json generated Normal file
View File

@@ -0,0 +1,42 @@
{
"name": "SurrealDB",
"slug": "surrealdb",
"categories": [8],
"date_created": "2026-02-26",
"type": "ct",
"updateable": true,
"privileged": false,
"interface_port": 8000,
"documentation": "https://surrealdb.com/docs",
"website": "https://surrealdb.com/",
"logo": "https://cdn.jsdelivr.net/gh/selfhst/icons@main/webp/surrealdb.webp",
"config_path": "/opt/surrealdb/.env",
"description": "SurrealDB is a multi-model database that combines the power of document, graph, and relational databases into a single platform, offering real-time queries, built-in permissions, and a simplified backend stack.",
"install_methods": [
{
"type": "default",
"script": "ct/surrealdb.sh",
"resources": {
"cpu": 2,
"ram": 1024,
"hdd": 4,
"os": "Debian",
"version": "13"
}
}
],
"default_credentials": {
"username": "root",
"password": null
},
"notes": [
{
"text": "SurrealDB web interface is available on port 8000.",
"type": "info"
},
{
"text": "Default credentials are saved in ~/surrealdb.creds.",
"type": "info"
}
]
}

View File

@@ -0,0 +1,56 @@
#!/usr/bin/env bash
# Copyright (c) 2021-2026 community-scripts ORG
# Author: PouletteMC
# License: MIT | https://github.com/community-scripts/ProxmoxVED/raw/main/LICENSE
# Source: https://surrealdb.com
source /dev/stdin <<<"$FUNCTIONS_FILE_PATH"
color
verb_ip6
catch_errors
setting_up_container
network_check
update_os
msg_info "Installing SurrealDB"
fetch_and_deploy_gh_release "surrealdb" "surrealdb/surrealdb" "prebuild" "latest" "/opt/surrealdb" "surreal-v*.linux-amd64.tgz"
chmod +x /opt/surrealdb/surreal
ln -sf /opt/surrealdb/surreal /usr/local/bin/surreal
msg_ok "Installed SurrealDB"
msg_info "Configuring SurrealDB"
mkdir -p /opt/surrealdb/data
SURREALDB_PASS=$(openssl rand -base64 18 | tr -dc 'a-zA-Z0-9' | head -c13)
cat <<EOF >/opt/surrealdb/.env
SURREALDB_PASS=${SURREALDB_PASS}
EOF
{
echo "SurrealDB Credentials"
echo "Username: root"
echo "Password: ${SURREALDB_PASS}"
} >>~/surrealdb.creds
msg_ok "Configured SurrealDB"
msg_info "Creating Service"
cat <<EOF >/etc/systemd/system/surrealdb.service
[Unit]
Description=SurrealDB Server
After=network.target
[Service]
Type=simple
EnvironmentFile=/opt/surrealdb/.env
ExecStart=/opt/surrealdb/surreal start --bind 0.0.0.0:8000 --user root --pass \${SURREALDB_PASS} rocksdb:///opt/surrealdb/data/srdb.db
Restart=on-failure
RestartSec=5
[Install]
WantedBy=multi-user.target
EOF
systemctl enable -q --now surrealdb
msg_ok "Created Service"
motd_ssh
customize
cleanup_lxc