[PR #172] [CLOSED] Add Template for Community-Scripts ORG #2420

Closed
opened 2025-11-20 05:29:46 -05:00 by saavagebueno · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/community-scripts/ProxmoxVE/pull/172
Author: @MickLesk
Created: 11/11/2024
Status: Closed

Base: mainHead: main


📝 Commits (2)

  • c838882 Add Template for Community-Scripts ORG
  • 4475644 Update README.md

📊 Changes

4 files changed (+400 additions, -21 deletions)

View changed files

📝 README.md (+96 -21)
template/HOW_TO.md (+64 -0)
template/template-install.sh (+134 -0)
template/template.sh (+106 -0)

📄 Description

Description

Description:
This pull request provides template scripts designed as a starting point for community members who wish to create installation and update scripts for ProjectName on Debian-based systems. These templates are not intended for direct deployment but serve as customizable foundations for various configurations and environments.

Key Features:
Installation Script Template:

Includes placeholders and examples for setting up core dependencies, environment variables, and database configurations.
Demonstrates how to configure PostgreSQL and MariaDB databases, with sections for adding custom dependencies.
Provides an example of fetching the latest ProjectName release from GitHub, handling basic .env configuration, and logging generated credentials.
Annotated sections guide users on customizing installation steps for other required software or specific use cases.
Update Script Template:

Provides a template for checking the current ProjectName version against the latest GitHub release and outlines steps to stop, update, and restart services.
Includes clean-up instructions and prompts to handle limited storage and other update considerations.
Sample messages show users how to add feedback for logging, useful for adapting the template to various projects or requirements.

Notes for Contributors:
These scripts are templates only and require modification before use. Users should adjust database configurations, service names, and environment variables according to their specific project setup.
For any direct project use, please test the customized script on a development server to ensure compatibility and functionality.


🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/community-scripts/ProxmoxVE/pull/172 **Author:** [@MickLesk](https://github.com/MickLesk) **Created:** 11/11/2024 **Status:** ❌ Closed **Base:** `main` ← **Head:** `main` --- ### 📝 Commits (2) - [`c838882`](https://github.com/community-scripts/ProxmoxVE/commit/c8388826d9674eaae584555b841adced1932717f) Add Template for Community-Scripts ORG - [`4475644`](https://github.com/community-scripts/ProxmoxVE/commit/447564485ff0d9b11e2a373086971351024eeb57) Update README.md ### 📊 Changes **4 files changed** (+400 additions, -21 deletions) <details> <summary>View changed files</summary> 📝 `README.md` (+96 -21) ➕ `template/HOW_TO.md` (+64 -0) ➕ `template/template-install.sh` (+134 -0) ➕ `template/template.sh` (+106 -0) </details> ### 📄 Description ## Description **Description:** This pull request provides template scripts designed as a starting point for community members who wish to create installation and update scripts for ProjectName on Debian-based systems. These templates are not intended for direct deployment but serve as customizable foundations for various configurations and environments. **Key Features:** Installation Script Template: Includes placeholders and examples for setting up core dependencies, environment variables, and database configurations. Demonstrates how to configure PostgreSQL and MariaDB databases, with sections for adding custom dependencies. Provides an example of fetching the latest ProjectName release from GitHub, handling basic .env configuration, and logging generated credentials. Annotated sections guide users on customizing installation steps for other required software or specific use cases. Update Script Template: Provides a template for checking the current ProjectName version against the latest GitHub release and outlines steps to stop, update, and restart services. Includes clean-up instructions and prompts to handle limited storage and other update considerations. Sample messages show users how to add feedback for logging, useful for adapting the template to various projects or requirements. **Notes for Contributors:** These scripts are templates only and require modification before use. Users should adjust database configurations, service names, and environment variables according to their specific project setup. For any direct project use, please test the customized script on a development server to ensure compatibility and functionality. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
saavagebueno added the pull-request label 2025-11-20 05:29:46 -05:00
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: SVI/ProxmoxVE#2420