From bdca2666fc81b0cadccb4a1282b2b4a23e653d45 Mon Sep 17 00:00:00 2001 From: Stellae <80097964+StellaeAlis@users.noreply.github.com> Date: Sun, 25 Jan 2026 13:59:49 +0000 Subject: [PATCH 1/3] feat: add WriteFreely --- ct/writefreely.sh | 91 +++++++++++++++++++++++++ frontend/public/json/writefreely.json | 40 +++++++++++ install/writefreely-install.sh | 96 +++++++++++++++++++++++++++ 3 files changed, 227 insertions(+) create mode 100644 ct/writefreely.sh create mode 100644 frontend/public/json/writefreely.json create mode 100644 install/writefreely-install.sh diff --git a/ct/writefreely.sh b/ct/writefreely.sh new file mode 100644 index 000000000..29f9501fa --- /dev/null +++ b/ct/writefreely.sh @@ -0,0 +1,91 @@ +#!/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: StellaeAlis +# License: MIT | https://github.com/community-scripts/ProxmoxVE/raw/main/LICENSE +# Source: https://github.com/writefreely/writefreely + +# App Default Values +APP="WriteFreely" +var_tags="${var_tags:-writing}" +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}" + +# ============================================================================= +# CONFIGURATION GUIDE +# ============================================================================= +# APP - Display name, title case (e.g. "Koel", "Wallabag", "Actual Budget") +# var_tags - Max 2 tags, semicolon separated (e.g. "music;streaming", "finance") +# var_cpu - CPU cores: 1-4 typical +# var_ram - RAM in MB: 512, 1024, 2048, 4096 typical +# var_disk - Disk in GB: 4, 6, 8, 10, 20 typical +# var_os - OS: debian, ubuntu, alpine +# var_version - OS version: 12/13 (debian), 22.04/24.04 (ubuntu), 3.20/3.21 (alpine) +# var_unprivileged - 1 = unprivileged (secure, default), 0 = privileged (for docker etc.) + +header_info "$APP" +variables +color +catch_errors + +function update_script() { + header_info + check_container_storage + check_container_resources + + # Check if installation exists + if [[ ! -d /opt/writefreely ]]; then + msg_error "No ${APP} Installation Found!" + exit + fi + + # check_for_gh_release returns 0 (true) if update available, 1 (false) if not + if check_for_gh_release "writefreely" "writefreely/writefreely"; then + msg_info "Stopping Services" + systemctl stop writefreely + msg_ok "Stopped Services" + + # Backup important data before update + msg_info "Creating Backup" + mkdir -p /tmp/writefreely_backup + cp /opt/writefreely/keys /tmp/writefreely_backup/ 2>/dev/null || true + cp /opt/writefreely/config.ini /tmp/writefreely_backup/ 2>/dev/null || true + msg_ok "Created Backup" + + # CLEAN_INSTALL=1 removes old directory before extracting new version + CLEAN_INSTALL=1 fetch_and_deploy_gh_release "writefreely" "writefreely/writefreely" "prebuild" "latest" "/opt/writefreely" "writefreely_*_linux_amd64.tar.gz" + + # Restore configuration and data + msg_info "Restoring Data" + cp /tmp/writefreely_backup/config.ini /opt/writefreely/ 2>/dev/null || true + cp /tmp/writefreely_backup/keys/* /opt/writefreely/keys/ 2>/dev/null || true + rm -rf /tmp/writefreely_backup + msg_ok "Restored Data" + + # Optional: Run any post-update commands + msg_info "Running Post-Update Tasks" + cd /opt/writefreely + $STD ./writefreely db migrate + msg_ok "Ran Post-Update Tasks" + + msg_info "Starting Services" + systemctl start writefreely + msg_ok "Started Services" + + 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}${CL}" diff --git a/frontend/public/json/writefreely.json b/frontend/public/json/writefreely.json new file mode 100644 index 000000000..345df956c --- /dev/null +++ b/frontend/public/json/writefreely.json @@ -0,0 +1,40 @@ +{ + "name": "WriteFreely", + "slug": "writefreely", + "categories": [ + 12 + ], + "date_created": "2026-01-25", + "type": "ct", + "updateable": true, + "privileged": false, + "interface_port": 80, + "documentation": "https://writefreely.org/docs", + "config_path": "/opt/writefreely/config.ini", + "website": "https://writefreely.org/", + "logo": "https://github.com/writefreely/writefreely/blob/develop/static/img/wf-sq.png?raw=true", + "description": "WriteFreely is free and open source software for easily publishing writing on the web with support for the ActivityPub protocol. Use it to start a personal blog — or an entire community.", + "install_methods": [ + { + "type": "default", + "script": "ct/writefreely.sh", + "resources": { + "cpu": 2, + "ram": 1024, + "hdd": 4, + "os": "Debian", + "version": "13" + } + } + ], + "default_credentials": { + "username": null, + "password": null + }, + "notes": [ + { + "text": "After installation execute `./writefreely user create --admin username:password` in the `/opt/writefreely` directory to create your user.", + "type": "info" + } + ] +} diff --git a/install/writefreely-install.sh b/install/writefreely-install.sh new file mode 100644 index 000000000..96aa76662 --- /dev/null +++ b/install/writefreely-install.sh @@ -0,0 +1,96 @@ +#!/usr/bin/env bash + +# Copyright (c) 2021-2026 community-scripts ORG +# Author: StellaeAlis +# License: MIT | https://github.com/community-scripts/ProxmoxVE/raw/main/LICENSE +# Source: https://github.com/writefreely/writefreely + +# Import Functions and Setup +source /dev/stdin <<<"$FUNCTIONS_FILE_PATH" +color +verb_ip6 +catch_errors +setting_up_container +network_check +update_os + +# ============================================================================= +# DEPENDENCIES +# ============================================================================= +# Only install what's actually needed - curl/sudo/mc are already in the base image + +msg_info "Installing Dependencies" +$STD apt install -y \ + crudini +msg_ok "Installed Dependencies" + +# --- Setup database --- +setup_mariadb +MARIADB_DB_NAME="writefreely" MARIADB_DB_USER="writefreely" setup_mariadb_db + +get_lxc_ip + +# --- Download and install app --- +fetch_and_deploy_gh_release "writefreely" "writefreely/writefreely" "prebuild" "latest" "/opt/writefreely" "writefreely_*_linux_amd64.tar.gz" + +msg_info "Setting up WriteFreely" +cd /opt/writefreely +$STD ./writefreely config generate +$STD ./writefreely keys generate +msg_ok "Setup WriteFreely" + +# ============================================================================= +# CONFIGURATION +# ============================================================================= + +msg_info "Configuring WriteFreely" +$STD crudini --set config.ini server port 80 +$STD crudini --set config.ini server bind $LOCAL_IP + +$STD crudini --set config.ini database username $MARIADB_DB_USER +$STD crudini --set config.ini database password $MARIADB_DB_PASS +$STD crudini --set config.ini database database $MARIADB_DB_NAME + +$STD crudini --set config.ini app host http://$LOCAL_IP:80 + +$STD ./writefreely db init +msg_ok "Configured WriteFreely" + +# ============================================================================= +# SERVICE CREATION +# ============================================================================= + +msg_info "Creating Service" +cat </etc/systemd/system/writefreely.service +[Unit] +Description=WriteFreely Service +After=syslog.target network.target + +[Service] +Type=simple +User=root +WorkingDirectory=/opt/writefreely +ExecStart=/opt/writefreely/writefreely +Restart=on-failure +RestartSec=5 + +[Install] +WantedBy=multi-user.target +EOF +systemctl enable -q --now writefreely +msg_ok "Created Service" + +# ============================================================================= +# CLEANUP & FINALIZATION +# ============================================================================= + + +msg_info "Cleaning up" +$STD rm ~/writefreely.creds +msg_ok "Cleaned up" + +motd_ssh +customize + +# cleanup_lxc handles: apt autoremove, autoclean, temp files, bash history +cleanup_lxc From 2fcc38614a3d511dcffa1cae89aa4ce063f2b5b2 Mon Sep 17 00:00:00 2001 From: Stellae <80097964+StellaeAlis@users.noreply.github.com> Date: Sun, 25 Jan 2026 14:22:33 +0000 Subject: [PATCH 2/3] fix: Greptile errors --- ct/writefreely.sh | 26 ++++---------------------- frontend/public/json/writefreely.json | 2 +- install/writefreely-install.sh | 21 --------------------- 3 files changed, 5 insertions(+), 44 deletions(-) diff --git a/ct/writefreely.sh b/ct/writefreely.sh index 29f9501fa..48f93a535 100644 --- a/ct/writefreely.sh +++ b/ct/writefreely.sh @@ -15,18 +15,6 @@ var_os="${var_os:-debian}" var_version="${var_version:-13}" var_unprivileged="${var_unprivileged:-1}" -# ============================================================================= -# CONFIGURATION GUIDE -# ============================================================================= -# APP - Display name, title case (e.g. "Koel", "Wallabag", "Actual Budget") -# var_tags - Max 2 tags, semicolon separated (e.g. "music;streaming", "finance") -# var_cpu - CPU cores: 1-4 typical -# var_ram - RAM in MB: 512, 1024, 2048, 4096 typical -# var_disk - Disk in GB: 4, 6, 8, 10, 20 typical -# var_os - OS: debian, ubuntu, alpine -# var_version - OS version: 12/13 (debian), 22.04/24.04 (ubuntu), 3.20/3.21 (alpine) -# var_unprivileged - 1 = unprivileged (secure, default), 0 = privileged (for docker etc.) - header_info "$APP" variables color @@ -37,36 +25,30 @@ function update_script() { check_container_storage check_container_resources - # Check if installation exists if [[ ! -d /opt/writefreely ]]; then msg_error "No ${APP} Installation Found!" exit fi - # check_for_gh_release returns 0 (true) if update available, 1 (false) if not if check_for_gh_release "writefreely" "writefreely/writefreely"; then msg_info "Stopping Services" systemctl stop writefreely msg_ok "Stopped Services" - # Backup important data before update msg_info "Creating Backup" mkdir -p /tmp/writefreely_backup - cp /opt/writefreely/keys /tmp/writefreely_backup/ 2>/dev/null || true - cp /opt/writefreely/config.ini /tmp/writefreely_backup/ 2>/dev/null || true + cp /opt/writefreely/keys /tmp/writefreely_backup/ 2>/dev/null + cp /opt/writefreely/config.ini /tmp/writefreely_backup/ 2>/dev/null msg_ok "Created Backup" - # CLEAN_INSTALL=1 removes old directory before extracting new version CLEAN_INSTALL=1 fetch_and_deploy_gh_release "writefreely" "writefreely/writefreely" "prebuild" "latest" "/opt/writefreely" "writefreely_*_linux_amd64.tar.gz" - # Restore configuration and data msg_info "Restoring Data" - cp /tmp/writefreely_backup/config.ini /opt/writefreely/ 2>/dev/null || true - cp /tmp/writefreely_backup/keys/* /opt/writefreely/keys/ 2>/dev/null || true + cp /tmp/writefreely_backup/config.ini /opt/writefreely/ 2>/dev/null + cp /tmp/writefreely_backup/keys/* /opt/writefreely/keys/ 2>/dev/null rm -rf /tmp/writefreely_backup msg_ok "Restored Data" - # Optional: Run any post-update commands msg_info "Running Post-Update Tasks" cd /opt/writefreely $STD ./writefreely db migrate diff --git a/frontend/public/json/writefreely.json b/frontend/public/json/writefreely.json index 345df956c..eec8a77c2 100644 --- a/frontend/public/json/writefreely.json +++ b/frontend/public/json/writefreely.json @@ -12,7 +12,7 @@ "documentation": "https://writefreely.org/docs", "config_path": "/opt/writefreely/config.ini", "website": "https://writefreely.org/", - "logo": "https://github.com/writefreely/writefreely/blob/develop/static/img/wf-sq.png?raw=true", + "logo": "https://cdn.jsdelivr.net/gh/selfhst/icons@main/png/writefreely-light.png", "description": "WriteFreely is free and open source software for easily publishing writing on the web with support for the ActivityPub protocol. Use it to start a personal blog — or an entire community.", "install_methods": [ { diff --git a/install/writefreely-install.sh b/install/writefreely-install.sh index 96aa76662..98be776cf 100644 --- a/install/writefreely-install.sh +++ b/install/writefreely-install.sh @@ -14,23 +14,16 @@ setting_up_container network_check update_os -# ============================================================================= -# DEPENDENCIES -# ============================================================================= -# Only install what's actually needed - curl/sudo/mc are already in the base image - msg_info "Installing Dependencies" $STD apt install -y \ crudini msg_ok "Installed Dependencies" -# --- Setup database --- setup_mariadb MARIADB_DB_NAME="writefreely" MARIADB_DB_USER="writefreely" setup_mariadb_db get_lxc_ip -# --- Download and install app --- fetch_and_deploy_gh_release "writefreely" "writefreely/writefreely" "prebuild" "latest" "/opt/writefreely" "writefreely_*_linux_amd64.tar.gz" msg_info "Setting up WriteFreely" @@ -39,10 +32,6 @@ $STD ./writefreely config generate $STD ./writefreely keys generate msg_ok "Setup WriteFreely" -# ============================================================================= -# CONFIGURATION -# ============================================================================= - msg_info "Configuring WriteFreely" $STD crudini --set config.ini server port 80 $STD crudini --set config.ini server bind $LOCAL_IP @@ -56,10 +45,6 @@ $STD crudini --set config.ini app host http://$LOCAL_IP:80 $STD ./writefreely db init msg_ok "Configured WriteFreely" -# ============================================================================= -# SERVICE CREATION -# ============================================================================= - msg_info "Creating Service" cat </etc/systemd/system/writefreely.service [Unit] @@ -80,11 +65,6 @@ EOF systemctl enable -q --now writefreely msg_ok "Created Service" -# ============================================================================= -# CLEANUP & FINALIZATION -# ============================================================================= - - msg_info "Cleaning up" $STD rm ~/writefreely.creds msg_ok "Cleaned up" @@ -92,5 +72,4 @@ msg_ok "Cleaned up" motd_ssh customize -# cleanup_lxc handles: apt autoremove, autoclean, temp files, bash history cleanup_lxc From a89fbda0273adae692bff101bcdffcbcc553b9be Mon Sep 17 00:00:00 2001 From: Stellae <80097964+StellaeAlis@users.noreply.github.com> Date: Mon, 26 Jan 2026 10:29:20 +0000 Subject: [PATCH 3/3] fix: review requests --- ct/writefreely.sh | 1 - frontend/public/json/writefreely.json | 2 +- install/writefreely-install.sh | 6 +----- 3 files changed, 2 insertions(+), 7 deletions(-) diff --git a/ct/writefreely.sh b/ct/writefreely.sh index 48f93a535..bb0c64c58 100644 --- a/ct/writefreely.sh +++ b/ct/writefreely.sh @@ -57,7 +57,6 @@ function update_script() { msg_info "Starting Services" systemctl start writefreely msg_ok "Started Services" - msg_ok "Updated successfully!" fi exit diff --git a/frontend/public/json/writefreely.json b/frontend/public/json/writefreely.json index eec8a77c2..984243807 100644 --- a/frontend/public/json/writefreely.json +++ b/frontend/public/json/writefreely.json @@ -12,7 +12,7 @@ "documentation": "https://writefreely.org/docs", "config_path": "/opt/writefreely/config.ini", "website": "https://writefreely.org/", - "logo": "https://cdn.jsdelivr.net/gh/selfhst/icons@main/png/writefreely-light.png", + "logo": "https://cdn.jsdelivr.net/gh/selfhst/icons@main/webp/writefreely-light.webp", "description": "WriteFreely is free and open source software for easily publishing writing on the web with support for the ActivityPub protocol. Use it to start a personal blog — or an entire community.", "install_methods": [ { diff --git a/install/writefreely-install.sh b/install/writefreely-install.sh index 98be776cf..c3a1e21a7 100644 --- a/install/writefreely-install.sh +++ b/install/writefreely-install.sh @@ -15,8 +15,7 @@ network_check update_os msg_info "Installing Dependencies" -$STD apt install -y \ - crudini +$STD apt install -y crudini msg_ok "Installed Dependencies" setup_mariadb @@ -35,13 +34,10 @@ msg_ok "Setup WriteFreely" msg_info "Configuring WriteFreely" $STD crudini --set config.ini server port 80 $STD crudini --set config.ini server bind $LOCAL_IP - $STD crudini --set config.ini database username $MARIADB_DB_USER $STD crudini --set config.ini database password $MARIADB_DB_PASS $STD crudini --set config.ini database database $MARIADB_DB_NAME - $STD crudini --set config.ini app host http://$LOCAL_IP:80 - $STD ./writefreely db init msg_ok "Configured WriteFreely"