7 |
19 | );
20 | }
21 |
--------------------------------------------------------------------------------
/docs/misc/alpine-install.func/ALPINE_INSTALL_FUNC_FUNCTIONS_REFERENCE.md:
--------------------------------------------------------------------------------
1 | # alpine-install.func Functions Reference
2 |
3 | Alpine Linux-specific installation functions (apk-based, OpenRC).
4 |
5 | ## Core Functions
6 |
7 | ### setting_up_container()
8 | Initialize Alpine container setup.
9 |
10 | ### update_os()
11 | Update Alpine packages via `apk update && apk upgrade`.
12 |
13 | ### verb_ip6()
14 | Enable IPv6 on Alpine with persistent configuration.
15 |
16 | ### network_check()
17 | Verify network connectivity in Alpine.
18 |
19 | ### motd_ssh()
20 | Configure SSH daemon and MOTD on Alpine.
21 |
22 | ### customize()
23 | Apply Alpine-specific customizations.
24 |
25 | ### cleanup_lxc()
26 | Final cleanup (Alpine-specific).
27 |
28 | ---
29 |
30 | **Last Updated**: December 2025
31 |
--------------------------------------------------------------------------------
/tools/headers/container-restore-from-backup:
--------------------------------------------------------------------------------
1 | __ __ ___ _ __ __ ______ __ _
2 | / / / /___ ____ ___ ___ / | __________(_)____/ /_____ _____ / /_ / ____/___ ____ / /_____ _(_)___ ___ _____
3 | / /_/ / __ \/ __ `__ \/ _ \ / /| | / ___/ ___/ / ___/ __/ __ `/ __ \/ __/ / / / __ \/ __ \/ __/ __ `/ / __ \/ _ \/ ___/
4 | / __ / /_/ / / / / / / __/ / ___ |(__ |__ ) (__ ) /_/ /_/ / / / / /_ / /___/ /_/ / / / / /_/ /_/ / / / / / __/ /
5 | /_/ /_/\____/_/ /_/ /_/\___/ /_/ |_/____/____/_/____/\__/\__,_/_/ /_/\__/ \____/\____/_/ /_/\__/\__,_/_/_/ /_/\___/_/
6 |
7 |
--------------------------------------------------------------------------------
/docs/misc/alpine-tools.func/ALPINE_TOOLS_FUNC_FUNCTIONS_REFERENCE.md:
--------------------------------------------------------------------------------
1 | # alpine-tools.func Functions Reference
2 |
3 | Alpine-specific tool installation functions.
4 |
5 | ## Core Functions
6 |
7 | ### apk_update()
8 | Update Alpine package lists.
9 |
10 | ### apk_add(PACKAGES)
11 | Install Alpine packages.
12 |
13 | ### apk_del(PACKAGES)
14 | Remove Alpine packages.
15 |
16 | ### add_community_repo()
17 | Enable Alpine community repository.
18 |
19 | ### add_testing_repo()
20 | Enable Alpine testing repository.
21 |
22 | ### Alpine Tool Functions
23 | - `setup_nodejs()` - Alpine Node.js
24 | - `setup_php()` - Alpine PHP
25 | - `setup_mariadb()` - Alpine MariaDB
26 | - `setup_postgresql()` - Alpine PostgreSQL
27 | - (+ more Alpine-specific setups)
28 |
29 | ---
30 |
31 | **Last Updated**: December 2025
32 |
--------------------------------------------------------------------------------
/frontend/src/components/ui/textarea.tsx:
--------------------------------------------------------------------------------
1 | import * as React from "react"
2 |
3 | import { cn } from "@/lib/utils"
4 |
5 | const Textarea = React.forwardRef<
6 | HTMLTextAreaElement,
7 | React.ComponentProps<"textarea">
8 | >(({ className, ...props }, ref) => {
9 | return (
10 |
18 | )
19 | })
20 | Textarea.displayName = "Textarea"
21 |
22 | export { Textarea }
23 |
--------------------------------------------------------------------------------
/install/debian-install.sh:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env bash
2 |
3 | # Copyright (c) 2021-2025 community-scripts ORG
4 | # Author: MickLesk (CanbiZ)
5 | # License: MIT | https://github.com/community-scripts/ProxmoxVED/raw/main/LICENSE
6 | # Source:
7 |
8 | source /dev/stdin <<<"$FUNCTIONS_FILE_PATH"
9 | color
10 | verb_ip6
11 | catch_errors
12 | setting_up_container
13 | network_check
14 | update_os
15 |
16 | msg_info "Installing Base Dependencies"
17 | $STD apt-get install -y curl wget ca-certificates
18 | msg_ok "Installed Base Dependencies"
19 |
20 | # msg_info "Downloading and executing tools.func test suite"
21 | # bash <(curl -fsSL https://git.community-scripts.org/community-scripts/ProxmoxVED/raw/branch/main/misc/test-tools-func.sh)
22 | # msg_ok "Test suite completed"
23 |
24 | motd_ssh
25 | customize
26 | cleanup_lxc
27 |
--------------------------------------------------------------------------------
/.github/workflows/scripts/update_json_date.sh:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env bash
2 |
3 | # Verzeichnis, das die JSON-Dateien enthält
4 | json_dir="./json/*.json"
5 |
6 | current_date=$(date +"%Y-%m-%d")
7 |
8 | for json_file in $json_dir; do
9 | if [[ -f "$json_file" ]]; then
10 | current_json_date=$(jq -r '.date_created' "$json_file")
11 |
12 | if [[ "$current_json_date" != "$current_date" ]]; then
13 | echo "Updating $json_file with date $current_date"
14 | jq --arg date "$current_date" '.date_created = $date' "$json_file" > temp.json && mv temp.json "$json_file"
15 |
16 | git add "$json_file"
17 | git commit -m "Update date_created to $current_date in $json_file"
18 | else
19 | echo "Date in $json_file is already up to date."
20 | fi
21 | fi
22 | done
23 | git push origin HEAD
24 |
--------------------------------------------------------------------------------
/frontend/src/components/ui/label.tsx:
--------------------------------------------------------------------------------
1 | "use client"
2 |
3 | import * as React from "react"
4 | import * as LabelPrimitive from "@radix-ui/react-label"
5 | import { cva, type VariantProps } from "class-variance-authority"
6 |
7 | import { cn } from "@/lib/utils"
8 |
9 | const labelVariants = cva(
10 | "text-sm font-medium leading-none peer-disabled:cursor-not-allowed peer-disabled:opacity-70"
11 | )
12 |
13 | const Label = React.forwardRef<
14 | React.ElementRef
8 |
15 |
18 | 9 | 404 10 |
11 |12 | Oops, the page you are looking for could not be found. 13 |
14 |
16 |
26 | );
27 | };
28 |
29 | export default Modal;
30 |
--------------------------------------------------------------------------------
/frontend/src/components/TextCopyBlock.tsx:
--------------------------------------------------------------------------------
1 | import { ClipboardIcon } from "lucide-react";
2 | import handleCopy from "./handleCopy";
3 |
4 | export default function TextCopyBlock(description: string) {
5 | const pattern = /`([^`]*)`/g;
6 | const parts = description.split(pattern);
7 |
8 | const formattedDescription = parts.map((part: string, index: number) => {
9 | if (index % 2 === 1) {
10 | return (
11 |
15 | {part}
16 |
17 |
23 | {children}
24 |
25 |
10 | {item.interface_port !== null ? (
11 |
20 | );
21 | }
22 |
--------------------------------------------------------------------------------
/frontend/src/components/ui/sonner.tsx:
--------------------------------------------------------------------------------
1 | "use client";
2 |
3 | import { useTheme } from "next-themes";
4 | import { Toaster as Sonner } from "sonner";
5 |
6 | type ToasterProps = React.ComponentProps
12 | handleCopy("default interface", String(item.interface_port))} className="size-4 cursor-pointer" />
16 |
17 |
18 | ) : null}
19 | Default Interface:
13 | 14 | {item.interface_port} 15 |
19 |
22 |
23 | {children}
24 |
25 | );
26 | }
27 |
--------------------------------------------------------------------------------
/.vscode/settings.json:
--------------------------------------------------------------------------------
1 | {
2 | "files.associations": {
3 | "*.func": "shellscript"
4 | },
5 | "files.eol": "\n",
6 | "files.encoding": "utf8",
7 | "files.trimTrailingWhitespace": true,
8 | "files.insertFinalNewline": true,
9 | "files.autoSave": "afterDelay",
10 | "files.autoGuessEncoding": false,
11 | "editor.detectIndentation": false,
12 | "editor.tabSize": 4,
13 | "editor.insertSpaces": true,
14 | "editor.wordWrap": "off",
15 | "editor.renderWhitespace": "boundary",
16 | "editor.formatOnSave": true,
17 | "editor.formatOnPaste": true,
18 | "editor.minimap.enabled": false,
19 | "terminal.integrated.scrollback": 10000,
20 | "[shellscript]": {
21 | "editor.defaultFormatter": "foxundermoon.shell-format",
22 | "editor.tabSize": 4,
23 | "editor.insertSpaces": true,
24 | },
25 | "shellcheck.customArgs": [
26 | "--rcfile",
27 | ".vscode/.shellcheckrc"
28 | ],
29 | "git.autofetch": true,
30 | "git.confirmSync": false,
31 | "git.enableSmartCommit": true,
32 | "extensions.ignoreRecommendations": false
33 | }
34 |
--------------------------------------------------------------------------------
/frontend/public/json/byparr.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "Byparr",
3 | "slug": "byparr",
4 | "categories": [
5 | 14
6 | ],
7 | "date_created": "2025-12-02",
8 | "type": "ct",
9 | "updateable": true,
10 | "privileged": false,
11 | "interface_port": 8191,
12 | "documentation": "https://github.com/ThePhaseless/Byparr/blob/master/README.md",
13 | "website": "https://github.com/ThePhaseless/Byparr",
14 | "logo": "https://cdn.jsdelivr.net/gh/selfhst/icons@main/webp/byparr.webp",
15 | "config_path": "",
16 | "description": "Byparr is a proxy server to bypass Cloudflare and DDoS-GUARD protection.",
17 | "install_methods": [
18 | {
19 | "type": "default",
20 | "script": "ct/byparr.sh",
21 | "resources": {
22 | "cpu": 2,
23 | "ram": 2048,
24 | "hdd": 4,
25 | "os": "debian",
26 | "version": "13"
27 | }
28 | }
29 | ],
30 | "default_credentials": {
31 | "username": null,
32 | "password": null
33 | },
34 | "notes": []
35 | }
36 |
--------------------------------------------------------------------------------
/frontend/public/json/ubuntu.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "Ubuntu",
3 | "slug": "ubuntu",
4 | "categories": [
5 | 0
6 | ],
7 | "date_created": "2025-12-04",
8 | "type": "ct",
9 | "updateable": true,
10 | "privileged": false,
11 | "interface_port": null,
12 | "documentation": "https://help.ubuntu.com/",
13 | "website": "https://ubuntu.com/",
14 | "logo": "https://cdn.jsdelivr.net/gh/selfhst/icons@main/webp/ubuntu.webp",
15 | "config_path": "",
16 | "description": "Ubuntu is a popular Linux distribution based on Debian. Known for its ease of use and regular release cycle with LTS versions.",
17 | "install_methods": [
18 | {
19 | "type": "default",
20 | "script": "ct/ubuntu.sh",
21 | "resources": {
22 | "cpu": 1,
23 | "ram": 512,
24 | "hdd": 4,
25 | "os": "ubuntu",
26 | "version": "24.04"
27 | }
28 | }
29 | ],
30 | "default_credentials": {
31 | "username": "root",
32 | "password": null
33 | },
34 | "notes": []
35 | }
36 |
--------------------------------------------------------------------------------
/frontend/public/json/nextexplorer.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "nextExplorer",
3 | "slug": "nextexplorer",
4 | "categories": [
5 | 11,
6 | 12
7 | ],
8 | "date_created": "2025-12-11",
9 | "type": "ct",
10 | "updateable": true,
11 | "privileged": false,
12 | "interface_port": 3000,
13 | "documentation": "https://explorer.nxz.ai",
14 | "website": "https://github.com/vikramsoni2/nextExplorer",
15 | "logo": "https://cdn.jsdelivr.net/gh/selfhst/icons@main/webp/nextexplorer.webp",
16 | "config_path": "/etc/nextExplorer/.env",
17 | "description": "",
18 | "install_methods": [
19 | {
20 | "type": "default",
21 | "script": "ct/nextexplorer.sh",
22 | "resources": {
23 | "cpu": 2,
24 | "ram": 3072,
25 | "hdd": 8,
26 | "os": "Debian",
27 | "version": "13"
28 | }
29 | }
30 | ],
31 | "notes": [
32 | {
33 | "text": "Bind mount your volume(s) in the `/mnt` directory",
34 | "type": "info"
35 | }
36 | ]
37 | }
38 |
--------------------------------------------------------------------------------
/frontend/LICENSE:
--------------------------------------------------------------------------------
1 | MIT License
2 |
3 | Copyright (c) 2024 Bram Suurd
4 |
5 | Permission is hereby granted, free of charge, to any person obtaining a copy
6 | of this software and associated documentation files (the "Software"), to deal
7 | in the Software without restriction, including without limitation the rights
8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 |
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 |
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.
22 |
--------------------------------------------------------------------------------
/frontend/public/json/almalinux.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "AlmaLinux",
3 | "slug": "almalinux",
4 | "categories": [
5 | 0
6 | ],
7 | "date_created": "2025-12-04",
8 | "type": "ct",
9 | "updateable": true,
10 | "privileged": false,
11 | "interface_port": null,
12 | "documentation": "https://wiki.almalinux.org/",
13 | "website": "https://almalinux.org/",
14 | "logo": "https://cdn.jsdelivr.net/gh/selfhst/icons@main/webp/almalinux.webp",
15 | "config_path": "",
16 | "description": "AlmaLinux is an open-source, community-driven Linux distribution, 1:1 binary compatible with RHEL. A free alternative to CentOS.",
17 | "install_methods": [
18 | {
19 | "type": "default",
20 | "script": "ct/almalinux.sh",
21 | "resources": {
22 | "cpu": 1,
23 | "ram": 512,
24 | "hdd": 4,
25 | "os": "almalinux",
26 | "version": "10"
27 | }
28 | }
29 | ],
30 | "default_credentials": {
31 | "username": "root",
32 | "password": null
33 | },
34 | "notes": []
35 | }
36 |
--------------------------------------------------------------------------------
/frontend/public/json/debian.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "Debian",
3 | "slug": "debian",
4 | "categories": [
5 | 0
6 | ],
7 | "date_created": "2025-12-04",
8 | "type": "ct",
9 | "updateable": true,
10 | "privileged": false,
11 | "interface_port": null,
12 | "documentation": "https://www.debian.org/doc/",
13 | "website": "https://www.debian.org/",
14 | "logo": "https://cdn.jsdelivr.net/gh/selfhst/icons@main/webp/debian.webp",
15 | "config_path": "",
16 | "description": "Debian is a free operating system (OS) that comes with over 59000 packages. It's known for its stability, security, and extensive software repository.",
17 | "install_methods": [
18 | {
19 | "type": "default",
20 | "script": "ct/debian.sh",
21 | "resources": {
22 | "cpu": 1,
23 | "ram": 512,
24 | "hdd": 4,
25 | "os": "debian",
26 | "version": "13"
27 | }
28 | }
29 | ],
30 | "default_credentials": {
31 | "username": "root",
32 | "password": null
33 | },
34 | "notes": []
35 | }
36 |
--------------------------------------------------------------------------------
/frontend/public/json/fedora.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "Fedora",
3 | "slug": "fedora",
4 | "categories": [
5 | 0
6 | ],
7 | "date_created": "2025-12-04",
8 | "type": "ct",
9 | "updateable": true,
10 | "privileged": false,
11 | "interface_port": null,
12 | "documentation": "https://docs.fedoraproject.org/",
13 | "website": "https://fedoraproject.org/",
14 | "logo": "https://cdn.jsdelivr.net/gh/selfhst/icons@main/webp/fedora.webp",
15 | "config_path": "",
16 | "description": "Fedora is a cutting-edge Linux distribution sponsored by Red Hat. It features the latest software and technologies while maintaining stability.",
17 | "install_methods": [
18 | {
19 | "type": "default",
20 | "script": "ct/fedora.sh",
21 | "resources": {
22 | "cpu": 1,
23 | "ram": 512,
24 | "hdd": 4,
25 | "os": "fedora",
26 | "version": "42"
27 | }
28 | }
29 | ],
30 | "default_credentials": {
31 | "username": "root",
32 | "password": null
33 | },
34 | "notes": []
35 | }
36 |
--------------------------------------------------------------------------------
/frontend/public/json/opensuse.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "openSUSE",
3 | "slug": "opensuse",
4 | "categories": [
5 | 0
6 | ],
7 | "date_created": "2025-12-04",
8 | "type": "ct",
9 | "updateable": true,
10 | "privileged": false,
11 | "interface_port": null,
12 | "documentation": "https://doc.opensuse.org/",
13 | "website": "https://www.opensuse.org/",
14 | "logo": "https://cdn.jsdelivr.net/gh/selfhst/icons@main/webp/opensuse.webp",
15 | "config_path": "",
16 | "description": "openSUSE is a stable, easy-to-use, and complete Linux distribution. Known for its YaST configuration tool and zypper package manager.",
17 | "install_methods": [
18 | {
19 | "type": "default",
20 | "script": "ct/opensuse.sh",
21 | "resources": {
22 | "cpu": 1,
23 | "ram": 512,
24 | "hdd": 4,
25 | "os": "opensuse",
26 | "version": "15.6"
27 | }
28 | }
29 | ],
30 | "default_credentials": {
31 | "username": "root",
32 | "password": null
33 | },
34 | "notes": []
35 | }
36 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | MIT License
2 |
3 | Copyright (c) 2021-2025 tteck | community-scripts ORG
4 |
5 | Permission is hereby granted, free of charge, to any person obtaining a copy
6 | of this software and associated documentation files (the "Software"), to deal
7 | in the Software without restriction, including without limitation the rights
8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 |
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 |
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.
22 |
--------------------------------------------------------------------------------
/frontend/public/json/openeuler.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "openEuler",
3 | "slug": "openeuler",
4 | "categories": [
5 | 0
6 | ],
7 | "date_created": "2025-12-04",
8 | "type": "ct",
9 | "updateable": true,
10 | "privileged": false,
11 | "interface_port": null,
12 | "documentation": "https://docs.openeuler.org/",
13 | "website": "https://www.openeuler.org/",
14 | "logo": "https://cdn.jsdelivr.net/gh/selfhst/icons@main/webp/openeuler.webp",
15 | "config_path": "",
16 | "description": "openEuler is an open-source Linux distribution from Huawei. It's designed for servers and cloud computing with enterprise-grade features.",
17 | "install_methods": [
18 | {
19 | "type": "default",
20 | "script": "ct/openeuler.sh",
21 | "resources": {
22 | "cpu": 1,
23 | "ram": 512,
24 | "hdd": 4,
25 | "os": "openeuler",
26 | "version": "25.03"
27 | }
28 | }
29 | ],
30 | "default_credentials": {
31 | "username": "root",
32 | "password": null
33 | },
34 | "notes": []
35 | }
36 |
--------------------------------------------------------------------------------
/frontend/public/json/rockylinux.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "Rocky Linux",
3 | "slug": "rockylinux",
4 | "categories": [
5 | 0
6 | ],
7 | "date_created": "2025-12-04",
8 | "type": "ct",
9 | "updateable": true,
10 | "privileged": false,
11 | "interface_port": null,
12 | "documentation": "https://docs.rockylinux.org/",
13 | "website": "https://rockylinux.org/",
14 | "logo": "https://cdn.jsdelivr.net/gh/selfhst/icons@main/webp/rocky-linux.webp",
15 | "config_path": "",
16 | "description": "Rocky Linux is an enterprise-grade Linux distribution designed to be 100% bug-for-bug compatible with Red Hat Enterprise Linux (RHEL).",
17 | "install_methods": [
18 | {
19 | "type": "default",
20 | "script": "ct/rockylinux.sh",
21 | "resources": {
22 | "cpu": 1,
23 | "ram": 512,
24 | "hdd": 4,
25 | "os": "rockylinux",
26 | "version": "10"
27 | }
28 | }
29 | ],
30 | "default_credentials": {
31 | "username": "root",
32 | "password": null
33 | },
34 | "notes": []
35 | }
36 |
--------------------------------------------------------------------------------
/.github/ISSUE_TEMPLATE/new-script.yaml:
--------------------------------------------------------------------------------
1 | ---
2 | name: 🛠️ New Script
3 | description: New Script proposal.
4 | labels: [task]
5 | body:
6 | - type: markdown
7 | attributes:
8 | value: |
9 | # 🛠️ **New Script**
10 | Create an Issue when you want to merge a new Script. The name of the Issue must be the same as your APP.sh file. (Example: SnipeIT, snipeit.sh; Alpine-Docker, alpine-docker.sh)
11 | - type: input
12 | id: task_summary
13 | attributes:
14 | label: Name of the Script
15 | placeholder: e.g., SnipeIT
16 | validations:
17 | required: true
18 | - type: dropdown
19 | id: script_type
20 | attributes:
21 | label: Script Type
22 | description: What type of script is this?
23 | options:
24 | - CT (LXC Container)
25 | - VM (Virtual Machine)
26 | - Addon (tools/addon)
27 | - PVE Tool (tools/pve)
28 | validations:
29 | required: true
30 | - type: textarea
31 | id: task_details
32 | attributes:
33 | label: 📋 Script Details
34 | placeholder: Explain what is needed or special about this script
35 | validations:
36 | required: true
37 |
--------------------------------------------------------------------------------
/frontend/public/json/alpine.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "Alpine Linux",
3 | "slug": "alpine",
4 | "categories": [
5 | 0
6 | ],
7 | "date_created": "2025-12-04",
8 | "type": "ct",
9 | "updateable": true,
10 | "privileged": false,
11 | "interface_port": null,
12 | "documentation": "https://wiki.alpinelinux.org/",
13 | "website": "https://alpinelinux.org/",
14 | "logo": "https://cdn.jsdelivr.net/gh/selfhst/icons@main/webp/alpine-linux.webp",
15 | "config_path": "",
16 | "description": "Alpine Linux is a security-oriented, lightweight Linux distribution based on musl libc and busybox. Perfect for containers due to its minimal footprint.",
17 | "install_methods": [
18 | {
19 | "type": "default",
20 | "script": "ct/alpine.sh",
21 | "resources": {
22 | "cpu": 1,
23 | "ram": 512,
24 | "hdd": 1,
25 | "os": "alpine",
26 | "version": "3.22"
27 | }
28 | }
29 | ],
30 | "default_credentials": {
31 | "username": "root",
32 | "password": null
33 | },
34 | "notes": []
35 | }
36 |
--------------------------------------------------------------------------------
/ct/fedora.sh:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env bash
2 | source <(curl -fsSL https://git.community-scripts.org/community-scripts/ProxmoxVED/raw/branch/main/misc/build.func)
3 | # Copyright (c) 2021-2025 community-scripts ORG
4 | # Author: MickLesk (CanbiZ)
5 | # License: MIT | https://github.com/community-scripts/ProxmoxVED/raw/main/LICENSE
6 | # Source: https://fedoraproject.org/
7 |
8 | APP="Fedora"
9 | var_tags="${var_tags:-os}"
10 | var_cpu="${var_cpu:-1}"
11 | var_ram="${var_ram:-512}"
12 | var_disk="${var_disk:-4}"
13 | var_os="${var_os:-fedora}"
14 | var_version="${var_version:-42}"
15 | var_unprivileged="${var_unprivileged:-1}"
16 |
17 | header_info "$APP"
18 | variables
19 | color
20 | catch_errors
21 |
22 | function update_script() {
23 | header_info
24 | check_container_storage
25 | check_container_resources
26 | if [[ ! -d /var ]]; then
27 | msg_error "No ${APP} Installation Found!"
28 | exit
29 | fi
30 | msg_info "Updating $APP LXC"
31 | $STD dnf -y upgrade
32 | msg_ok "Updated $APP LXC"
33 | exit
34 | }
35 |
36 | start
37 | build_container
38 | description
39 |
40 | msg_ok "Completed Successfully!"
41 | msg_custom "🚀" "${GN}" "${APP} setup has been successfully initialized!"
42 |
--------------------------------------------------------------------------------
/frontend/public/json/rybbit.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "Rybbit",
3 | "slug": "rybbit",
4 | "categories": [
5 | 9
6 | ],
7 | "date_created": "2025-01-15",
8 | "type": "ct",
9 | "updateable": true,
10 | "privileged": false,
11 | "interface_port": 3000,
12 | "documentation": "https://github.com/rybbit-io/rybbit",
13 | "website": "https://github.com/rybbit-io/rybbit",
14 | "logo": "https://cdn.jsdelivr.net/gh/selfhst/icons@main/webp/rybbit-light.webp",
15 | "config_path": "/opt/rybbit",
16 | "description": "Rybbit is a privacy-focused, open-source web analytics platform. Track your website visitors without compromising their privacy or using cookies.",
17 | "install_methods": [
18 | {
19 | "type": "default",
20 | "script": "ct/rybbit.sh",
21 | "resources": {
22 | "cpu": 2,
23 | "ram": 2048,
24 | "hdd": 5,
25 | "os": "debian",
26 | "version": "13"
27 | }
28 | }
29 | ],
30 | "default_credentials": {
31 | "username": null,
32 | "password": null
33 | },
34 | "notes": []
35 | }
36 |
--------------------------------------------------------------------------------
/ct/almalinux.sh:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env bash
2 | source <(curl -fsSL https://git.community-scripts.org/community-scripts/ProxmoxVED/raw/branch/main/misc/build.func)
3 | # Copyright (c) 2021-2025 community-scripts ORG
4 | # Author: MickLesk (CanbiZ)
5 | # License: MIT | https://github.com/community-scripts/ProxmoxVED/raw/main/LICENSE
6 | # Source: https://almalinux.org/
7 |
8 | APP="AlmaLinux"
9 | var_tags="${var_tags:-os}"
10 | var_cpu="${var_cpu:-1}"
11 | var_ram="${var_ram:-512}"
12 | var_disk="${var_disk:-4}"
13 | var_os="${var_os:-almalinux}"
14 | var_version="${var_version:-10}"
15 | var_unprivileged="${var_unprivileged:-1}"
16 |
17 | header_info "$APP"
18 | variables
19 | color
20 | catch_errors
21 |
22 | function update_script() {
23 | header_info
24 | check_container_storage
25 | check_container_resources
26 | if [[ ! -d /var ]]; then
27 | msg_error "No ${APP} Installation Found!"
28 | exit
29 | fi
30 | msg_info "Updating $APP LXC"
31 | $STD dnf -y upgrade
32 | msg_ok "Updated $APP LXC"
33 | exit
34 | }
35 |
36 | start
37 | build_container
38 | description
39 |
40 | msg_ok "Completed Successfully!"
41 | msg_custom "🚀" "${GN}" "${APP} setup has been successfully initialized!"
42 |
--------------------------------------------------------------------------------
/ct/opensuse.sh:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env bash
2 | source <(curl -fsSL https://git.community-scripts.org/community-scripts/ProxmoxVED/raw/branch/main/misc/build.func)
3 | # Copyright (c) 2021-2025 community-scripts ORG
4 | # Author: MickLesk (CanbiZ)
5 | # License: MIT | https://github.com/community-scripts/ProxmoxVED/raw/main/LICENSE
6 | # Source: https://www.opensuse.org/
7 |
8 | APP="openSUSE"
9 | var_tags="${var_tags:-os}"
10 | var_cpu="${var_cpu:-1}"
11 | var_ram="${var_ram:-512}"
12 | var_disk="${var_disk:-4}"
13 | var_os="${var_os:-opensuse}"
14 | var_version="${var_version:-15.6}"
15 | var_unprivileged="${var_unprivileged:-1}"
16 |
17 | header_info "$APP"
18 | variables
19 | color
20 | catch_errors
21 |
22 | function update_script() {
23 | header_info
24 | check_container_storage
25 | check_container_resources
26 | if [[ ! -d /var ]]; then
27 | msg_error "No ${APP} Installation Found!"
28 | exit
29 | fi
30 | msg_info "Updating $APP LXC"
31 | $STD zypper -n update
32 | msg_ok "Updated $APP LXC"
33 | exit
34 | }
35 |
36 | start
37 | build_container
38 | description
39 |
40 | msg_ok "Completed Successfully!"
41 | msg_custom "🚀" "${GN}" "${APP} setup has been successfully initialized!"
42 |
--------------------------------------------------------------------------------
/ct/rockylinux.sh:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env bash
2 | source <(curl -fsSL https://git.community-scripts.org/community-scripts/ProxmoxVED/raw/branch/main/misc/build.func)
3 | # Copyright (c) 2021-2025 community-scripts ORG
4 | # Author: MickLesk (CanbiZ)
5 | # License: MIT | https://github.com/community-scripts/ProxmoxVED/raw/main/LICENSE
6 | # Source: https://rockylinux.org/
7 |
8 | APP="Rocky Linux"
9 | var_tags="${var_tags:-os}"
10 | var_cpu="${var_cpu:-1}"
11 | var_ram="${var_ram:-512}"
12 | var_disk="${var_disk:-4}"
13 | var_os="${var_os:-rockylinux}"
14 | var_version="${var_version:-10}"
15 | var_unprivileged="${var_unprivileged:-1}"
16 |
17 | header_info "$APP"
18 | variables
19 | color
20 | catch_errors
21 |
22 | function update_script() {
23 | header_info
24 | check_container_storage
25 | check_container_resources
26 | if [[ ! -d /var ]]; then
27 | msg_error "No ${APP} Installation Found!"
28 | exit
29 | fi
30 | msg_info "Updating $APP LXC"
31 | $STD dnf -y upgrade
32 | msg_ok "Updated $APP LXC"
33 | exit
34 | }
35 |
36 | start
37 | build_container
38 | description
39 |
40 | msg_ok "Completed Successfully!"
41 | msg_custom "🚀" "${GN}" "${APP} setup has been successfully initialized!"
42 |
--------------------------------------------------------------------------------
/ct/openeuler.sh:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env bash
2 | source <(curl -fsSL https://git.community-scripts.org/community-scripts/ProxmoxVED/raw/branch/main/misc/build.func)
3 | # Copyright (c) 2021-2025 community-scripts ORG
4 | # Author: MickLesk (CanbiZ)
5 | # License: MIT | https://github.com/community-scripts/ProxmoxVED/raw/main/LICENSE
6 | # Source: https://www.openeuler.org/
7 |
8 | APP="openEuler"
9 | var_tags="${var_tags:-os}"
10 | var_cpu="${var_cpu:-1}"
11 | var_ram="${var_ram:-512}"
12 | var_disk="${var_disk:-4}"
13 | var_os="${var_os:-openeuler}"
14 | var_version="${var_version:-25.03}"
15 | var_unprivileged="${var_unprivileged:-1}"
16 |
17 | header_info "$APP"
18 | variables
19 | color
20 | catch_errors
21 |
22 | function update_script() {
23 | header_info
24 | check_container_storage
25 | check_container_resources
26 | if [[ ! -d /var ]]; then
27 | msg_error "No ${APP} Installation Found!"
28 | exit
29 | fi
30 | msg_info "Updating $APP LXC"
31 | $STD dnf -y upgrade
32 | msg_ok "Updated $APP LXC"
33 | exit
34 | }
35 |
36 | start
37 | build_container
38 | description
39 |
40 | msg_ok "Completed Successfully!"
41 | msg_custom "🚀" "${GN}" "${APP} setup has been successfully initialized!"
42 |
--------------------------------------------------------------------------------
/ct/centos.sh:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env bash
2 | source <(curl -fsSL https://git.community-scripts.org/community-scripts/ProxmoxVED/raw/branch/main/misc/build.func)
3 | # Copyright (c) 2021-2025 community-scripts ORG
4 | # Author: MickLesk (CanbiZ)
5 | # License: MIT | https://github.com/community-scripts/ProxmoxVED/raw/main/LICENSE
6 | # Source: https://www.centos.org/centos-stream/
7 |
8 | APP="CentOS Stream"
9 | var_tags="${var_tags:-os}"
10 | var_cpu="${var_cpu:-1}"
11 | var_ram="${var_ram:-512}"
12 | var_disk="${var_disk:-4}"
13 | var_os="${var_os:-centos}"
14 | var_version="${var_version:-9}"
15 | var_unprivileged="${var_unprivileged:-1}"
16 |
17 | header_info "$APP"
18 | variables
19 | color
20 | catch_errors
21 |
22 | function update_script() {
23 | header_info
24 | check_container_storage
25 | check_container_resources
26 | if [[ ! -d /var ]]; then
27 | msg_error "No ${APP} Installation Found!"
28 | exit
29 | fi
30 | msg_info "Updating $APP LXC"
31 | $STD dnf -y upgrade
32 | msg_ok "Updated $APP LXC"
33 | exit
34 | }
35 |
36 | start
37 | build_container
38 | description
39 |
40 | msg_ok "Completed Successfully!"
41 | msg_custom "🚀" "${GN}" "${APP} setup has been successfully initialized!"
42 |
--------------------------------------------------------------------------------
/frontend/public/json/romm.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "RomM",
3 | "slug": "romm",
4 | "categories": [
5 | 24
6 | ],
7 | "date_created": "2025-03-10",
8 | "type": "ct",
9 | "updateable": true,
10 | "privileged": false,
11 | "interface_port": 8080,
12 | "documentation": "https://docs.romm.app/latest/",
13 | "website": "https://romm.app/",
14 | "config_path": "/opt",
15 | "logo": "https://cdn.jsdelivr.net/gh/selfhst/icons@main/webp/romm.webp",
16 | "description": "RomM (ROM Manager) allows you to scan, enrich, browse and play your game collection with a clean and responsive interface. Support for multiple platforms, various naming schemes, and custom tags.",
17 | "install_methods": [
18 | {
19 | "type": "default",
20 | "script": "ct/romm.sh",
21 | "resources": {
22 | "cpu": 2,
23 | "ram": 4096,
24 | "hdd": 20,
25 | "os": "ubuntu",
26 | "version": "24.04"
27 | }
28 | }
29 | ],
30 | "default_credentials": {
31 | "username": "romm",
32 | "password": "changeme"
33 | },
34 | "notes": []
35 | }
36 |
--------------------------------------------------------------------------------
/install/byparr-install.sh:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env bash
2 |
3 | # Copyright (c) 2021-2025 community-scripts ORG
4 | # Author: luismco
5 | # License: MIT | https://github.com/community-scripts/ProxmoxVE/raw/main/LICENSE
6 | # Source: https://github.com/ThePhaseless/Byparr
7 |
8 | source /dev/stdin <<<"$FUNCTIONS_FILE_PATH"
9 | color
10 | verb_ip6
11 | catch_errors
12 | setting_up_container
13 | network_check
14 | update_os
15 |
16 | msg_info "Installing Dependencies"
17 | $STD apt -y install \
18 | xauth \
19 | xvfb \
20 | scrot \
21 | chromium \
22 | chromium-driver \
23 | ca-certificates
24 | msg_ok "Installed Dependencies"
25 |
26 | fetch_and_deploy_gh_release "Byparr" "ThePhaseless/Byparr"
27 | setup_uv
28 |
29 | msg_info "Creating Service"
30 | cat <
18 |
32 | ))}
33 |
34 | );
35 | }
36 |
--------------------------------------------------------------------------------
/frontend/public/json/devuan.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "Devuan",
3 | "slug": "devuan",
4 | "categories": [
5 | 0
6 | ],
7 | "date_created": "2025-12-04",
8 | "type": "ct",
9 | "updateable": true,
10 | "privileged": false,
11 | "interface_port": null,
12 | "documentation": "https://www.devuan.org/os/documentation",
13 | "website": "https://www.devuan.org/",
14 | "logo": "https://cdn.jsdelivr.net/gh/selfhst/icons@main/webp/devuan.webp",
15 | "config_path": "",
16 | "description": "Devuan is a fork of Debian without systemd. It uses sysvinit and other alternative init systems, providing freedom of choice.",
17 | "install_methods": [
18 | {
19 | "type": "default",
20 | "script": "ct/devuan.sh",
21 | "resources": {
22 | "cpu": 1,
23 | "ram": 512,
24 | "hdd": 4,
25 | "os": "devuan",
26 | "version": "5.0"
27 | }
28 | }
29 | ],
30 | "default_credentials": {
31 | "username": "root",
32 | "password": null
33 | },
34 | "notes": [
35 | {
36 | "text": "Devuan uses sysvinit instead of systemd.",
37 | "type": "info"
38 | }
39 | ]
40 | }
41 |
--------------------------------------------------------------------------------
/frontend/src/components/ui/switch.tsx:
--------------------------------------------------------------------------------
1 | "use client"
2 |
3 | import * as React from "react"
4 | import * as SwitchPrimitives from "@radix-ui/react-switch"
5 |
6 | import { cn } from "@/lib/utils"
7 |
8 | const Switch = React.forwardRef<
9 | React.ElementRef
24 | {note.type == "info" ? (
25 |
37 | Proxmox® is a registered trademark of Proxmox Server Solutions GmbH. 38 |
39 | -------------------------------------------------------------------------------- /frontend/src/app/scripts/_components/Sidebar.tsx: -------------------------------------------------------------------------------- 1 | "use client"; 2 | 3 | import type { Category, Script } from "@/lib/types"; 4 | import ScriptAccordion from "./ScriptAccordion"; 5 | 6 | const Sidebar = ({ 7 | items, 8 | selectedScript, 9 | setSelectedScript, 10 | }: { 11 | items: Category[]; 12 | selectedScript: string | null; 13 | setSelectedScript: (script: string | null) => void; 14 | }) => { 15 | const filteredItems = items.filter(category => category.scripts && category.scripts.length > 0); 16 | 17 | const uniqueScripts = filteredItems.reduce((acc, category) => { 18 | for (const script of category.scripts) { 19 | if (!acc.some((s) => s.name === script.name)) { 20 | acc.push(script); 21 | } 22 | } 23 | return acc; 24 | }, [] as Script[]); 25 | 26 | return ( 27 |
28 |
42 | );
43 | };
44 |
45 | export default Sidebar;
46 |
--------------------------------------------------------------------------------
/frontend/src/components/ui/badge.tsx:
--------------------------------------------------------------------------------
1 | import { cva, type VariantProps } from "class-variance-authority";
2 | import * as React from "react";
3 |
4 | import { cn } from "@/lib/utils";
5 |
6 | const badgeVariants = cva(
7 | "inline-flex items-center rounded-full border px-1.5 py-0.1 text-xs font-semibold transition-colors focus:outline-none focus:ring-2 focus:ring-ring focus:ring-offset-2",
8 | {
9 | variants: {
10 | variant: {
11 | default:
12 | "border-transparent text-primary-foreground border-primary-foreground",
13 | secondary:
14 | "border-transparent text-secondary-foreground border-secondary-foreground",
15 | destructive:
16 | "border-transparent text-destructive-foreground border-destructive-foreground",
17 | outline: "text-foreground",
18 | success: "text-green-500 border-green-500",
19 | warning: "text-yellow-500 border-yellow-500",
20 | failure: "text-red-500 border-red-500",
21 | },
22 | },
23 | defaultVariants: {
24 | variant: "default",
25 | },
26 | },
27 | );
28 |
29 | export interface BadgeProps
30 | extends React.HTMLAttributes
29 |
34 | Categories
30 |31 | {uniqueScripts.length} Total scripts 32 |
33 |
35 |
41 |
10 |
15 | );
16 | };
17 |
18 | const defaultSettings = item.install_methods.find((method) => method.type === "default");
19 | const defaultAlpineSettings = item.install_methods.find((method) => method.type === "alpine");
20 |
21 | const hasDefaultSettings = defaultSettings?.resources && Object.values(defaultSettings.resources).some(Boolean);
22 |
23 | return (
24 | {title}
11 |CPU: {cpu}vCPU
12 |RAM: {getDisplayValueFromRAM(ram ?? 0)}
13 |HDD: {hdd}GB
14 |
25 | {hasDefaultSettings &&
28 | );
29 | }
30 |
--------------------------------------------------------------------------------
/frontend/src/lib/types.ts:
--------------------------------------------------------------------------------
1 | import { AlertColors } from "@/config/siteConfig";
2 |
3 | export type Script = {
4 | name: string;
5 | slug: string;
6 | categories: number[];
7 | date_created: string;
8 | type: "vm" | "ct" | "pve" | "addon";
9 | updateable: boolean;
10 | privileged: boolean;
11 | interface_port: number | null;
12 | documentation: string | null;
13 | website: string | null;
14 | logo: string | null;
15 | description: string;
16 | config_path: string | null;
17 | install_methods: {
18 | type: "default" | "alpine";
19 | script: string;
20 | resources: {
21 | cpu: number | null;
22 | ram: number | null;
23 | hdd: number | null;
24 | os: string | null;
25 | version: string | null;
26 | };
27 | }[];
28 | default_credentials: {
29 | username: string | null;
30 | password: string | null;
31 | };
32 | notes: [
33 | {
34 | text: string;
35 | type: keyof typeof AlertColors;
36 | },
37 | ];
38 | };
39 |
40 | export type Category = {
41 | name: string;
42 | id: number;
43 | sort_order: number;
44 | scripts: Script[];
45 | };
46 |
47 | export type Metadata = {
48 | categories: Category[];
49 | };
50 |
51 | export interface Version {
52 | name: string;
53 | slug: string;
54 | }
55 |
56 | export interface OperatingSystem {
57 | name: string;
58 | versions: Version[];
59 | }
60 |
61 | export interface AppVersion {
62 | name: string;
63 | version: string;
64 | date: Date;
65 | }
66 |
--------------------------------------------------------------------------------
/ct/alpine-ntfy.sh:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env bash
2 | source <(curl -fsSL https://raw.githubusercontent.com/community-scripts/ProxmoxVED/main/misc/build.func)
3 | # Copyright (c) 2021-2025 community-scripts ORG
4 | # Author: cobalt (cobaltgit)
5 | # License: MIT | https://github.com/community-scripts/ProxmoxVED/raw/main/LICENSE
6 | # Source: https://ntfy.sh/
7 |
8 | APP="Alpine-ntfy"
9 | var_tags="${var_tags:-notification}"
10 | var_cpu="${var_cpu:-1}"
11 | var_ram="${var_ram:-256}"
12 | var_disk="${var_disk:-2}"
13 | var_os="${var_os:-alpine}"
14 | var_version="${var_version:-3.22}"
15 | var_unprivileged="${var_unprivileged:-1}"
16 |
17 | header_info "$APP"
18 | variables
19 | color
20 | catch_errors
21 |
22 | function update_script() {
23 | header_info
24 | check_container_storage
25 | check_container_resources
26 | if [[ ! -d /etc/ntfy ]]; then
27 | msg_error "No ${APP} Installation Found!"
28 | exit
29 | fi
30 | msg_info "Updating $APP LXC"
31 | $STD apk -U upgrade
32 | setcap 'cap_net_bind_service=+ep' /usr/bin/ntfy
33 | msg_ok "Updated $APP LXC"
34 |
35 | msg_info "Restarting ntfy"
36 | rc-service ntfy restart
37 | msg_ok "Restarted ntfy"
38 | exit
39 | }
40 |
41 | start
42 | build_container
43 | description
44 |
45 | msg_ok "Completed Successfully!\n"
46 | echo -e "${CREATING}${GN}${APP} setup has been successfully initialized!${CL}"
47 | echo -e "${INFO}${YW} Access it using the following URL:${CL}"
48 | echo -e "${TAB}${GATEWAY}${BGN}http://${IP}${CL}"
49 |
--------------------------------------------------------------------------------
/frontend/public/json/pihole-exporter.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "Pi-Hole Exporter",
3 | "slug": "pihole-exporter",
4 | "categories": [
5 | 9
6 | ],
7 | "date_created": "2025-12-08",
8 | "type": "addon",
9 | "updateable": true,
10 | "privileged": false,
11 | "interface_port": 9617,
12 | "documentation": "https://github.com/eko/pihole-exporter",
13 | "website": "https://github.com/eko/pihole-exporter",
14 | "logo": "https://cdn.jsdelivr.net/gh/selfhst/icons@main/webp/pi-hole.webp",
15 | "config_path": "/opt/pihole-exporter.env",
16 | "description": "A Prometheus exporter for PI-Hole's Raspberry PI ad blocker",
17 | "install_methods": [
18 | {
19 | "type": "default",
20 | "script": "tools/addon/pihole-exporter.sh",
21 | "resources": {
22 | "cpu": null,
23 | "ram": null,
24 | "hdd": null,
25 | "os": null,
26 | "version": null
27 | }
28 | },
29 | {
30 | "type": "alpine",
31 | "script": "tools/addon/pihole-exporter.sh",
32 | "resources": {
33 | "cpu": null,
34 | "ram": null,
35 | "hdd": null,
36 | "os": null,
37 | "version": null
38 | }
39 | }
40 | ],
41 | "default_credentials": {
42 | "username": null,
43 | "password": null
44 | },
45 | "notes": []
46 | }
47 |
--------------------------------------------------------------------------------
/frontend/src/app/api/versions/route.ts:
--------------------------------------------------------------------------------
1 | import { AppVersion } from "@/lib/types";
2 | import { error } from "console";
3 | import { promises as fs } from "fs";
4 | // import Error from "next/error";
5 | import { NextResponse } from "next/server";
6 | import path from "path";
7 |
8 | export const dynamic = "force-static";
9 |
10 | const jsonDir = "public/json";
11 | const versionsFileName = "versions.json";
12 | const encoding = "utf-8";
13 |
14 | const getVersions = async () => {
15 | const filePath = path.resolve(jsonDir, versionsFileName);
16 | const fileContent = await fs.readFile(filePath, encoding);
17 | const versions: AppVersion[] = JSON.parse(fileContent);
18 | console.log("Versions: ", versions);
19 | const modifiedVersions = versions.map(version => {
20 | let newName = version.name;
21 | // Ensure date is included in the returned object
22 | newName = newName.toLowerCase().replace(/[^a-z0-9/]/g, '');
23 | return { ...version, name: newName};
24 | });
25 |
26 | return modifiedVersions;
27 | };
28 |
29 | export async function GET() {
30 | try {
31 |
32 | const versions = await getVersions();
33 | return NextResponse.json(versions);
34 |
35 | } catch (error) {
36 | console.error(error);
37 | const err = error as globalThis.Error;
38 | return NextResponse.json({
39 | name: err.name,
40 | message: err.message || "An unexpected error occurred",
41 | version: "No version found - Error"
42 | }, {
43 | status: 500,
44 | });
45 | }
46 | }
47 |
--------------------------------------------------------------------------------
/ct/deferred/pixelfed.sh:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env bash
2 | source <(curl -fsSL https://git.community-scripts.org/community-scripts/ProxmoxVED/raw/branch/main/misc/build.func)
3 | # Copyright (c) 2021-2025 community-scripts ORG
4 | # Author: MickLesk (Canbiz)
5 | # License: MIT | https://github.com/community-scripts/ProxmoxVE/raw/main/LICENSE
6 | # Source:
7 |
8 | APP="Pixelfed"
9 | var_tags="${var_tags:-pictures}"
10 | var_disk="${var_disk:-7}"
11 | var_cpu="${var_cpu:-2}"
12 | var_ram="${var_ram:-2048}"
13 | var_os="${var_os:-debian}"
14 | var_version="${var_version:-12}"
15 |
16 | header_info "$APP"
17 | variables
18 | color
19 | catch_errors
20 |
21 | function update_script() {
22 | header_info
23 | check_container_storage
24 | check_container_resources
25 | if [[ ! -d /opt/pixelfed ]]; then
26 | msg_error "No ${APP} Installation Found!"
27 | exit
28 | fi
29 | RELEASE=$(curl -fsSL https://api.github.com/repos/xxxx/xxxx/releases/latest | grep "tag_name" | awk '{print substr($2, 2, length($2)-3) }')
30 | if [[ ! -f /opt/${APP}_version.txt ]] || [[ "${RELEASE}" != "$(cat /opt/${APP}_version.txt)" ]]; then
31 | msg_info "Updating ${APP} to ${RELEASE}"
32 | cd /opt
33 | else
34 | msg_ok "No update required. ${APP} is already at ${RELEASE}"
35 | fi
36 | exit
37 | }
38 |
39 | start
40 | build_container
41 | description
42 |
43 | msg_ok "Completed Successfully!\n"
44 | echo -e "${APP} Setup should be reachable by going to the following URL.
45 | ${BL}http://${IP}:8000${CL} \n"
46 |
--------------------------------------------------------------------------------
/install/heimdall-dashboard-install.sh:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env bash
2 |
3 | # Copyright (c) 2021-2025 tteck
4 | # Author: tteck (tteckster)
5 | # License: MIT | https://github.com/community-scripts/ProxmoxVE/raw/main/LICENSE
6 | # Source: https://heimdall.site/
7 |
8 | source /dev/stdin <<<"$FUNCTIONS_FILE_PATH"
9 | color
10 | verb_ip6
11 | catch_errors
12 | setting_up_container
13 | network_check
14 | update_os
15 |
16 | msg_info "Installing Dependencies"
17 | $STD apt install -y apt-transport-https
18 | msg_ok "Installed Dependencies"
19 |
20 | PHP_VERSION="8.4" PHP_MODULE="bz2,sqlite3" PHP_FPM="YES" setup_php
21 | setup_composer
22 | fetch_and_deploy_gh_release "Heimdall" "linuxserver/Heimdall" "tarball"
23 |
24 | msg_info "Setting up Heimdall-Dashboard"
25 | cd /opt/Heimdall
26 | cp .env.example .env
27 | $STD php artisan key:generate
28 | msg_ok "Setup Heimdall-Dashboard"
29 |
30 | msg_info "Creating Service"
31 | cat <
34 | {title}
35 |
41 | );
42 | }
43 |
--------------------------------------------------------------------------------
/frontend/public/json/qbittorrent-exporter.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "qbittorrent Exporter",
3 | "slug": "qbittorrent-exporter",
4 | "categories": [
5 | 9
6 | ],
7 | "date_created": "2025-11-21",
8 | "type": "addon",
9 | "updateable": true,
10 | "privileged": false,
11 | "interface_port": 8090,
12 | "documentation": "https://github.com/martabal/qbittorrent-exporter",
13 | "website": "https://github.com/martabal/qbittorrent-exporter",
14 | "logo": "https://cdn.jsdelivr.net/gh/selfhst/icons@main/webp/qbittorrent.webp",
15 | "config_path": "/opt/qbittorrent-exporter.env",
16 | "description": "A fast and lightweight prometheus exporter for qBittorrent ",
17 | "install_methods": [
18 | {
19 | "type": "default",
20 | "script": "tools/addon/qbittorrent-exporter.sh",
21 | "resources": {
22 | "cpu": null,
23 | "ram": null,
24 | "hdd": null,
25 | "os": null,
26 | "version": null
27 | }
28 | },
29 | {
30 | "type": "alpine",
31 | "script": "tools/addon/qbittorrent-exporter.sh",
32 | "resources": {
33 | "cpu": null,
34 | "ram": null,
35 | "hdd": null,
36 | "os": null,
37 | "version": null
38 | }
39 | }
40 | ],
41 | "default_credentials": {
42 | "username": null,
43 | "password": null
44 | },
45 | "notes": []
46 | }
47 |
--------------------------------------------------------------------------------
/frontend/src/components/ui/theme-toggle.tsx:
--------------------------------------------------------------------------------
1 | "use client";
2 |
3 | import { MoonIcon, SunIcon } from "@radix-ui/react-icons";
4 | import { useTheme } from "next-themes";
5 | import { Button } from "./button";
6 | import {
7 | Tooltip,
8 | TooltipContent,
9 | TooltipProvider,
10 | TooltipTrigger,
11 | } from "./tooltip";
12 |
13 | export function ThemeToggle() {
14 | const { setTheme, theme: currentTheme } = useTheme();
15 |
16 | const handleChangeTheme = (theme: "light" | "dark") => {
17 | if (theme === currentTheme) return;
18 |
19 | if (!document.startViewTransition) return setTheme(theme);
20 | document.startViewTransition(() => setTheme(theme));
21 | };
22 |
23 | return (
24 |
36 | {hasCPU &&
40 |
18 |
36 | );
37 | }
38 |
--------------------------------------------------------------------------------
/frontend/src/components/FAQ.tsx:
--------------------------------------------------------------------------------
1 | import * as AccordionPrimitive from "@radix-ui/react-accordion";
2 | import { Plus } from "lucide-react";
3 | import { FAQ_Items } from "../config/faqConfig";
4 | import { Accordion, AccordionContent, AccordionItem } from "./ui/accordion";
5 |
6 | export default function FAQ() {
7 | return (
8 |
19 |
21 | Default Login Credentials
20 |
23 |
35 | 24 | You can use the following credentials to login to the {item.name} {item.type}. 25 |
26 | {["username", "password"].map((type) => ( 27 |
28 | {type.charAt(0).toUpperCase() + type.slice(1)}:{" "}
29 |
32 |
33 | ))}
34 |
9 |
10 | {FAQ_Items.map((item, index) => (
11 |
12 |
13 |
14 | {item.title}
15 |
21 |
22 |
23 | {item.content}
24 |
25 | ))}
26 |
27 |
28 | );
29 | }
30 |
--------------------------------------------------------------------------------
/frontend/public/json/garmin-grafana.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "garmin-grafana",
3 | "slug": "garmin-grafana",
4 | "categories": [
5 | 24
6 | ],
7 | "date_created": "2025-05-08",
8 | "type": "ct",
9 | "updateable": true,
10 | "privileged": false,
11 | "interface_port": 3000,
12 | "documentation": "https://github.com/arpanghosh8453/garmin-grafana",
13 | "config_path": "",
14 | "website": "https://github.com/arpanghosh8453/garmin-grafana",
15 | "logo": "https://cdn.jsdelivr.net/gh/selfhst/icons@main/webp/garmin-grafana.webp",
16 | "description": "A docker container to fetch data from Garmin servers and store the data in a local influxdb database for appealing visualization with Grafana.",
17 | "install_methods": [
18 | {
19 | "type": "default",
20 | "script": "ct/garmin-grafana.sh",
21 | "resources": {
22 | "cpu": 2,
23 | "ram": 2,
24 | "hdd": 8,
25 | "os": "Debian",
26 | "version": "12"
27 | }
28 | }
29 | ],
30 | "default_credentials": {
31 | "username": null,
32 | "password": null
33 | },
34 | "notes": [
35 | {
36 | "text": "Show login and database credentials: `cat ~/.garmin-grafana.creds`",
37 | "type": "info"
38 | },
39 | {
40 | "text": "`garmin-grafana` only imports the past 7 days by default. To import historical data, use the `~/bulk-import.sh` script after installation.",
41 | "type": "info"
42 | }
43 | ]
44 | }
45 |
--------------------------------------------------------------------------------
/ct/byparr.sh:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env bash
2 | source <(curl -fsSL https://raw.githubusercontent.com/community-scripts/ProxmoxVED/main/misc/build.func)
3 | # Copyright (c) 2021-2025 community-scripts ORG
4 | # Author: luismco
5 | # License: MIT | https://github.com/community-scripts/ProxmoxVE/raw/main/LICENSE
6 | # Source: https://github.com/ThePhaseless/Byparr
7 |
8 | APP="Byparr"
9 | var_tags="${var_tags:-proxy}"
10 | var_cpu="${var_cpu:-2}"
11 | var_ram="${var_ram:-2048}"
12 | var_disk="${var_disk:-4}"
13 | var_os="${var_os:-debian}"
14 | var_version="${var_version:-13}"
15 | var_unprivileged="${var_unprivileged:-1}"
16 |
17 | header_info "$APP"
18 | variables
19 | color
20 | catch_errors
21 |
22 | function update_script() {
23 | header_info
24 | check_container_storage
25 | check_container_resources
26 | if [[ ! -d /opt/Byparr ]]; then
27 | msg_error "No ${APP} Installation Found!"
28 | exit
29 | fi
30 |
31 | if check_for_gh_release "Byparr" "ThePhaseless/Byparr"; then
32 | msg_info "Stopping Service"
33 | systemctl stop byparr
34 | msg_ok "Stopped Service"
35 |
36 | fetch_and_deploy_gh_release "Byparr" "ThePhaseless/Byparr"
37 |
38 | msg_info "Starting Service"
39 | systemctl start byparr
40 | msg_ok "Started Service"
41 | msg_ok "Updated Successfully!"
42 | fi
43 | exit
44 | }
45 |
46 | start
47 | build_container
48 | description
49 |
50 | msg_ok "Completed Successfully!\n"
51 | echo -e "${CREATING}${GN}${APP} setup has been successfully initialized!${CL}"
52 | echo -e "${INFO}${YW} Access it using the following URL:${CL}"
53 | echo -e "${TAB}${GATEWAY}${BGN}http://${IP}:8191${CL}"
54 |
--------------------------------------------------------------------------------
/frontend/public/json/koel.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "Koel",
3 | "slug": "koel",
4 | "categories": [
5 | 13
6 | ],
7 | "date_created": "2025-12-10",
8 | "type": "ct",
9 | "updateable": true,
10 | "privileged": false,
11 | "interface_port": 80,
12 | "documentation": "https://docs.koel.dev/",
13 | "config_path": "/opt/koel/.env",
14 | "website": "https://koel.dev/",
15 | "logo": "https://cdn.jsdelivr.net/gh/selfhst/icons@main/webp/koel-light.webp",
16 | "description": "Koel is a simple web-based personal audio streaming service written in Vue and Laravel. It supports multiple users, audio visualization, smart playlists, YouTube integration, and Last.fm scrobbling.",
17 | "install_methods": [
18 | {
19 | "type": "default",
20 | "script": "ct/koel.sh",
21 | "resources": {
22 | "cpu": 2,
23 | "ram": 2048,
24 | "hdd": 8,
25 | "os": "Debian",
26 | "version": "13"
27 | }
28 | }
29 | ],
30 | "default_credentials": {
31 | "username": "admin@koel.dev",
32 | "password": "KoelIsCool"
33 | },
34 | "notes": [
35 | {
36 | "text": "Media files should be placed in /opt/koel_media",
37 | "type": "info"
38 | },
39 | {
40 | "text": "Database credentials are stored in ~/koel.creds",
41 | "type": "info"
42 | },
43 | {
44 | "text": "Music library is scanned hourly via cron job",
45 | "type": "info"
46 | }
47 | ]
48 | }
49 |
--------------------------------------------------------------------------------
/frontend/public/json/transmission-openvpn.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "Transmission-Openvpn",
3 | "slug": "transmission-openvpn",
4 | "categories": [
5 | 11
6 | ],
7 | "date_created": "2025-09-04",
8 | "type": "ct",
9 | "updateable": true,
10 | "privileged": false,
11 | "interface_port": 9091,
12 | "documentation": "https://haugene.github.io/docker-transmission-openvpn/",
13 | "config_path": "/opt/transmission-openvpn/",
14 | "website": "https://github.com/haugene/docker-transmission-openvpn",
15 | "logo": "https://cdn.jsdelivr.net/gh/selfhst/icons@main/webp/transmission.webp",
16 | "description": "This project runs Transmission + OpenVPN natively in an LXC container, using the popular docker-transmission-openvpn image as a base. It ensures all torrent traffic is securely routed through a VPN tunnel, supports a wide range of VPN providers, and offers flexible configuration options",
17 | "install_methods": [
18 | {
19 | "type": "default",
20 | "script": "ct/transmission-openvpn.sh",
21 | "resources": {
22 | "cpu": 1,
23 | "ram": 512,
24 | "hdd": 8,
25 | "os": "Debian",
26 | "version": "13"
27 | }
28 | }
29 | ],
30 | "default_credentials": {
31 | "username": null,
32 | "password": null
33 | },
34 | "notes": [
35 | {
36 | "text": "This application requires a VPN provider to work. Please refer to your VPN provider’s documentation for setting up OpenVPN.",
37 | "type": "warning"
38 | }
39 | ]
40 | }
41 |
--------------------------------------------------------------------------------
/frontend/src/app/scripts/_components/ScriptItems/Tooltips.tsx:
--------------------------------------------------------------------------------
1 | import { Badge } from "@/components/ui/badge";
2 | import {
3 | Tooltip,
4 | TooltipContent,
5 | TooltipProvider,
6 | TooltipTrigger,
7 | } from "@/components/ui/tooltip";
8 | import { Script } from "@/lib/types";
9 | import { CircleHelp } from "lucide-react";
10 | import React from "react";
11 |
12 | interface TooltipProps {
13 | variant: "warning" | "success";
14 | label: string;
15 | content: string;
16 | }
17 |
18 | const TooltipBadge: React.FC
36 | {item.privileged && (
37 |
51 | );
52 | }
53 |
--------------------------------------------------------------------------------
/frontend/public/json/postgresus.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "Postgresus",
3 | "slug": "postgresus",
4 | "categories": [
5 | 6,
6 | 11
7 | ],
8 | "date_created": "2025-12-11",
9 | "type": "ct",
10 | "updateable": true,
11 | "privileged": false,
12 | "interface_port": 80,
13 | "documentation": "https://github.com/RostislavDugin/postgresus",
14 | "website": "https://github.com/RostislavDugin/postgresus",
15 | "logo": "https://cdn.jsdelivr.net/gh/selfhst/icons@main/webp/postgresus.webp",
16 | "config_path": "/opt/postgresus/.env",
17 | "description": "Free, open source and self-hosted solution for automated PostgreSQL backups. With multiple storage options, notifications, scheduling, and a beautiful web interface for managing database backups across multiple PostgreSQL instances.",
18 | "install_methods": [
19 | {
20 | "type": "default",
21 | "script": "ct/postgresus.sh",
22 | "resources": {
23 | "cpu": 2,
24 | "ram": 2048,
25 | "hdd": 8,
26 | "os": "Debian",
27 | "version": "13"
28 | }
29 | }
30 | ],
31 | "default_credentials": {
32 | "username": "admin@localhost",
33 | "password": "See /root/postgresus.creds"
34 | },
35 | "notes": [
36 | {
37 | "text": "Supports PostgreSQL versions 12-18 with cloud and self-hosted instances",
38 | "type": "info"
39 | },
40 | {
41 | "text": "Features: Scheduled backups, multiple storage providers, notifications, encryption",
42 | "type": "info"
43 | }
44 | ]
45 | }
46 |
--------------------------------------------------------------------------------
/tools/pve/usb-passthrough.sh:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env bash
2 |
3 | # Copyright (c) 2021-2025 tteck
4 | # Author: tteck (tteckster)
5 | # License: MIT
6 | # https://github.com/community-scripts/ProxmoxVED/raw/main/LICENSE
7 |
8 | echo -e "\e[1;33m This script will allow USB passthrough to a PRIVILEGED LXC Container ONLY\e[0m"
9 | while true; do
10 | read -p "Did you replace 106 with your LXC ID? Proceed(y/n)?" yn
11 | case $yn in
12 | [Yy]*) break ;;
13 | [Nn]*) exit ;;
14 | *) echo "Please answer yes or no." ;;
15 | esac
16 | done
17 |
18 | TEMP_DIR=$(mktemp -d)
19 | pushd $TEMP_DIR >/dev/null
20 | CHAR_DEVS+=("166:.*")
21 | CHAR_DEVS+=("188:.*")
22 | CHAR_DEVS+=("189:.*")
23 |
24 | for char_dev in ${CHAR_DEVS[@]}; do
25 | [ ! -z "${CHAR_DEV_STRING-}" ] && CHAR_DEV_STRING+=" -o"
26 | CHAR_DEV_STRING+=" -regex \".*/${char_dev}\""
27 | done
28 |
29 | read -r -d '' HOOK_SCRIPT <<-EOF || true
30 | for char_dev in \$(find /sys/dev/char -regextype sed $CHAR_DEV_STRING); do
31 | dev="/dev/\$(sed -n "/DEVNAME/ s/^.*=\(.*\)$/\1/p" \${char_dev}/uevent)";
32 | mkdir -p \$(dirname \${LXC_ROOTFS_MOUNT}\${dev});
33 | for link in \$(udevadm info --query=property \$dev | sed -n "s/DEVLINKS=//p"); do
34 | mkdir -p \${LXC_ROOTFS_MOUNT}\$(dirname \$link);
35 | cp -dpR \$link \${LXC_ROOTFS_MOUNT}\${link};
36 | done;
37 | cp -dpR \$dev \${LXC_ROOTFS_MOUNT}\${dev};
38 | done;
39 | EOF
40 | HOOK_SCRIPT=${HOOK_SCRIPT//$'\n'/}
41 |
42 | CTID=$1
43 | CTID_CONFIG_PATH=/etc/pve/lxc/${CTID}.conf
44 | sed '/autodev/d' $CTID_CONFIG_PATH >CTID.conf
45 | cat CTID.conf >$CTID_CONFIG_PATH
46 |
47 | cat <
37 |
38 |
53 |
54 | );
55 | }
56 |
--------------------------------------------------------------------------------
/frontend/src/components/ui/number-ticker.tsx:
--------------------------------------------------------------------------------
1 | "use client";
2 |
3 | import { useInView, useMotionValue, useSpring } from "framer-motion";
4 | import { useEffect, useRef } from "react";
5 |
6 | import { cn } from "@/lib/utils";
7 |
8 | export default function NumberTicker({
9 | value,
10 | direction = "up",
11 | delay = 0,
12 | className,
13 | decimalPlaces = 0,
14 | }: {
15 | value: number;
16 | direction?: "up" | "down";
17 | className?: string;
18 | delay?: number; // delay in s
19 | decimalPlaces?: number;
20 | }) {
21 | const ref = useRef
39 | {!isMobile && children ? children : "Copy Config File Path"}
40 |
41 | handleCopy("install command", children)}
44 | >
45 | {hasCopied ? (
46 |
52 |
2 | 
3 |
4 |
3 | Exploring the Scripts and Steps Involved in an Application LXC Installation
5 |
6 | 1) [adguard.sh](https://github.com/community-scripts/ProxmoxVE/blob/main/ct/adguard.sh): This script collects system parameters. (Also holds the function to update the application.)
7 | 2) [build.func](https://github.com/community-scripts/ProxmoxVE/blob/main/misc/build.func): Adds user settings and integrates collected information.
8 | 3) [create_lxc.sh](https://github.com/community-scripts/ProxmoxVE/blob/main/misc/create_lxc.sh): Constructs the LXC container.
9 | 4) [adguard-install.sh](https://github.com/community-scripts/ProxmoxVE/blob/main/install/adguard-install.sh): Executes functions from [install.func](https://github.com/community-scripts/ProxmoxVE/blob/main/misc/install.func), and installs the application.
10 | 5) [adguard.sh](https://github.com/community-scripts/ProxmoxVE/blob/main/ct/adguard.sh) (again): To display the completion message.
11 |
12 | The installation process uses reusable scripts: [build.func](https://github.com/community-scripts/ProxmoxVE/blob/main/misc/build.func), [create_lxc.sh](https://github.com/community-scripts/ProxmoxVE/blob/main/misc/create_lxc.sh), and [install.func](https://github.com/community-scripts/ProxmoxVE/blob/main/misc/install.func), which are not specific to any particular application.
13 |
14 | To gain a better understanding, focus on reviewing [adguard-install.sh](https://github.com/community-scripts/ProxmoxVE/blob/main/install/adguard-install.sh). This script contains the commands and configurations for installing and configuring AdGuard Home within the LXC container.
15 |
--------------------------------------------------------------------------------
/docs/misc/install.func/INSTALL_FUNC_USAGE_EXAMPLES.md:
--------------------------------------------------------------------------------
1 | # install.func Usage Examples
2 |
3 | Practical examples for using install.func functions in application installation scripts.
4 |
5 | ## Basic Examples
6 |
7 | ### Example 1: Minimal Setup
8 |
9 | ```bash
10 | #!/usr/bin/env bash
11 | source /dev/stdin <<<"$FUNCTIONS_FILE_PATH"
12 |
13 | setting_up_container
14 | network_check
15 | update_os
16 |
17 | # ... application installation ...
18 |
19 | motd_ssh
20 | customize
21 | cleanup_lxc
22 | ```
23 |
24 | ### Example 2: With Error Handling
25 |
26 | ```bash
27 | #!/usr/bin/env bash
28 | source /dev/stdin <<<"$FUNCTIONS_FILE_PATH"
29 |
30 | catch_errors
31 | setting_up_container
32 |
33 | if ! network_check; then
34 | msg_error "Network failed"
35 | exit 1
36 | fi
37 |
38 | if ! update_os; then
39 | msg_error "OS update failed"
40 | exit 1
41 | fi
42 |
43 | # ... continue ...
44 | ```
45 |
46 | ---
47 |
48 | ## Production Examples
49 |
50 | ### Example 3: Full Application Installation
51 |
52 | ```bash
53 | #!/usr/bin/env bash
54 | source /dev/stdin <<<"$FUNCTIONS_FILE_PATH"
55 |
56 | catch_errors
57 | setting_up_container
58 | network_check
59 | update_os
60 |
61 | msg_info "Installing application"
62 | # ... install steps ...
63 | msg_ok "Application installed"
64 |
65 | motd_ssh
66 | customize
67 | cleanup_lxc
68 | ```
69 |
70 | ### Example 4: With IPv6 Support
71 |
72 | ```bash
73 | #!/usr/bin/env bash
74 | source /dev/stdin <<<"$FUNCTIONS_FILE_PATH"
75 |
76 | catch_errors
77 | setting_up_container
78 | verb_ip6
79 | network_check
80 | update_os
81 |
82 | # ... application installation ...
83 |
84 | motd_ssh
85 | customize
86 | cleanup_lxc
87 | ```
88 |
89 | ---
90 |
91 | **Last Updated**: December 2025
92 | **Examples**: Basic and production patterns
93 | **All examples production-ready**
94 |
--------------------------------------------------------------------------------
/.github/CONTRIBUTOR_AND_GUIDES/CODE-AUDIT.md:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
3 | Exploring the Scripts and Steps Involved in an Application LXC Installation
5 |
6 | 1) [adguard.sh](https://github.com/community-scripts/ProxmoxVE/blob/main/ct/adguard.sh): This script collects system parameters. (Also holds the function to update the application.)
7 | 2) [build.func](https://github.com/community-scripts/ProxmoxVE/blob/main/misc/build.func): Adds user settings and integrates collected information.
8 | 3) [create_lxc.sh](https://github.com/community-scripts/ProxmoxVE/blob/main/misc/create_lxc.sh): Constructs the LXC container.
9 | 4) [adguard-install.sh](https://github.com/community-scripts/ProxmoxVE/blob/main/install/adguard-install.sh): Executes functions from [install.func](https://github.com/community-scripts/ProxmoxVE/blob/main/misc/install.func), and installs the application.
10 | 5) [adguard.sh](https://github.com/community-scripts/ProxmoxVE/blob/main/ct/adguard.sh) (again): To display the completion message.
11 |
12 | The installation process uses reusable scripts: [build.func](https://github.com/community-scripts/ProxmoxVE/blob/main/misc/build.func), [create_lxc.sh](https://github.com/community-scripts/ProxmoxVE/blob/main/misc/create_lxc.sh), and [install.func](https://github.com/community-scripts/ProxmoxVE/blob/main/misc/install.func), which are not specific to any particular application.
13 |
14 | To gain a better understanding, focus on reviewing [adguard-install.sh](https://github.com/community-scripts/ProxmoxVE/blob/main/install/adguard-install.sh). This script contains the commands and configurations for installing and configuring AdGuard Home within the LXC container.
15 |
--------------------------------------------------------------------------------
/.github/pull_request_template.md:
--------------------------------------------------------------------------------
1 | ## **Scripts wich are clearly AI generated and not further revied by the Author of this PR (in terms of Coding Standards and Script Layout) may be closed without review.**
2 |
3 | ## ✍️ Description
4 |
5 |
6 | ## 🔗 Related PR / Issue
7 |
8 | Link: #
9 |
10 | ## ✅ Prerequisites (**X** in brackets)
11 |
12 | - [ ] **Self-review completed** – Code follows project standards.
13 | - [ ] **Tested thoroughly** – Changes work as expected.
14 | - [ ] **No breaking changes** – Existing functionality remains intact.
15 | - [ ] **No security risks** – No hardcoded secrets, unnecessary privilege escalations, or permission issues.
16 |
17 | ---
18 |
19 | ## 🛠️ Type of Change (**X** in brackets)
20 |
21 | - [ ] 🐞 **Bug fix** – Resolves an issue without breaking functionality.
22 | - [ ] ✨ **New feature** – Adds new, non-breaking functionality.
23 | - [ ] 💥 **Breaking change** – Alters existing functionality in a way that may require updates.
24 | - [ ] 🆕 **New script** – A fully functional and tested script or script set.
25 | - [ ] 🌍 **Website update** – Changes to website-related JSON files or metadata.
26 | - [ ] 🔧 **Refactoring / Code Cleanup** – Improves readability or maintainability without changing functionality.
27 | - [ ] 📝 **Documentation update** – Changes to `README`, `AppName.md`, `CONTRIBUTING.md`, or other docs.
28 |
29 | ---
30 |
31 | ## 🔍 Code & Security Review (**X** in brackets)
32 |
33 | - [ ] **Follows `Code_Audit.md` & `CONTRIBUTING.md` guidelines**
34 | - [ ] **Uses correct script structure (`AppName.sh`, `AppName-install.sh`, `AppName.json`)**
35 | - [ ] **No hardcoded credentials**
36 |
37 |
38 | ## 📋 Additional Information (optional)
39 |
40 |
--------------------------------------------------------------------------------
/frontend/public/json/pixelfed.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "Pixelfed",
3 | "slug": "pixelfed",
4 | "categories": [
5 | 17
6 | ],
7 | "date_created": "2024-06-15",
8 | "type": "ct",
9 | "updateable": true,
10 | "privileged": false,
11 | "interface_port": 80,
12 | "documentation": "https://docs.pixelfed.org/",
13 | "config_path": "/opt/pixelfed/.env",
14 | "website": "https://pixelfed.org/",
15 | "logo": "https://cdn.jsdelivr.net/gh/selfhst/icons@main/webp/pixelfed.webp",
16 | "description": "Pixelfed is a free, ethical, and decentralized photo sharing platform powered by ActivityPub federation. It offers an ad-free, privacy-focused alternative to Instagram with features like Stories, Collections, and photo filters.",
17 | "install_methods": [
18 | {
19 | "type": "default",
20 | "script": "ct/pixelfed.sh",
21 | "resources": {
22 | "cpu": 2,
23 | "ram": 2048,
24 | "hdd": 10,
25 | "os": "Debian",
26 | "version": "12"
27 | }
28 | }
29 | ],
30 | "default_credentials": {
31 | "username": null,
32 | "password": null
33 | },
34 | "notes": [
35 | {
36 | "text": "Create admin account with: cd /opt/pixelfed && sudo -u pixelfed php artisan user:create",
37 | "type": "warning"
38 | },
39 | {
40 | "text": "Credentials saved in /root/pixelfed.creds",
41 | "type": "info"
42 | },
43 | {
44 | "text": "ActivityPub federation is enabled by default",
45 | "type": "info"
46 | },
47 | {
48 | "text": "Uses PostgreSQL, Redis (socket), and PHP-FPM",
49 | "type": "info"
50 | }
51 | ]
52 | }
53 |
--------------------------------------------------------------------------------
/frontend/src/components/Footer.tsx:
--------------------------------------------------------------------------------
1 | import { basePath } from "@/config/siteConfig";
2 | import Link from "next/link";
3 | import { FileJson, Server, ExternalLink } from "lucide-react";
4 | import { buttonVariants } from "./ui/button";
5 | import { cn } from "@/lib/utils";
6 |
7 | export default function Footer() {
8 | return (
9 |
10 |
42 | );
43 | }
44 |
--------------------------------------------------------------------------------
/frontend/src/components/ui/alert.tsx:
--------------------------------------------------------------------------------
1 | import * as React from "react"
2 | import { cva, type VariantProps } from "class-variance-authority"
3 |
4 | import { cn } from "@/lib/utils"
5 |
6 | const alertVariants = cva(
7 | "relative w-full rounded-lg border p-4 [&>svg~*]:pl-7 [&>svg+div]:translate-y-[-3px] [&>svg]:absolute [&>svg]:left-4 [&>svg]:top-4 [&>svg]:text-foreground",
8 | {
9 | variants: {
10 | variant: {
11 | default: "bg-background text-foreground",
12 | destructive:
13 | "border-destructive/50 text-destructive dark:border-destructive [&>svg]:text-destructive",
14 | },
15 | },
16 | defaultVariants: {
17 | variant: "default",
18 | },
19 | }
20 | )
21 |
22 | const Alert = React.forwardRef<
23 | HTMLDivElement,
24 | React.HTMLAttributes
11 |
41 |
12 |
26 | 13 | Website built by the community. The source code is available on{" "} 14 | 21 | GitHub 22 | 23 | . 24 |
25 |
27 |
31 |
40 |