General Cleanup & Moving Files / Folders (#2532)

2025-06-30 02:57:38 +00:00 · 2025-02-21 10:31:17 +01:00
parent 7d40e148e9
commit dd8db43dea
13 changed files with 2 additions and 2 deletions
--- a/.github/CONTRIBUTOR_AND_GUIDES/CODE-AUDIT.md
+++ b/.github/CONTRIBUTOR_AND_GUIDES/CODE-AUDIT.md
@ -0,0 +1,14 @@
+<div align="center">
+<img src="https://raw.githubusercontent.com/community-scripts/ProxmoxVE/main/misc/images/logo.png" height="100px" />
+</div>
+<h2><div align="center">Exploring the Scripts and Steps Involved in an Application LXC Installation</div></h2>
+
+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.)
+2) [build.func](https://github.com/community-scripts/ProxmoxVE/blob/main/misc/build.func): Adds user settings and integrates collected information.
+3) [create_lxc.sh](https://github.com/community-scripts/ProxmoxVE/blob/main/ct/create_lxc.sh): Constructs the LXC container.
+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.
+5) [adguard.sh](https://github.com/community-scripts/ProxmoxVE/blob/main/ct/adguard.sh) (again): To display the completion message.
+
+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/ct/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.
+
+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.
--- a/.github/CONTRIBUTOR_AND_GUIDES/CODE_OF_CONDUCT.md
+++ b/.github/CONTRIBUTOR_AND_GUIDES/CODE_OF_CONDUCT.md
@ -0,0 +1,132 @@
+
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+[https://www.contributor-covenant.org/version/2/0/code_of_conduct.html][v2.0].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available
+at [https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.0]: https://www.contributor-covenant.org/version/2/0/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations
--- a/.github/CONTRIBUTOR_AND_GUIDES/CONTRIBUTING.md
+++ b/.github/CONTRIBUTOR_AND_GUIDES/CONTRIBUTING.md
@ -0,0 +1,106 @@
+
+# Community Scripts Contribution Guide
+
+## **Welcome to the communty-scripts Repository!** 
+
+📜 These documents outline the essential coding standards for all our scripts and JSON files. Adhering to these standards ensures that our codebase remains consistent, readable, and maintainable. By following these guidelines, we can improve collaboration, reduce errors, and enhance the overall quality of our project.
+
+### Why Coding Standards Matter
+
+Coding standards are crucial for several reasons:
+
+1. **Consistency**: Consistent code is easier to read, understand, and maintain. It helps new team members quickly get up to speed and reduces the learning curve.
+2. **Readability**: Clear and well-structured code is easier to debug and extend. It allows developers to quickly identify and fix issues.
+3. **Maintainability**: Code that follows a standard structure is easier to refactor and update. It ensures that changes can be made with minimal risk of introducing new bugs.
+4. **Collaboration**: When everyone follows the same standards, it becomes easier to collaborate on code. It reduces friction and misunderstandings during code reviews and merges.
+
+### Scope of These Documents
+
+These documents cover the coding standards for the following types of files in our project:
+
+- **`install/$AppName-install.sh` Scripts**: These scripts are responsible for the installation of applications.
+- **`ct/$AppName.sh` Scripts**: These scripts handle the creation and updating of containers.
+- **`json/$AppName.json`**: These files store structured data and are used for the website.
+
+Each section provides detailed guidelines on various aspects of coding, including shebang usage, comments, variable naming, function naming, indentation, error handling, command substitution, quoting, script structure, and logging. Additionally, examples are provided to illustrate the application of these standards.
+
+By following the coding standards outlined in this document, we ensure that our scripts and JSON files are of high quality, making our project more robust and easier to manage. Please refer to this guide whenever you create or update scripts and JSON files to maintain a high standard of code quality across the project. 📚🔍
+
+Let's work together to keep our codebase clean, efficient, and maintainable! 💪🚀
+
+
+## Getting Started
+
+Before contributing, please ensure that you have the following setup:
+
+1. **Visual Studio Code** (recommended for script development)
+2. **Recommended VS Code Extensions:**
+   - [Shell Syntax](https://marketplace.visualstudio.com/items?itemName=bmalehorn.shell-syntax)
+   - [ShellCheck](https://marketplace.visualstudio.com/items?itemName=timonwong.shellcheck)
+   - [Shell Format](https://marketplace.visualstudio.com/items?itemName=foxundermoon.shell-format)
+
+### Important Notes
+- Use [AppName.sh](https://github.com/community-scripts/ProxmoxVE/blob/main/.github/CONTRIBUTOR_GUIDE/ct/AppName.sh) and [AppName-install.sh](https://github.com/community-scripts/ProxmoxVE/blob/main/.github/CONTRIBUTOR_GUIDE/install/AppName-install.sh) as templates when creating new scripts.
+
+---
+
+# 🚀 The Application Script (ct/AppName.sh)
+
+- You can find all coding standards, as well as the structure for this file [here](https://github.com/community-scripts/ProxmoxVE/blob/main/.github/CONTRIBUTOR_GUIDE/ct/AppName.md).
+- These scripts are responsible for container creation, setting the necessary variables and handling the update of the application once installed.
+
+---
+
+# 🛠 The Installation Script (install/AppName-install.sh)
+
+- You can find all coding standards, as well as the structure for this file [here](https://github.com/community-scripts/ProxmoxVE/blob/main/.github/CONTRIBUTOR_GUIDE/install/AppName-install.md).
+- These scripts are responsible for the installation of the application.
+
+---
+
+## 🚀 Building Your Own Scripts
+
+Start with the [template script](https://github.com/community-scripts/ProxmoxVE/blob/main/.github/CONTRIBUTOR_GUIDE/install/AppName-install.sh)
+
+---
+
+## 🤝 Contribution Process
+
+### 1. Fork the repository
+Fork to your GitHub account
+
+### 2. Clone your fork on your local environment 
+```bash
+git clone https://github.com/yourUserName/ForkName
+```
+
+### 3. Create a new branch
+```bash
+git switch -c your-feature-branch
+```
+
+### 4. Change paths in build.func install.func and AppName.sh
+To be able to develop from your own branch you need to change `https://raw.githubusercontent.com/community-scripts/ProxmoxVE/main` to `https://raw.githubusercontent.com/[USER]/[REPOSITORY]/refs/heads/[BRANCH]`. You need to make this change atleast in misc/build.func misc/install.func and in your ct/AppName.sh. This change is only for testing. Before opening a Pull Request you should change this line change all this back to point to `https://raw.githubusercontent.com/community-scripts/ProxmoxVE/main`.
+
+### 4. Commit changes (without build.func and install.func!)
+```bash
+git commit -m "Your commit message"
+```
+
+### 5. Push to your fork
+```bash
+git push origin your-feature-branch
+```
+
+### 6. Create a Pull Request
+Open a Pull Request from your feature branch to the main repository branch. You must only include your **$AppName.sh**, **$AppName-install.sh** and **$AppName.json** files in the pull request.
+
+---
+
+## 📚 Pages
+
+- [CT Template: AppName.sh](https://github.com/community-scripts/ProxmoxVE/blob/main/.github/CONTRIBUTOR_GUIDE/ct/AppName.sh)
+- [Install Template: AppName-install.sh](https://github.com/community-scripts/ProxmoxVE/blob/main/.github/CONTRIBUTOR_GUIDE/install/AppName-install.sh)
+- [JSON Template: AppName.json](https://github.com/community-scripts/ProxmoxVE/blob/main/.github/CONTRIBUTOR_GUIDE/json/AppName.json)
+
+
--- a/.github/CONTRIBUTOR_AND_GUIDES/USER_SUBMITTED_GUIDES.md
+++ b/.github/CONTRIBUTOR_AND_GUIDES/USER_SUBMITTED_GUIDES.md
@ -0,0 +1,44 @@
+<div align="center">
+  <a href="#">
+    <img src="https://raw.githubusercontent.com/community-scripts/ProxmoxVE/main/misc/images/logo.png" height="100px" />
+ </a>
+</div>
+<h2 align="center">User Submitted Guides </h2>
+
+<sub> In order to contribute a guide on installing with Proxmox VE Helper Scripts, you should open a pull request that adds the guide to the `USER_SUBMITTED_GUIDES.md` file. </sub>
+
+[Proxmox Automation with Proxmox Helper Scripts!](https://www.youtube.com/watch?v=kcpu4z5eSEU)
+
+[Installing Home Assistant OS using Proxmox 8](https://community.home-assistant.io/t/installing-home-assistant-os-using-proxmox-8/201835)
+
+[How To Separate Zigbee2MQTT From Home Assistant In Proxmox](https://smarthomescene.com/guides/how-to-separate-zigbee2mqtt-from-home-assistant-in-proxmox/)
+
+[How To Install Home Assistant On Proxmox: The Easy Way](https://smarthomescene.com/guides/how-to-install-home-assistant-on-proxmox-the-easy-way/)
+
+[Home Assistant: Installing InfluxDB (LXC)](https://www.derekseaman.com/2023/04/home-assistant-installing-influxdb-lxc.html)
+
+[Home Assistant: Proxmox Quick Start Guide](https://www.derekseaman.com/2023/10/home-assistant-proxmox-ve-8-0-quick-start-guide-2.html)
+
+[Home Assistant: Installing Grafana (LXC) with Let’s Encrypt SSL](https://www.derekseaman.com/2023/04/home-assistant-installing-grafana-lxc.html)
+
+[Proxmox: Plex LXC with Alder Lake Transcoding](https://www.derekseaman.com/2023/04/proxmox-plex-lxc-with-alder-lake-transcoding.html)
+
+[How To Backup Home Assistant In Proxmox](https://smarthomescene.com/guides/how-to-backup-home-assistant-in-proxmox/)
+
+[Running Frigate on Proxmox](https://www.homeautomationguy.io/blog/running-frigate-on-proxmox)
+
+[Frigate VM on Proxmox with PCIe Coral TPU](https://www.derekseaman.com/2023/06/home-assistant-frigate-vm-on-proxmox-with-pcie-coral-tpu.html)
+
+[Moving Home Assistant’s Database To MariaDB On Proxmox](https://smarthomescene.com/guides/moving-home-assistants-database-to-mariadb-on-proxmox/)
+
+[How-to: Proxmox VE 7.4 to 8.0 Upgrade](https://www.derekseaman.com/2023/06/how-to-proxmox-7-4-to-8-0-upgrade.html)
+
+[iGPU Transcoding In Proxmox with Jellyfin](https://www.youtube.com/watch?v=XAa_qpNmzZs)
+
+[Proxmox + NetData](<https://dbt3ch.com/books/proxmox-netdata-for-better-insights-and-notifications/page/proxmox-netdata-for-better-insights-and-notifications>)
+
+[Proxmox Homelab Series](<https://blog.kye.dev/proxmox-series>)
+
+[The fastest installation of Docker and Portainer on Proxmox VE](https://lavr.site/en-fastest-install-docker-portainer-proxmox/)
+
+[How To Setup Proxmox Backuper Server Using Helper Scripts](<https://youtu.be/6C2JOsrZZZw?si=kkrrcL_nLCDBJkOB>)
--- a/.github/CONTRIBUTOR_AND_GUIDES/ct/AppName.md
+++ b/.github/CONTRIBUTOR_AND_GUIDES/ct/AppName.md
@ -0,0 +1,286 @@
+# **AppName<span></span>.sh Scripts**
+
+ `AppName.sh` scripts found in the `/ct` directory. These scripts are responsible for the installation of the desired application. For this guide we take `/ct/snipeit.sh` as example.
+
+## Table of Contents
+
+- [**AppName.sh Scripts**](#appnamesh-scripts)
+  - [Table of Contents](#table-of-contents)
+  - [1. **File Header**](#1-file-header)
+    - [1.1 **Shebang**](#11-shebang)
+    - [1.2 **Import Functions**](#12-import-functions)
+    - [1.3 **Metadata**](#13-metadata)
+  - [2 **Variables and function import**](#2-variables-and-function-import)
+    - [2.1 **Default Values**](#21-default-values)
+  - [2.2 **📋 App output \& base settings**](#22--app-output--base-settings)
+  - [2.3 **🛠 Core functions**](#23--core-functions)
+  - [3 **Update function**](#3-update-function)
+    - [3.1 **Function Header**](#31-function-header)
+    - [3.2 **Check APP**](#32-check-app)
+    - [3.3 **Check version**](#33-check-version)
+    - [3.4 **Verbosity**](#34-verbosity)
+    - [3.5 **Backups**](#35-backups)
+    - [3.6 **Cleanup**](#36-cleanup)
+    - [3.7 **No update function**](#37-no-update-function)
+  - [4 **End of the script**](#4-end-of-the-script)
+  - [5. **Contribution checklist**](#5-contribution-checklist)
+
+## 1. **File Header**
+
+### 1.1 **Shebang**
+
+- Use `#!/usr/bin/env bash` as the shebang.
+
+```bash
+#!/usr/bin/env bash
+```
+
+### 1.2 **Import Functions**
+
+- Import the build.func file.
+- When developing your own script, change the URL to your own repository.
+
+> [!IMPORTANT] 
+> You also need to change all apperances of this URL in `misc/build.func` and `misc/install.func`
+
+Example for development:
+
+```bash
+source <(curl -s https://raw.githubusercontent.com/[USER]/[REPO]/refs/heads/[BRANCH]/misc/build.func)
+```
+
+Final script:
+
+```bash
+source <(curl -s https://raw.githubusercontent.com/community-scripts/ProxmoxVE/main/misc/build.func)
+```
+
+> [!CAUTION]
+> Before opening a Pull Request, change the URLs to point to the community-scripts repo.
+
+### 1.3 **Metadata**
+
+- Add clear comments for script metadata, including author, copyright, and license information.
+
+Example:
+
+```bash
+# Copyright (c) 2021-2025 community-scripts ORG
+# Author: [YourUserName]
+# License: MIT | https://github.com/community-scripts/ProxmoxVE/raw/main/LICENSE
+# Source: [SOURCE_URL]
+```
+
+> [!NOTE]:
+>
+> - Add your username and source URL
+> - For existing scripts, add "| Co-Author [YourUserName]" after the current author
+
+---
+
+## 2 **Variables and function import**
+>
+> [!NOTE]
+> You need to have all this set in your script, otherwise it will not work!
+
+### 2.1 **Default Values**
+
+- This section sets the default values for the container.
+- `APP` needs to be set to the application name and must be equal to the filenames of your scripts.
+- `var_tags`: You can set Tags for the CT wich show up in the Proxmox UI. Don´t overdo it!
+
+>[!NOTE]
+>Description for all Default Values
+>
+>| Variable | Description | Notes |
+>|----------|-------------|-------|
+>| `APP` | Application name | Must match ct\AppName.sh |
+>| `TAGS` | Proxmox display tags without Spaces, only ; | Limit the number |  
+>| `var_cpu` | CPU cores | Number of cores |
+>| `var_ram` | RAM | In MB |
+>| `var_disk` | Disk capacity | In GB |
+>| `var_os` | Operating system | alpine, debian, ubuntu |
+>| `var_version` | OS version | e.g., 3.20, 11, 12, 20.04 |
+>| `var_unprivileged` | Container type | 1 = Unprivileged, 0 = Privileged |
+
+Example:
+
+```bash
+APP="SnipeIT"
+var_tags="asset-management;foss"
+var_cpu="2"
+var_ram="2048"
+var_disk="4"
+var_os="debian"
+var_version="12"
+var_unprivileged="1"
+```
+
+## 2.2 **📋 App output & base settings**
+
+```bash
+header_info "$APP"
+```
+- `header_info`: Generates ASCII header for APP
+
+## 2.3 **🛠 Core functions**
+
+```bash
+variables
+color
+catch_errors
+```
+
+- `variables`: Processes input and prepares variables
+- `color`: Sets icons, colors, and formatting
+- `catch_errors`: Enables error handling
+
+---
+
+## 3 **Update function**
+
+### 3.1 **Function Header**
+
+- If applicable write a function that updates the application and the OS in the container.
+- Each update function starts with the same code:
+
+```bash
+function update_script() {
+  header_info
+  check_container_storage
+  check_container_resources
+```
+
+### 3.2 **Check APP**
+
+- Before doing anything update-wise, check if the app is installed in the container.
+
+Example:
+
+```bash
+if [[ ! -d /opt/snipe-it ]]; then
+    msg_error "No ${APP} Installation Found!"
+    exit
+  fi
+```
+
+### 3.3 **Check version**
+
+- Before updating, check if a new version exists.
+  - We use the `${APPLICATION}_version.txt` file created in `/opt` during the install to compare new versions against the currently installed version.
+
+Example with a Github Release:
+
+```bash
+ RELEASE=$(curl -fsSL https://api.github.com/repos/snipe/snipe-it/releases/latest | grep "tag_name" | awk '{print substr($2, 3, length($2)-4) }')
+  if [[ ! -f /opt/${APP}_version.txt ]] || [[ "${RELEASE}" != "$(cat /opt/${APP}_version.txt)" ]]; then
+    msg_info "Updating ${APP} to v${RELEASE}"
+    #DO UPDATE
+  else
+    msg_ok "No update required. ${APP} is already at v${RELEASE}."
+  fi
+  exit
+}
+```
+
+### 3.4 **Verbosity**
+
+- Use the appropriate flag (**-q** in the examples) for a command to suppress its output.
+Example:
+
+```bash
+wget -q
+unzip -q
+```
+
+- If a command does not come with this functionality use `&>/dev/null` to suppress it's output.
+
+Example:
+
+```bash
+php artisan migrate --force &>/dev/null
+php artisan config:clear &>/dev/null
+```
+
+### 3.5 **Backups**
+
+- Backup user data if necessary.
+- Move all user data back in the directory when the update is finished.
+
+>[!NOTE]
+>This is not meant to be a permanent backup
+
+Example backup:
+
+```bash
+  mv /opt/snipe-it /opt/snipe-it-backup
+```
+
+Example config restore:
+
+```bash
+  cp /opt/snipe-it-backup/.env /opt/snipe-it/.env
+  cp -r /opt/snipe-it-backup/public/uploads/ /opt/snipe-it/public/uploads/
+  cp -r /opt/snipe-it-backup/storage/private_uploads /opt/snipe-it/storage/private_uploads
+```
+
+### 3.6 **Cleanup**
+
+- Do not forget to remove any temporary files/folders such as zip-files or temporary backups.
+Example:
+
+```bash
+  rm -rf /opt/v${RELEASE}.zip
+  rm -rf /opt/snipe-it-backup
+```
+
+### 3.7 **No update function**
+
+- In case you can not provide an update function use the following code to provide user feedback.
+
+```bash
+function update_script() {
+    header_info
+    check_container_storage
+    check_container_resources
+    if [[ ! -d /opt/snipeit ]]; then
+        msg_error "No ${APP} Installation Found!"
+        exit
+    fi
+    msg_error "There is currently no automatic update function for ${APP}."
+    exit
+}
+```
+
+---
+
+## 4 **End of the script**
+
+- `start`: Launches Whiptail dialogue
+- `build_container`: Collects and integrates user settings
+- `description`: Sets LXC container description
+- With `echo -e "${TAB}${GATEWAY}${BGN}http://${IP}${CL}"` you can point the user to the IP:PORT/folder needed to access the app.
+
+```bash
+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}"
+```
+
+---
+
+## 5. **Contribution checklist**
+
+- [ ] Shebang is correctly set (`#!/usr/bin/env bash`).
+- [ ] Correct link to *build.func*
+- [ ] Metadata (author, license) is included at the top.
+- [ ] Variables follow naming conventions.
+- [ ] Update function exists.
+- [ ] Update functions checks if app is installed and for new version.
+- [ ] Update function cleans up temporary files.
+- [ ] Script ends with a helpful message for the user to reach the application.
--- a/.github/CONTRIBUTOR_AND_GUIDES/ct/AppName.sh
+++ b/.github/CONTRIBUTOR_AND_GUIDES/ct/AppName.sh
@ -0,0 +1,86 @@
+#!/usr/bin/env bash
+source <(curl -s https://raw.githubusercontent.com/community-scripts/ProxmoxVE/main/misc/build.func)
+# Copyright (c) 2021-2025 community-scripts ORG
+# Author: [YourUserName]
+# License: MIT | https://github.com/community-scripts/ProxmoxVE/raw/main/LICENSE
+# Source: [SOURCE_URL]
+
+# App Default Values
+APP="[APP_NAME]"
+# Name of the app (e.g. Google, Adventurelog, Apache-Guacamole"
+TAGS="[TAGS]"
+# Tags for Proxmox VE, maximum 2 pcs., no spaces allowed, separated by a semicolon ; (e.g. database | adblock;dhcp) 
+var_cpu="[CPU]"
+# Number of cores (1-X) (e.g. 4) - default are 2
+var_ram="[RAM]"
+# Amount of used RAM in MB (e.g. 2048 or 4096)
+var_disk="[DISK]"
+# Amount of used disk space in GB (e.g. 4 or 10)
+var_os="[OS]"
+# Default OS (e.g. debian, ubuntu, alpine)
+var_version="[VERSION]"
+# Default OS version (e.g. 12 for debian, 24.04 for ubuntu, 3.20 for alpine)
+var_unprivileged="[UNPRIVILEGED]"
+# 1 = unprivileged container, 0 = privileged container
+
+header_info "$APP"
+variables
+color
+catch_errors
+
+function update_script() {
+    header_info
+    check_container_storage
+    check_container_resources
+
+    # Check if installation is present | -f for file, -d for folder
+    if [[ ! -f [INSTALLATION_CHECK_PATH] ]]; then
+        msg_error "No ${APP} Installation Found!"
+        exit
+    fi
+
+    # Crawling the new version and checking whether an update is required
+    RELEASE=$(curl -fsSL [RELEASE_URL] | [PARSE_RELEASE_COMMAND])
+    if [[ "${RELEASE}" != "$(cat /opt/${APP}_version.txt)" ]] || [[ ! -f /opt/${APP}_version.txt ]]; then
+        # Stopping Services
+        msg_info "Stopping $APP"
+        systemctl stop [SERVICE_NAME]
+        msg_ok "Stopped $APP"
+
+        # Creating Backup
+        msg_info "Creating Backup"
+        tar -czf "/opt/${APP}_backup_$(date +%F).tar.gz" [IMPORTANT_PATHS]
+        msg_ok "Backup Created"
+
+        # Execute Update
+        msg_info "Updating $APP to v${RELEASE}"
+        [UPDATE_COMMANDS]
+        msg_ok "Updated $APP to v${RELEASE}"
+
+        # Starting Services
+        msg_info "Starting $APP"
+        systemctl start [SERVICE_NAME]
+        msg_ok "Started $APP"
+
+        # Cleaning up
+        msg_info "Cleaning Up"
+        rm -rf [TEMP_FILES]
+        msg_ok "Cleanup Completed"
+
+        # Last Action
+        echo "${RELEASE}" >/opt/${APP}_version.txt
+        msg_ok "Update Successful"
+    else
+        msg_ok "No update required. ${APP} is already at v${RELEASE}"
+    fi
+    exit
+}
+
+start
+build_container
+description
+
+msg_ok "Completed Successfully!\n"
+echo -e "${CREATING}${GN}${APP} setup has been successfully initialized!${CL}"
+echo -e "${INFO}${YW} Access it using the following URL:${CL}"
+echo -e "${TAB}${GATEWAY}${BGN}http://${IP}:[PORT]${CL}"
--- a/.github/CONTRIBUTOR_AND_GUIDES/install/AppName-install.md
+++ b/.github/CONTRIBUTOR_AND_GUIDES/install/AppName-install.md
@ -0,0 +1,353 @@
+
+# **AppName<span></span>-install.sh Scripts**
+
+ `AppName-install.sh` scripts found in the `/install` directory. These scripts are responsible for the installation of the application. For this guide we take `/install/snipeit-install.sh` as example.
+
+## Table of Contents
+
+- [**AppName-install.sh Scripts**](#appname-installsh-scripts)
+  - [Table of Contents](#table-of-contents)
+  - [1. **File header**](#1-file-header)
+    - [1.1 **Shebang**](#11-shebang)
+    - [1.2 **Comments**](#12-comments)
+    - [1.3 **Variables and function import**](#13-variables-and-function-import)
+  - [2. **Variable naming and management**](#2-variable-naming-and-management)
+    - [2.1 **Naming conventions**](#21-naming-conventions)
+  - [3. **Dependencies**](#3-dependencies)
+    - [3.1 **Install all at once**](#31-install-all-at-once)
+    - [3.2 **Collapse dependencies**](#32-collapse-dependencies)
+  - [4. **Paths to application files**](#4-paths-to-application-files)
+  - [5. **Version management**](#5-version-management)
+    - [5.1 **Install the latest release**](#51-install-the-latest-release)
+    - [5.2 **Save the version for update checks**](#52-save-the-version-for-update-checks)
+  - [6. **Input and output management**](#6-input-and-output-management)
+    - [6.1 **User feedback**](#61-user-feedback)
+    - [6.2 **Verbosity**](#62-verbosity)
+  - [7. **String/File Manipulation**](#7-stringfile-manipulation)
+    - [7.1 **File Manipulation**](#71-file-manipulation)
+  - [8. **Security practices**](#8-security-practices)
+    - [8.1 **Password generation**](#81-password-generation)
+    - [8.2 **File permissions**](#82-file-permissions)
+  - [9. **Service Configuration**](#9-service-configuration)
+    - [9.1 **Configuration files**](#91-configuration-files)
+    - [9.2 **Credential management**](#92-credential-management)
+    - [9.3 **Enviroment files**](#93-enviroment-files)
+    - [9.4 **Services**](#94-services)
+  - [10. **Cleanup**](#10-cleanup)
+    - [10.1 **Remove temporary files**](#101-remove-temporary-files)
+    - [10.2 **Autoremove and autoclean**](#102-autoremove-and-autoclean)
+  - [11. **Best Practices Checklist**](#11-best-practices-checklist)
+    - [Example: High-Level Script Flow](#example-high-level-script-flow)
+
+## 1. **File header**
+
+### 1.1 **Shebang**
+
+- Use `#!/usr/bin/env bash` as the shebang.
+
+```bash
+#!/usr/bin/env bash
+```
+
+### 1.2 **Comments**
+
+- Add clear comments for script metadata, including author, copyright, and license information.
+- Use meaningful inline comments to explain complex commands or logic.
+
+Example:
+
+```bash
+# Copyright (c) 2021-2025 community-scripts ORG
+# Author: [YourUserName]
+# License: MIT | https://github.com/community-scripts/ProxmoxVE/raw/main/LICENSE
+# Source: [SOURCE_URL]
+```
+
+> [!NOTE]:
+>
+> - Add your username
+> - When updating/reworking scripts, add "| Co-Author [YourUserName]"
+
+### 1.3 **Variables and function import**
+
+- This sections adds the support for all needed functions and variables.
+
+```bash
+source /dev/stdin <<<"$FUNCTIONS_FILE_PATH"
+color
+verb_ip6
+catch_errors
+setting_up_container
+network_check
+update_os
+```
+
+---
+
+## 2. **Variable naming and management**
+
+### 2.1 **Naming conventions**
+
+- Use uppercase names for constants and environment variables.
+- Use lowercase names for local script variables.
+
+Example:
+
+```bash
+DB_NAME=snipeit_db    # Environment-like variable (constant)
+db_user="snipeit"     # Local variable
+```
+
+---
+
+## 3. **Dependencies**
+
+### 3.1 **Install all at once**
+
+- Install all dependencies with a single command if possible
+
+Example:
+
+```bash
+$STD apt-get install -y \
+  curl \
+  composer \
+  git \
+  sudo \
+  mc \
+  nginx 
+```
+
+### 3.2 **Collapse dependencies**
+
+Collapse dependencies to keep the code readable.
+
+Example:
+Use
+
+```bash
+php8.2-{bcmath,common,ctype}
+```
+
+instead of
+
+```bash
+php8.2-bcmath php8.2-common php8.2-ctype
+```
+
+---
+
+## 4. **Paths to application files**
+
+If possible install the app and all necessary files in `/opt/`
+
+---
+
+## 5. **Version management**
+
+### 5.1 **Install the latest release**
+
+- Always try and install the latest release
+- Do not hardcode any version if not absolutely necessary
+
+Example for a git release:
+
+```bash
+RELEASE=$(curl -fsSL https://api.github.com/repos/snipe/snipe-it/releases/latest | grep "tag_name" | awk '{print substr($2, 3, length($2)-4) }')
+wget -q "https://github.com/snipe/snipe-it/archive/refs/tags/v${RELEASE}.zip"
+```
+
+### 5.2 **Save the version for update checks**
+
+- Write the installed version into a file.
+- This is used for the update function in **AppName.sh** to check for if a Update is needed.
+
+Example:
+
+```bash
+echo "${RELEASE}" >"/opt/AppName_version.txt"
+```
+
+---
+
+## 6. **Input and output management**
+
+### 6.1 **User feedback**
+
+- Use standard functions like `msg_info`, `msg_ok` or `msg_error` to print status messages.
+- Each `msg_info` must be followed with a `msg_ok` before any other output is made.
+- Display meaningful progress messages at key stages.
+
+Example:
+
+```bash
+msg_info "Installing Dependencies"
+$STD apt-get install -y ...
+msg_ok "Installed Dependencies"
+```
+
+### 6.2 **Verbosity**
+
+- Use the appropiate flag (**-q** in the examples) for a command to suppres its output
+Example:
+
+```bash
+wget -q
+unzip -q
+```
+
+- If a command dose not come with such a functionality use `$STD` (a custom standard redirection variable) for managing output verbosity.
+
+Example:
+
+```bash
+$STD apt-get install -y nginx
+```
+
+---
+
+## 7. **String/File Manipulation**
+
+### 7.1 **File Manipulation**
+
+- Use `sed` to replace placeholder values in configuration files.
+
+Example:
+
+```bash
+sed -i -e "s|^DB_DATABASE=.*|DB_DATABASE=$DB_NAME|" \
+       -e "s|^DB_USERNAME=.*|DB_USERNAME=$DB_USER|" \
+       -e "s|^DB_PASSWORD=.*|DB_PASSWORD=$DB_PASS|" .env
+```
+
+---
+
+## 8. **Security practices**
+
+### 8.1 **Password generation**
+
+- Use `openssl` to generate random passwords.
+- Use only alphanumeric values to not introduce unknown behaviour.
+
+Example:
+
+```bash
+DB_PASS=$(openssl rand -base64 18 | tr -dc 'a-zA-Z0-9' | head -c13)
+```
+
+### 8.2 **File permissions**
+
+Explicitly set secure ownership and permissions for sensitive files.
+
+Example:
+
+```bash
+chown -R www-data: /opt/snipe-it
+chmod -R 755 /opt/snipe-it
+```
+
+---
+
+## 9. **Service Configuration**
+
+### 9.1 **Configuration files**
+
+Use `cat <<EOF` to write configuration files in a clean and readable way.
+
+Example:
+
+```bash
+cat <<EOF >/etc/nginx/conf.d/snipeit.conf
+server {
+    listen 80;
+    root /opt/snipe-it/public;
+    index index.php;
+}
+EOF
+```
+
+### 9.2 **Credential management**
+
+Store the generated credentials in a file.
+
+Example:
+
+```bash
+USERNAME=username
+PASSWORD=$(openssl rand -base64 18 | tr -dc 'a-zA-Z0-9' | head -c13)
+{
+    echo "Application-Credentials"
+    echo "Username: $USERNAME"
+    echo "Password: $PASSWORD"
+} >> ~/application.creds
+```
+
+### 9.3 **Enviroment files**
+
+Use `cat <<EOF` to write enviromental files in a clean and readable way.
+
+Example:
+
+```bash
+cat <<EOF >/path/to/.env
+VARIABLE="value"
+PORT=3000
+DB_NAME="${DB_NAME}"
+EOF
+```
+
+### 9.4 **Services**
+
+Enable affected services after configuration changes and start them right away.
+
+Example:
+
+```bash
+systemctl enable -q --now nginx
+```
+
+---
+
+## 10. **Cleanup**
+
+### 10.1 **Remove temporary files**
+
+Remove temporary files and downloads after use.
+
+Example:
+
+```bash
+rm -rf /opt/v${RELEASE}.zip
+```
+
+### 10.2 **Autoremove and autoclean**
+
+Remove unused dependencies to reduce disk space usage.
+
+Example:
+
+```bash
+apt-get -y autoremove
+apt-get -y autoclean
+```
+
+---
+
+## 11. **Best Practices Checklist**
+
+- [ ] Shebang is correctly set (`#!/usr/bin/env bash`).
+- [ ] Metadata (author, license) is included at the top.
+- [ ] Variables follow naming conventions.
+- [ ] Sensitive values are dynamically generated.
+- [ ] Files and services have proper permissions.
+- [ ] Script cleans up temporary files.
+
+---
+
+### Example: High-Level Script Flow
+
+1. Dependencies installation
+2. Database setup
+3. Download and configure application
+4. Service configuration
+5. Final cleanup
--- a/.github/CONTRIBUTOR_AND_GUIDES/install/AppName-install.sh
+++ b/.github/CONTRIBUTOR_AND_GUIDES/install/AppName-install.sh
@ -0,0 +1,83 @@
+#!/usr/bin/env bash
+
+# Copyright (c) 2021-2025 community-scripts ORG
+# Author: [YourUserName]
+# License: MIT | https://github.com/community-scripts/ProxmoxVE/raw/main/LICENSE
+# Source: [SOURCE_URL]
+
+# Import Functions und Setup
+source /dev/stdin <<< "$FUNCTIONS_FILE_PATH"
+color
+verb_ip6
+catch_errors
+setting_up_container
+network_check
+update_os
+
+# Installing Dependencies with the 3 core dependencies (curl;sudo;mc)
+msg_info "Installing Dependencies"
+$STD apt-get install -y \
+  curl \
+  sudo \
+  mc \
+  [PACKAGE_1] \
+  [PACKAGE_2] \
+  [PACKAGE_3]
+msg_ok "Installed Dependencies"
+
+# Template: MySQL Database
+msg_info "Setting up Database"
+DB_NAME=[DB_NAME]
+DB_USER=[DB_USER]
+DB_PASS=$(openssl rand -base64 18 | tr -dc 'a-zA-Z0-9' | head -c13)
+$STD mysql -u root -e "CREATE DATABASE $DB_NAME;"
+$STD mysql -u root -e "CREATE USER '$DB_USER'@'localhost' IDENTIFIED WITH mysql_native_password AS PASSWORD('$DB_PASS');"
+$STD mysql -u root -e "GRANT ALL ON $DB_NAME.* TO '$DB_USER'@'localhost'; FLUSH PRIVILEGES;"
+{
+    echo "${APPLICATION} Credentials"
+    echo "Database User: $DB_USER"
+    echo "Database Password: $DB_PASS"
+    echo "Database Name: $DB_NAME"
+} >> ~/$APP_NAME.creds
+msg_ok "Set up Database"
+
+# Temp
+
+# Setup App
+msg_info "Setup ${APPLICATION}"
+RELEASE=$(curl -s https://api.github.com/repos/[REPO]/releases/latest | grep "tag_name" | awk '{print substr($2, 2, length($2)-3) }')
+wget -q "https://github.com/[REPO]/archive/refs/tags/${RELEASE}.zip"
+unzip -q ${RELEASE}.zip
+mv ${APPLICATION}-${RELEASE}/ /opt/${APPLICATION}
+# 
+# 
+#
+echo "${RELEASE}" >/opt/${APPLICATION}_version.txt
+msg_ok "Setup ${APPLICATION}"
+
+# Creating Service (if needed)
+msg_info "Creating Service"
+cat <<EOF >/etc/systemd/system/${APPLICATION}.service
+[Unit]
+Description=${APPLICATION} Service
+After=network.target
+
+[Service]
+ExecStart=[START_COMMAND]
+Restart=always
+
+[Install]
+WantedBy=multi-user.target
+EOF
+systemctl enable -q --now ${APPLICATION}.service
+msg_ok "Created Service"
+
+motd_ssh
+customize
+
+# Cleanup
+msg_info "Cleaning up"
+rm -f ${RELEASE}.zip
+$STD apt-get -y autoremove
+$STD apt-get -y autoclean
+msg_ok "Cleaned"
--- a/.github/CONTRIBUTOR_AND_GUIDES/json/AppName.json
+++ b/.github/CONTRIBUTOR_AND_GUIDES/json/AppName.json
@ -0,0 +1,34 @@
+{
+    "name": "AppName",
+    "slug": "appname",
+    "categories": [
+        0
+    ],
+    "date_created": "DATE CREATED",
+    "type": "ct",
+    "updateable": true,
+    "privileged": false,
+    "interface_port": DEFAULT-PORT,
+    "documentation": null,
+    "website": "LINK TO WEBSITE",
+    "logo": "LINK TO LOGO",
+    "description": "Description of the app",
+    "install_methods": [
+        {
+            "type": "default",
+            "script": "ct/AppName.sh",
+            "resources": {
+                "cpu": 2,
+                "ram": 2048,
+                "hdd": 4,
+                "os": "debian",
+                "version": "12"
+            }
+        }
+    ],
+    "default_credentials": {
+        "username": null,
+        "password": null
+    },
+    "notes": []
+}
--- a/.github/CONTRIBUTOR_AND_GUIDES/json/AppName.md
+++ b/.github/CONTRIBUTOR_AND_GUIDES/json/AppName.md
@ -0,0 +1,13 @@
+# **AppName<span></span>.json Files**
+
+ `AppName.json` files found in the `/json` directory. These files are used to provide informations for the website. For this guide we take `/json/snipeit.json` as example.
+
+## Table of Contents
+
+- [**AppName.json Files**](#appnamejson-files)
+  - [Table of Contents](#table-of-contents)
+  - [1. JSON Generator](#1-json-generator)
+
+## 1. JSON Generator
+
+Use the [JSON Generator](https://community-scripts.github.io/ProxmoxVE/json-editor) to create this file for your application.