mirror of
https://github.com/community-scripts/ProxmoxVE
synced 2025-01-10 10:55:10 +00:00
First Design: CONTRIBUTING
This commit is contained in:
CanbiZ
parent
493c2c931c
commit
e8f0047b22
14
.github/CONTRIBUTING.md
vendored
14
.github/CONTRIBUTING.md
vendored
@ -1,14 +0,0 @@
|
||||
<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">Contributing to Proxmox VE Helper Scripts</h2>
|
||||
|
||||
Everybody is invited and welcome to contribute to Proxmox VE Helper Scripts.
|
||||
|
||||
- Pull requests submitted against [**main**](https://github.com/community-scripts/ProxmoxVE/tree/main) are meticulously scrutinized, so please do not take it personally if the project maintainer rejects your request. By adhering to the established patterns and conventions throughout the codebase, you greatly increase the likelihood that your changes will get merged into [**main**](https://github.com/community-scripts/ProxmoxVE/tree/main).
|
||||
|
||||
- It is important to stress that complaining about a decision after it has been made is not productive behavior for the pull request submitter. It is crucial for all contributors to respect the decision-making process and collaborate effectively towards achieving the best possible outcome for the project.
|
||||
|
||||
- The repository will only accept Alpine applications that make use of the Alpine Package Keeper.
|
||||
169
.github/CONTRIBUTOR_GUIDE/CONTRIBUTING.md
vendored
Normal file
169
.github/CONTRIBUTOR_GUIDE/CONTRIBUTING.md
vendored
Normal file
@ -0,0 +1,169 @@
|
||||
<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">Contributing to Proxmox VE Helper Scripts</h2>
|
||||
|
||||
Everybody is invited and welcome to contribute to Proxmox VE Helper Scripts.
|
||||
|
||||
- Pull requests submitted against [**main**](https://github.com/community-scripts/ProxmoxVE/tree/main) are meticulously scrutinized, so please do not take it personally if the project maintainer rejects your request. By adhering to the established patterns and conventions throughout the codebase, you greatly increase the likelihood that your changes will get merged into [**main**](https://github.com/community-scripts/ProxmoxVE/tree/main).
|
||||
|
||||
- It is important to stress that complaining about a decision after it has been made is not productive behavior for the pull request submitter. It is crucial for all contributors to respect the decision-making process and collaborate effectively towards achieving the best possible outcome for the project.
|
||||
|
||||
- The repository will only accept Alpine applications that make use of the Alpine Package Keeper.
|
||||
|
||||
## Table of Contents
|
||||
- [Getting Started](#getting-started)
|
||||
- [Script Flow Overview](#script-flow-overview)
|
||||
- [Important Files and Functions](#important-files-and-functions)
|
||||
- [`AppName.sh`](#appnamesh)
|
||||
- [`AppName-install.sh`](#appname-installsh)
|
||||
- [`build.func`](#buildfunc)
|
||||
- [`install.func`](#installfunc)
|
||||
- [`create_lxc`](#create_lxc)
|
||||
- [How to Contribute](#how-to-contribute)
|
||||
- [Forking the Repository](#forking-the-repository)
|
||||
- [Creating a Branch](#creating-a-branch)
|
||||
- [Writing Clear Commit Messages](#writing-clear-commit-messages)
|
||||
- [Submitting a Pull Request](#submitting-a-pull-request)
|
||||
- [Good Practices for Issues and Pull Requests](#good-practices-for-issues-and-pull-requests)
|
||||
- [Issue and Pull Request Templates](#issue-and-pull-request-templates)
|
||||
- [Additional Resources](#additional-resources)
|
||||
|
||||
## Getting Started
|
||||
|
||||
Before contributing to this project, ensure you have the following prerequisites:
|
||||
1. **A Proxmox VE server or testing environment** for verifying your changes.
|
||||
2. **Familiarity with LXC containers**, Proxmox, and **Bash scripting**.
|
||||
3. **A GitHub account** and appropriate access to the repository.
|
||||
|
||||
## Script Flow Overview
|
||||
|
||||
The Proxmox VE Helper Scripts follow a defined sequence when setting up an LXC container or performing other tasks. Here's an overview of the flow:
|
||||
|
||||
## Script Flow Overview
|
||||
|
||||
The Proxmox VE Helper Scripts follow a defined sequence when setting up an LXC container or performing other tasks. Here's an overview of the flow:
|
||||
|
||||
1. **Main Command Execution**
|
||||
The process begins when you execute the following command:
|
||||
```bash
|
||||
bash -c "$(wget -qLO - https://github.com/community-scripts/ProxmoxVE/raw/main/ct/AppName.sh)"
|
||||
```
|
||||
|
||||
2. **Calling `build.func`**
|
||||
The **`AppName.sh`** script invokes **`build.func`**, which prepares the environment for installation and configuration.
|
||||
|
||||
3. **Executing `install.func`**
|
||||
After the environment is set up, **`build.func`** calls **`install.func`**, which handles the installation of necessary software and configuration.
|
||||
|
||||
4. **Creating the LXC Container (`create_lxc`)**
|
||||
Finally, **`install.func`** triggers **`create_lxc`** to create an LXC container with default values (disk size, CPU, RAM, etc.).
|
||||
|
||||
5. **Container Creation Completion**
|
||||
The LXC container is created, and the process concludes by reporting the success or failure of the container setup.
|
||||
|
||||
## Important Files and Functions
|
||||
|
||||
### `AppName.sh`
|
||||
|
||||
This is the main entry script for initiating the process. It is responsible for:
|
||||
- Starting the installation by calling **`build.func`**.
|
||||
- Calling **`install.func`** after system setup.
|
||||
- Managing the flow to ensure the container is correctly created.
|
||||
|
||||
### `AppName-install.sh`
|
||||
|
||||
This script typically manages specific installation tasks, such as setting up software inside the container. It is invoked within **`install.func`**.
|
||||
|
||||
### `build.func`
|
||||
|
||||
The **`build.func`** function:
|
||||
- Prepares the system environment.
|
||||
- Installs necessary packages or tools.
|
||||
- Verifies storage availability and prepares LXC templates.
|
||||
|
||||
### `install.func`
|
||||
|
||||
The **`install.func`** function:
|
||||
- Handles the installation and configuration of software packages inside the container.
|
||||
- Sets up user permissions, network interfaces, and other container settings.
|
||||
|
||||
### `create_lxc`
|
||||
|
||||
The **`create_lxc`** function:
|
||||
- Creates the LXC container using Proxmox commands.
|
||||
- Applies default configurations like disk size, CPU, RAM, and network settings.
|
||||
- Reports on the success or failure of the creation process.
|
||||
|
||||
## How to Contribute
|
||||
|
||||
We welcome contributions to the project! Please follow the steps below to ensure a smooth contribution process.
|
||||
|
||||
### Forking the Repository
|
||||
|
||||
Start by forking the repository to your own GitHub account:
|
||||
1. Navigate to the [repository page](https://github.com/community-scripts/ProxmoxVE).
|
||||
2. Click the **Fork** button in the upper-right corner.
|
||||
|
||||
### Creating a Branch
|
||||
|
||||
Always create a new branch for your changes to avoid conflicts:
|
||||
|
||||
git checkout -b feature/your-feature
|
||||
|
||||
### Writing Clear Commit Messages
|
||||
|
||||
Ensure your commit messages are clear and descriptive:
|
||||
- **Good example:** `Added support for custom disk sizes in create_lxc`
|
||||
- **Bad example:** `Fixed stuff`
|
||||
|
||||
### Submitting a Pull Request
|
||||
|
||||
After pushing your changes to your fork, create a pull request (PR):
|
||||
1. Go to the **Pull Requests** tab on GitHub.
|
||||
2. Click **New Pull Request** and select the branch with your changes.
|
||||
3. Provide a detailed description of your changes, why you made them, and what problem they solve.
|
||||
|
||||
## Good Practices for Issues and Pull Requests
|
||||
|
||||
To help ensure your pull request is accepted and that issues are useful, please follow these best practices:
|
||||
|
||||
### For Pull Requests:
|
||||
- Ensure your code is **well-documented**.
|
||||
- **Test** your changes on a Proxmox environment before submitting.
|
||||
- Follow the **project’s coding style** and conventions.
|
||||
- Link to any relevant **issues** if applicable.
|
||||
|
||||
### For Issues:
|
||||
- Always provide a **clear description** of the problem.
|
||||
- If reporting a bug, include steps to **reproduce** it.
|
||||
- If suggesting a new feature, explain its **use case**.
|
||||
|
||||
## Issue and Pull Request Templates
|
||||
|
||||
We’ve set up templates to make reporting issues and submitting pull requests easier. These templates will guide you in providing the required information for issues and PRs.
|
||||
|
||||
### Issue Template
|
||||
|
||||
The issue template will ask for the following:
|
||||
- Steps to reproduce the issue.
|
||||
- Expected behavior.
|
||||
- Actual behavior.
|
||||
- Any error logs or relevant system information.
|
||||
|
||||
### Pull Request Template
|
||||
|
||||
The pull request template will ask for:
|
||||
- A summary of the changes made.
|
||||
- Any relevant issues the PR addresses.
|
||||
- A description of how to test the changes.
|
||||
|
||||
These templates are automatically populated when you create a new issue or PR.
|
||||
|
||||
## Additional Resources
|
||||
|
||||
- [Proxmox Documentation](https://pve.proxmox.com/pve-docs/)
|
||||
- [GitHub Documentation on Pull Requests](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request)
|
||||
- [Open Source Guides: Starting an Open Source Project](https://opensource.guide/)
|
||||
85
.github/CONTRIBUTOR_GUIDE/ct/AppName.sh
vendored
Normal file
85
.github/CONTRIBUTOR_GUIDE/ct/AppName.sh
vendored
Normal file
@ -0,0 +1,85 @@
|
||||
#!/usr/bin/env bash
|
||||
source <(curl -s https://raw.githubusercontent.com/community-scripts/ProxmoxVE/main/misc/build.func)
|
||||
# Copyright (c) 2021-2024 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]"
|
||||
TAGS="[TAGS]"
|
||||
var_cpu="[CPU]"
|
||||
var_ram="[RAM]"
|
||||
var_disk="[DISK]"
|
||||
var_os="[OS]"
|
||||
var_version="[VERSION]"
|
||||
var_unprivileged="[UNPRIVILEGED]"
|
||||
|
||||
# App Output & Base Settings
|
||||
header_info "$APP"
|
||||
base_settings
|
||||
|
||||
# Core
|
||||
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
|
||||
msg_info "Updating $APP"
|
||||
|
||||
# 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]
|
||||
sleep 2
|
||||
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}"
|
||||
86
.github/CONTRIBUTOR_GUIDE/install/AppName-install.sh
vendored
Normal file
86
.github/CONTRIBUTOR_GUIDE/install/AppName-install.sh
vendored
Normal file
@ -0,0 +1,86 @@
|
||||
#!/usr/bin/env bash
|
||||
|
||||
# Copyright (c) 2021-2024 community-scripts ORG
|
||||
# Author: [YourUserName]
|
||||
# License: MIT
|
||||
# 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"
|
||||
|
||||
motd_ssh
|
||||
customize
|
||||
Loading…
Reference in New Issue
Block a user