A Wiki to create our own scripts using the build.func script

[dukeseb]

One thing that I like about these scripts is that they don't require me to install an OS and then run a script.

What I think would be a good idea (and I'm assuming someone knowledgable would be really easy to create) would be a Wiki that teaches you to create your own bash scripts that use the build function

source <(curl -s https://raw.githubusercontent.com/community-scripts/ProxmoxVE/main/misc/build.func)

As an example, I have a bash script that builds a webserver with all the custom fields that I need. Currently I use the community debian script and then run the bash script that i host on github after the fact.... I would like to have both tasks combined

From what i can tell all that would be required in my script would be the highlighted areas, im not 100% though how I would add my actual script in this file

[michelroegl-brunner]

Habe a look at our wiki, or the cpntributing guide :)

[dukeseb]

thanks I've looked at the guide and its got me this far, but im sort of also looking for something that I can use to confirm that I know what im doing

as an example can you look over this and tell me if im understanding? What I want this script to do is install ubuntu and then install UFW and open ports 80 and 443. does this look right or am I way off?

#!/usr/bin/env bash
source <(curl -s https://raw.githubusercontent.com/community-scripts/ProxmoxVE/main/misc/build.func)
# Copyright (c) 2021-2025 tteck
# Author: tteck (tteckster)
# License: MIT | https://github.com/community-scripts/ProxmoxVE/raw/main/LICENSE
# Source: https://ubuntu.com/

# App Default Values
echo -e "Loading..."
APP="Ubuntu"
var_tags="os"
var_cpu="1"
var_ram="512"
var_disk="2"
var_os="ubuntu"
var_version="24.04"

# App Output & Base Settings
header_info "$APP"
base_settings

# Core
variables
color
catch_errors

# Start container creation
start
build_container
description

function update_script() {
    header_info
    check_container_storage
    check_container_resources

    # Install UFW if not already installed
    if ! command -v ufw &>/dev/null; then
        msg_info "Installing UFW (Uncomplicated Firewall)"
        apt-get update -y && apt-get install ufw -y
        msg_ok "UFW installed"
    else
        msg_ok "UFW is already installed"
    fi

    # Configure UFW to allow HTTP (80) and HTTPS (443) traffic
    msg_info "Configuring UFW to allow ports 80 (HTTP) and 443 (HTTPS)"
    ufw allow 80/tcp
    ufw allow 443/tcp

    # Enable UFW
    msg_info "Enabling UFW"
    ufw --force enable
    msg_ok "UFW enabled and ports 80 and 443 opened"
    exit
}

# Final success message
msg_ok "Completed Successfully!\n"
echo -e "${CREATING}${GN}${APP} setup has been successfully initialized!${CL}"

[MickLesk]

Nope. This is the CT Script only for creating container or Update Container. Install is the -install.sh Script.

Look at ct\ubuntu.sh and install\ubuntu-install.sh

[dukeseb]

Nope. This is the CT Script only for creating container or Update Container. Install is the -install.sh Script.

Look at ct\ubuntu.sh and install\ubuntu-install.sh

Ok I think my confusion then is that when i run the script I use the app.sh is does the install of the OS and the application. Is there something in the app.sh that tell is to read the installation instructions from the app-install.sh file?

[MickLesk]

The build.func in Line 2 thats call the Install.func, that call the CT-install.sh and create_lxc.sh

Its an construct of:
CT.sh
-> build.func
--> install.func
---> create_lxc.sh
----> CT-install.sh

[MickLesk]

https://github.com/community-scripts/ProxmoxVE/blob/main/.github%2FCONTRIBUTING.md

https://github.com/community-scripts/ProxmoxVE/tree/main/.github%2FCONTRIBUTOR_GUIDE