├── icon.png ├── .editorconfig ├── manifests └── c │ └── Corsinvest │ └── cv4pve │ └── nodeprotect │ └── 1.0.0 │ ├── Corsinvest.cv4pve.nodeprotect.yaml │ ├── Corsinvest.cv4pve.nodeprotect.installer.yaml │ └── Corsinvest.cv4pve.nodeprotect.locale.en-US.yaml ├── Directory.Build.props ├── Directory.Packages.props ├── 3rd-party-licenses.md ├── .github └── workflows │ ├── publish.yml │ ├── build.yml │ └── quality.yml ├── .vscode ├── launch.json └── tasks.json ├── src ├── Corsinvest.ProxmoxVE.NodeProtect │ ├── Corsinvest.ProxmoxVE.NodeProtect.csproj │ └── Program.cs └── Corsinvest.ProxmoxVE.NodeProtect.Api │ ├── Corsinvest.ProxmoxVE.NodeProtect.Api.csproj │ └── Application.cs ├── Corsinvest.ProxmoxVE.NodeProtect.sln ├── .gitignore ├── README.MD └── LICENSE.md /icon.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Corsinvest/cv4pve-node-protect/HEAD/icon.png -------------------------------------------------------------------------------- /.editorconfig: -------------------------------------------------------------------------------- 1 | # All files 2 | [*] 3 | guidelines = 80 4 | 5 | # C# or VB files 6 | [*.{cs,vb}] 7 | guidelines = 80, 120 -------------------------------------------------------------------------------- /manifests/c/Corsinvest/cv4pve/nodeprotect/1.0.0/Corsinvest.cv4pve.nodeprotect.yaml: -------------------------------------------------------------------------------- 1 | # Created using wingetcreate 1.10.3.0 2 | # yaml-language-server: $schema=https://aka.ms/winget-manifest.version.1.10.0.schema.json 3 | 4 | PackageIdentifier: Corsinvest.cv4pve.nodeprotect 5 | PackageVersion: 1.0.0 6 | DefaultLocale: en-US 7 | ManifestType: version 8 | ManifestVersion: 1.10.0 9 | -------------------------------------------------------------------------------- /Directory.Build.props: -------------------------------------------------------------------------------- 1 | 2 | 3 | 1.8.0 4 | latest 5 | enable 6 | enable 7 | Corsinvest Srl 8 | Corsinvest Srl 9 | Corsinvest Srl 10 | 11 | 12 | -------------------------------------------------------------------------------- /Directory.Packages.props: -------------------------------------------------------------------------------- 1 | 2 | 3 | true 4 | ..\nupkgs\ 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | -------------------------------------------------------------------------------- /3rd-party-licenses.md: -------------------------------------------------------------------------------- 1 | # License overview of included 3rd party libraries 2 | 3 | The project is licensed under the terms of the [LICENSE.md](LICENSE.md) 4 | 5 | However, includes several third-party Open-Source libraries, which are licensed under their own respective Open-Source licenses. 6 | 7 | ## Libraries directly included 8 | 9 | [Corsinvest ProxmoxVE Api](https://github.com/Corsinvest/cv4pve-api-dotnet) 10 | License: GPLv3 11 | 12 | [Corsinvest ProxmoxVE Api Extension](https://github.com/Corsinvest/cv4pve-api-dotnet) 13 | License: GPLv3 14 | 15 | [Dotnet Core](https://github.com/dotnet/core) 16 | License: MIT 17 | -------------------------------------------------------------------------------- /.github/workflows/publish.yml: -------------------------------------------------------------------------------- 1 | name: Publish 2 | 3 | on: 4 | push: 5 | tags: 6 | - 'v*' 7 | 8 | jobs: 9 | publish: 10 | uses: Corsinvest/.github/.github/workflows/cv4pve-cli-publish.yml@main 11 | secrets: 12 | NUGET_API_KEY: ${{ secrets.NUGET_API_KEY }} 13 | WINGET_TOKEN: ${{ secrets.WINGET_TOKEN }} 14 | with: 15 | project-name: cv4pve-node-protect 16 | project-path: src/Corsinvest.ProxmoxVE.NodeProtect/Corsinvest.ProxmoxVE.NodeProtect.csproj 17 | nuget-project-path: src/Corsinvest.ProxmoxVE.NodeProtect.Api/Corsinvest.ProxmoxVE.NodeProtect.Api.csproj 18 | winget-id: Corsinvest.cv4pve.nodeprotect 19 | -------------------------------------------------------------------------------- /.vscode/launch.json: -------------------------------------------------------------------------------- 1 | { 2 | "version": "0.2.0", 3 | "configurations": [ 4 | { 5 | "name": ".NET Core Launch (console)", 6 | "type": "coreclr", 7 | "request": "launch", 8 | "preLaunchTask": "build", 9 | "program": "${workspaceFolder}/src/Corsinvest.ProxmoxVE.NodeProtect/bin/Debug/net10.0/cv4pve-node-protect.dll", 10 | "args": [ 11 | "@Parm.parm" 12 | ], 13 | "cwd": "${workspaceFolder}/src/Corsinvest.ProxmoxVE.NodeProtect", 14 | "console": "internalConsole", 15 | "stopAtEntry": false 16 | }, 17 | { 18 | "name": ".NET Core Attach", 19 | "type": "coreclr", 20 | "request": "attach" 21 | } 22 | ] 23 | } -------------------------------------------------------------------------------- /.github/workflows/build.yml: -------------------------------------------------------------------------------- 1 | name: Build 2 | 3 | on: 4 | push: 5 | branches: [ "master", "dev" ] 6 | pull_request: 7 | branches: [ "master" ] 8 | workflow_dispatch: 9 | 10 | env: 11 | DOTNET_VERSION: '10.0.x' 12 | 13 | jobs: 14 | build: 15 | runs-on: ubuntu-latest 16 | 17 | steps: 18 | - uses: actions/checkout@v4 19 | with: 20 | fetch-depth: 0 21 | 22 | - name: Setup .NET 23 | uses: actions/setup-dotnet@v4 24 | with: 25 | dotnet-version: ${{ env.DOTNET_VERSION }} 26 | 27 | - name: Restore dependencies 28 | run: dotnet restore 29 | 30 | - name: Build 31 | run: dotnet build --no-restore --configuration Release 32 | 33 | - name: Test 34 | run: dotnet test --no-build --configuration Release --verbosity normal 35 | 36 | - name: Upload Build Artifacts 37 | uses: actions/upload-artifact@v4 38 | with: 39 | name: build-artifacts 40 | path: src/**/bin/Release/ 41 | retention-days: 7 42 | -------------------------------------------------------------------------------- /src/Corsinvest.ProxmoxVE.NodeProtect/Corsinvest.ProxmoxVE.NodeProtect.csproj: -------------------------------------------------------------------------------- 1 | 2 | 3 | Exe 4 | net10.0 5 | cv4pve-node-protect 6 | Corsinvest for Proxmox VE Node Protect 7 | Corsinvest for Proxmox VE Node Protect 8 | Backup and restore tool for Proxmox VE node configurations via SSH. Supports automated backups with retention policies and cluster-wide operations. 9 | true 10 | false 11 | https://github.com/Corsinvest/cv4pve-node-protect 12 | git 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | -------------------------------------------------------------------------------- /.vscode/tasks.json: -------------------------------------------------------------------------------- 1 | { 2 | "version": "2.0.0", 3 | "tasks": [ 4 | { 5 | "label": "build", 6 | "command": "dotnet", 7 | "type": "process", 8 | "args": [ 9 | "build", 10 | "${workspaceFolder}/Corsinvest.ProxmoxVE.NodeProtect.sln", 11 | "/property:GenerateFullPaths=true", 12 | "/consoleloggerparameters:NoSummary;ForceNoAlign" 13 | ], 14 | "problemMatcher": "$msCompile" 15 | }, 16 | { 17 | "label": "publish", 18 | "command": "dotnet", 19 | "type": "process", 20 | "args": [ 21 | "publish", 22 | "${workspaceFolder}/Corsinvest.ProxmoxVE.NodeProtect.sln", 23 | "/property:GenerateFullPaths=true", 24 | "/consoleloggerparameters:NoSummary;ForceNoAlign" 25 | ], 26 | "problemMatcher": "$msCompile" 27 | }, 28 | { 29 | "label": "watch", 30 | "command": "dotnet", 31 | "type": "process", 32 | "args": [ 33 | "watch", 34 | "run", 35 | "--project", 36 | "${workspaceFolder}/Corsinvest.ProxmoxVE.NodeProtect.sln" 37 | ], 38 | "problemMatcher": "$msCompile" 39 | } 40 | ] 41 | } -------------------------------------------------------------------------------- /manifests/c/Corsinvest/cv4pve/nodeprotect/1.0.0/Corsinvest.cv4pve.nodeprotect.installer.yaml: -------------------------------------------------------------------------------- 1 | # Created using wingetcreate 1.10.3.0 2 | # yaml-language-server: $schema=https://aka.ms/winget-manifest.installer.1.10.0.schema.json 3 | 4 | PackageIdentifier: Corsinvest.cv4pve.nodeprotect 5 | PackageVersion: 1.0.0 6 | InstallerType: portable 7 | Commands: 8 | - cv4pve-node-protect 9 | ReleaseDate: 2025-01-01 10 | Installers: 11 | - Architecture: x64 12 | InstallerUrl: https://github.com/Corsinvest/cv4pve-node-protect/releases/download/v1.0.0/cv4pve-node-protect.exe-win-x64.zip 13 | InstallerSha256: PLACEHOLDER_SHA256_X64 14 | NestedInstallerType: portable 15 | NestedInstallerFiles: 16 | - RelativeFilePath: cv4pve-node-protect.exe 17 | PortableCommandAlias: cv4pve-node-protect 18 | - Architecture: x86 19 | InstallerUrl: https://github.com/Corsinvest/cv4pve-node-protect/releases/download/v1.0.0/cv4pve-node-protect.exe-win-x86.zip 20 | InstallerSha256: PLACEHOLDER_SHA256_X86 21 | NestedInstallerType: portable 22 | NestedInstallerFiles: 23 | - RelativeFilePath: cv4pve-node-protect.exe 24 | PortableCommandAlias: cv4pve-node-protect 25 | - Architecture: arm64 26 | InstallerUrl: https://github.com/Corsinvest/cv4pve-node-protect/releases/download/v1.0.0/cv4pve-node-protect.exe-win-arm64.zip 27 | InstallerSha256: PLACEHOLDER_SHA256_ARM64 28 | NestedInstallerType: portable 29 | NestedInstallerFiles: 30 | - RelativeFilePath: cv4pve-node-protect.exe 31 | PortableCommandAlias: cv4pve-node-protect 32 | ManifestType: installer 33 | ManifestVersion: 1.10.0 34 | -------------------------------------------------------------------------------- /.github/workflows/quality.yml: -------------------------------------------------------------------------------- 1 | name: Quality 2 | 3 | on: 4 | push: 5 | branches: [ "master", "dev" ] 6 | pull_request: 7 | branches: [ "master" ] 8 | workflow_dispatch: 9 | 10 | env: 11 | DOTNET_VERSION: '10.0.x' 12 | 13 | jobs: 14 | analyze: 15 | name: Analyze 16 | runs-on: ubuntu-latest 17 | permissions: 18 | actions: read 19 | contents: read 20 | security-events: write 21 | 22 | steps: 23 | - name: Checkout repository 24 | uses: actions/checkout@v4 25 | with: 26 | fetch-depth: 0 27 | 28 | - name: Initialize CodeQL 29 | uses: github/codeql-action/init@v3 30 | with: 31 | languages: 'csharp' 32 | 33 | - name: Setup .NET 34 | uses: actions/setup-dotnet@v4 35 | with: 36 | dotnet-version: ${{ env.DOTNET_VERSION }} 37 | 38 | - name: Restore dependencies 39 | run: dotnet restore 40 | 41 | - name: Build 42 | run: dotnet build --no-restore --configuration Release 43 | 44 | - name: Perform CodeQL Analysis 45 | uses: github/codeql-action/analyze@v3 46 | 47 | lint: 48 | name: Lint 49 | runs-on: ubuntu-latest 50 | 51 | steps: 52 | - name: Checkout repository 53 | uses: actions/checkout@v4 54 | with: 55 | fetch-depth: 0 56 | 57 | - name: Setup .NET 58 | uses: actions/setup-dotnet@v4 59 | with: 60 | dotnet-version: ${{ env.DOTNET_VERSION }} 61 | 62 | - name: Restore dependencies 63 | run: dotnet restore 64 | 65 | - name: Lint with dotnet format 66 | run: | 67 | dotnet format --verify-no-changes --severity error 68 | -------------------------------------------------------------------------------- /src/Corsinvest.ProxmoxVE.NodeProtect.Api/Corsinvest.ProxmoxVE.NodeProtect.Api.csproj: -------------------------------------------------------------------------------- 1 | 2 | 3 | net8.0;net9.0;net10.0 4 | Library 5 | 6 | https://github.com/Corsinvest/cv4pve-node-protect 7 | icon.png 8 | README.md 9 | ProxmoxVE;Proxmox;Backup;Configuration;SSH;Node;Protection;Cluster;Api;Client;Rest;Corsinvest 10 | GPL-3.0-only 11 | ..\..\..\.nupkgs\ 12 | git 13 | https://github.com/Corsinvest/cv4pve-node-protect 14 | true 15 | true 16 | True 17 | 18 | 19 | $(AllowedOutputExtensionsInPackageBuildOutputFolder);.pdb 20 | 21 | true 22 | snupkg 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | -------------------------------------------------------------------------------- /manifests/c/Corsinvest/cv4pve/nodeprotect/1.0.0/Corsinvest.cv4pve.nodeprotect.locale.en-US.yaml: -------------------------------------------------------------------------------- 1 | # Created using wingetcreate 1.10.3.0 2 | # yaml-language-server: $schema=https://aka.ms/winget-manifest.defaultLocale.1.10.0.schema.json 3 | 4 | PackageIdentifier: Corsinvest.cv4pve.nodeprotect 5 | PackageVersion: 1.0.0 6 | PackageLocale: en-US 7 | Publisher: Corsinvest Srl 8 | PublisherUrl: https://www.corsinvest.it 9 | PublisherSupportUrl: https://www.corsinvest.it/cv4pve 10 | PrivacyUrl: https://www.corsinvest.it/privacy 11 | Author: Corsinvest Srl 12 | PackageName: cv4pve-node-protect 13 | PackageUrl: https://github.com/Corsinvest/cv4pve-node-protect 14 | License: GPL-3.0-only 15 | LicenseUrl: https://github.com/Corsinvest/cv4pve-node-protect/blob/master/LICENSE.md 16 | Copyright: Copyright (c) 2019-2025 Corsinvest Srl 17 | CopyrightUrl: https://github.com/Corsinvest/cv4pve-node-protect/blob/master/LICENSE.md 18 | ShortDescription: Node Protection Tool for Proxmox VE 19 | Description: |- 20 | cv4pve-node-protect is a node configuration backup tool for Proxmox VE. 21 | It creates backups of node configuration files using SSH and supports retention policies. 22 | 23 | Features: 24 | - Automatic node configuration backup via SSH 25 | - Support for multiple nodes simultaneously 26 | - Configurable retention policies 27 | - Custom path selection for backup 28 | - Upload/restore configuration capabilities 29 | - Automated cleanup of old backups 30 | - Compression (tar.gz format) 31 | - Directory organization by timestamp 32 | Moniker: cv4pve-node-protect 33 | Tags: 34 | - automation 35 | - backup 36 | - configuration 37 | - corsinvest 38 | - node 39 | - protect 40 | - proxmox 41 | - proxmoxve 42 | - ssh 43 | ReleaseNotesUrl: https://github.com/Corsinvest/cv4pve-node-protect/releases/tag/v1.0.0 44 | ManifestType: defaultLocale 45 | ManifestVersion: 1.10.0 46 | -------------------------------------------------------------------------------- /src/Corsinvest.ProxmoxVE.NodeProtect/Program.cs: -------------------------------------------------------------------------------- 1 | /* 2 | * SPDX-License-Identifier: GPL-3.0-only 3 | * SPDX-FileCopyrightText: 2019 Copyright Corsinvest Srl 4 | */ 5 | 6 | using Corsinvest.ProxmoxVE.Api.Console.Helpers; 7 | using Corsinvest.ProxmoxVE.NodeProtect.Api; 8 | using Microsoft.Extensions.Logging; 9 | 10 | var app = ConsoleHelper.CreateApp("cv4pve-node-protect", "Node protect for Proxmox VE"); 11 | app.Options.Remove(app.GetApiTokenOption()); 12 | app.Options.Remove(app.GetValidateCertificateOption()); 13 | 14 | var loggerFactory = ConsoleHelper.CreateLoggerFactory(app.GetLogLevelFromDebug()); 15 | 16 | app.GetUsernameOption().Description = "User name"; 17 | app.GetPasswordOption().Description = "The Password"; 18 | 19 | var cmdUpload = app.AddCommand("upload", "Upload configuration tar.gz to node"); 20 | var optDirectoryWorkUpload = cmdUpload.AddOption("--directory-work", "Directory work") 21 | .AddValidatorExistDirectory(); 22 | 23 | cmdUpload.SetAction((action) => Application.UploadToNode(action.GetValue(app.GetHostOption())!, 24 | action.GetValue(app.GetUsernameOption())!, 25 | action.GetValue(app.GetPasswordOption())!, 26 | action.GetValue(optDirectoryWorkUpload)!, 27 | loggerFactory)); 28 | 29 | var cmdBackup = app.AddCommand("backup", "Backup configuration form nodes using ssh"); 30 | var optKeep = cmdBackup.AddOption("--keep", "Specify the number which should will keep") 31 | .AddValidatorRange(1, 100); 32 | optKeep.Required = true; 33 | 34 | var optPathBackup = cmdBackup.AddOption("--paths", "Paths to backup ';' separated"); 35 | var optDirectoryWorkBackup = cmdBackup.AddOption("--directory-work", "Directory work") 36 | .AddValidatorExistDirectory(); 37 | 38 | cmdBackup.SetAction((action) => Application.Backup(action.GetValue(app.GetHostOption())!, 39 | action.GetValue(app.GetUsernameOption())!, 40 | action.GetValue(app.GetPasswordOption())!, 41 | action.GetValue(optPathBackup)!.Split(';'), 42 | action.GetValue(optDirectoryWorkBackup)!, 43 | action.GetValue(optKeep)!, 44 | Console.Out, 45 | loggerFactory)); 46 | 47 | return await app.ExecuteAppAsync(args, loggerFactory.CreateLogger(typeof(Program))); -------------------------------------------------------------------------------- /Corsinvest.ProxmoxVE.NodeProtect.sln: -------------------------------------------------------------------------------- 1 | 2 | Microsoft Visual Studio Solution File, Format Version 12.00 3 | # Visual Studio 15 4 | VisualStudioVersion = 15.0.26124.0 5 | MinimumVisualStudioVersion = 15.0.26124.0 6 | Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "src", "src", "{246273BF-85BC-40D0-A0AD-AFF8D60773FA}" 7 | EndProject 8 | Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Corsinvest.ProxmoxVE.NodeProtect", "src\Corsinvest.ProxmoxVE.NodeProtect\Corsinvest.ProxmoxVE.NodeProtect.csproj", "{FC2BD4B4-6EEE-4013-BB61-38643C7F6BB6}" 9 | EndProject 10 | Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Corsinvest.ProxmoxVE.NodeProtect.Api", "src\Corsinvest.ProxmoxVE.NodeProtect.Api\Corsinvest.ProxmoxVE.NodeProtect.Api.csproj", "{CD1FC938-F017-459E-83D0-33FBDEC679FA}" 11 | EndProject 12 | Global 13 | GlobalSection(SolutionConfigurationPlatforms) = preSolution 14 | Debug|Any CPU = Debug|Any CPU 15 | Debug|x64 = Debug|x64 16 | Debug|x86 = Debug|x86 17 | Release|Any CPU = Release|Any CPU 18 | Release|x64 = Release|x64 19 | Release|x86 = Release|x86 20 | EndGlobalSection 21 | GlobalSection(SolutionProperties) = preSolution 22 | HideSolutionNode = FALSE 23 | EndGlobalSection 24 | GlobalSection(ProjectConfigurationPlatforms) = postSolution 25 | {FC2BD4B4-6EEE-4013-BB61-38643C7F6BB6}.Debug|Any CPU.ActiveCfg = Debug|Any CPU 26 | {FC2BD4B4-6EEE-4013-BB61-38643C7F6BB6}.Debug|Any CPU.Build.0 = Debug|Any CPU 27 | {FC2BD4B4-6EEE-4013-BB61-38643C7F6BB6}.Debug|x64.ActiveCfg = Debug|Any CPU 28 | {FC2BD4B4-6EEE-4013-BB61-38643C7F6BB6}.Debug|x64.Build.0 = Debug|Any CPU 29 | {FC2BD4B4-6EEE-4013-BB61-38643C7F6BB6}.Debug|x86.ActiveCfg = Debug|Any CPU 30 | {FC2BD4B4-6EEE-4013-BB61-38643C7F6BB6}.Debug|x86.Build.0 = Debug|Any CPU 31 | {FC2BD4B4-6EEE-4013-BB61-38643C7F6BB6}.Release|Any CPU.ActiveCfg = Release|Any CPU 32 | {FC2BD4B4-6EEE-4013-BB61-38643C7F6BB6}.Release|Any CPU.Build.0 = Release|Any CPU 33 | {FC2BD4B4-6EEE-4013-BB61-38643C7F6BB6}.Release|x64.ActiveCfg = Release|Any CPU 34 | {FC2BD4B4-6EEE-4013-BB61-38643C7F6BB6}.Release|x64.Build.0 = Release|Any CPU 35 | {FC2BD4B4-6EEE-4013-BB61-38643C7F6BB6}.Release|x86.ActiveCfg = Release|Any CPU 36 | {FC2BD4B4-6EEE-4013-BB61-38643C7F6BB6}.Release|x86.Build.0 = Release|Any CPU 37 | {CD1FC938-F017-459E-83D0-33FBDEC679FA}.Debug|Any CPU.ActiveCfg = Debug|Any CPU 38 | {CD1FC938-F017-459E-83D0-33FBDEC679FA}.Debug|Any CPU.Build.0 = Debug|Any CPU 39 | {CD1FC938-F017-459E-83D0-33FBDEC679FA}.Debug|x64.ActiveCfg = Debug|Any CPU 40 | {CD1FC938-F017-459E-83D0-33FBDEC679FA}.Debug|x64.Build.0 = Debug|Any CPU 41 | {CD1FC938-F017-459E-83D0-33FBDEC679FA}.Debug|x86.ActiveCfg = Debug|Any CPU 42 | {CD1FC938-F017-459E-83D0-33FBDEC679FA}.Debug|x86.Build.0 = Debug|Any CPU 43 | {CD1FC938-F017-459E-83D0-33FBDEC679FA}.Release|Any CPU.ActiveCfg = Release|Any CPU 44 | {CD1FC938-F017-459E-83D0-33FBDEC679FA}.Release|Any CPU.Build.0 = Release|Any CPU 45 | {CD1FC938-F017-459E-83D0-33FBDEC679FA}.Release|x64.ActiveCfg = Release|Any CPU 46 | {CD1FC938-F017-459E-83D0-33FBDEC679FA}.Release|x64.Build.0 = Release|Any CPU 47 | {CD1FC938-F017-459E-83D0-33FBDEC679FA}.Release|x86.ActiveCfg = Release|Any CPU 48 | {CD1FC938-F017-459E-83D0-33FBDEC679FA}.Release|x86.Build.0 = Release|Any CPU 49 | EndGlobalSection 50 | GlobalSection(NestedProjects) = preSolution 51 | {FC2BD4B4-6EEE-4013-BB61-38643C7F6BB6} = {246273BF-85BC-40D0-A0AD-AFF8D60773FA} 52 | {CD1FC938-F017-459E-83D0-33FBDEC679FA} = {246273BF-85BC-40D0-A0AD-AFF8D60773FA} 53 | EndGlobalSection 54 | EndGlobal 55 | -------------------------------------------------------------------------------- /src/Corsinvest.ProxmoxVE.NodeProtect.Api/Application.cs: -------------------------------------------------------------------------------- 1 | /* 2 | * SPDX-License-Identifier: GPL-3.0-only 3 | * SPDX-FileCopyrightText: 2019 Copyright Corsinvest Srl 4 | */ 5 | 6 | using Microsoft.Extensions.Logging; 7 | using Renci.SshNet; 8 | 9 | namespace Corsinvest.ProxmoxVE.NodeProtect.Api; 10 | 11 | /// 12 | /// Node protect 13 | /// 14 | public class Application 15 | { 16 | /// 17 | /// Date format directory 18 | /// 19 | public static readonly string FORMAT_DATE = "yyyy-MM-dd-HH-mm-ss"; 20 | 21 | private const string FILE_NAME = "-config.tar.gz"; 22 | 23 | private static DateTime DirectoryToDate(string directory) 24 | => DateTime.ParseExact(Path.GetFileName(directory), FORMAT_DATE, null); 25 | 26 | private static string FileNameLinuxTarGz(DateTime date) => $"/tmp/{date.ToString(FORMAT_DATE)}.tar.gz"; 27 | 28 | private static (string Host, int Port) ParseHostAndPort(string hostAndPort) 29 | { 30 | var data = hostAndPort.Split(':'); 31 | var host = data[0]; 32 | var port = data.Length == 2 33 | ? int.TryParse(data[1], out var result2) ? result2 : 22 34 | : 22; 35 | 36 | return (host, port); 37 | } 38 | 39 | 40 | /// 41 | /// Backup 42 | /// 43 | /// 44 | /// 45 | /// 46 | /// 47 | /// 48 | /// 49 | /// 50 | /// 51 | public static void Backup(string hostsAndPort, 52 | string username, 53 | string password, 54 | string[] pathsToBackup, 55 | string directoryWork, 56 | int keep, 57 | TextWriter @out, 58 | ILoggerFactory loggerFactory) 59 | { 60 | var logger = loggerFactory.CreateLogger(); 61 | 62 | @out.WriteLine($@"ACTION Backup 63 | Keep: {keep} 64 | Directory Work: {directoryWork} 65 | Directory Node to archive:"); 66 | 67 | foreach (var item in pathsToBackup) { @out.WriteLine(item); } 68 | 69 | var date = DateTime.Now; 70 | var fileNameTarGz = FileNameLinuxTarGz(date); 71 | 72 | //create folder date 73 | var pathSave = Path.Combine(directoryWork, date.ToString(FORMAT_DATE)); 74 | Directory.CreateDirectory(pathSave); 75 | 76 | foreach (var hostAndPort in hostsAndPort.Split(',')) 77 | { 78 | var (host, port) = ParseHostAndPort(hostAndPort); 79 | 80 | // Execute a (SHELL) Command for download 81 | using var sshClient = new SshClient(host, port, username, password); 82 | //create tar 83 | sshClient.Connect(); 84 | 85 | var cmdCreateTarGz = $"tar -cvzPf {fileNameTarGz} {string.Join(" ", pathsToBackup)}"; 86 | var retCmd = sshClient.CreateCommand(cmdCreateTarGz).Execute(); 87 | 88 | logger.LogDebug("Create file tar.gz: {cmdCreateTarGz}", cmdCreateTarGz); 89 | logger.LogDebug("Result command: {retCmd}", retCmd); 90 | 91 | var fileToSave = Path.Combine(pathSave, $"{host}{FILE_NAME}"); 92 | 93 | // download 94 | using var sftp = new SftpClient(host, port, username, password); 95 | using var stream = File.OpenWrite(fileToSave); 96 | sftp.Connect(); 97 | 98 | logger.LogDebug("Download file tar.gz: {fileNameTarGz} to {fileToSave}", fileNameTarGz, fileToSave); 99 | 100 | sftp.DownloadFile(fileNameTarGz, stream); 101 | sftp.Disconnect(); 102 | 103 | //delete tar 104 | var cmdRmTarGz = $"rm {fileNameTarGz}"; 105 | retCmd = sshClient.CreateCommand(cmdRmTarGz).Execute(); 106 | 107 | logger.LogDebug("Delete tar.gz: {cmdRmTarGz}", cmdRmTarGz); 108 | logger.LogDebug("Result command: {retCmd}", retCmd); 109 | 110 | sshClient.Disconnect(); 111 | 112 | @out.WriteLine($"Create config: {fileToSave}"); 113 | } 114 | 115 | //keep 116 | foreach (var directoryBackupDateTime in Directory.GetDirectories(directoryWork) 117 | .OrderByDescending(a => a) 118 | .Skip(keep)) 119 | { 120 | Delete(directoryBackupDateTime, @out); 121 | } 122 | } 123 | 124 | /// 125 | /// Delete directory 126 | /// 127 | /// 128 | /// 129 | public static void Delete(string directoryBackupDateTime, TextWriter @out) 130 | { 131 | @out.WriteLine($"Delete Backup: {directoryBackupDateTime}"); 132 | Directory.Delete(directoryBackupDateTime, true); 133 | } 134 | 135 | /// 136 | /// Upload file config TarGz to node 137 | /// 138 | /// 139 | /// 140 | /// 141 | /// 142 | /// 143 | public static void UploadToNode(string hostsAndPort, 144 | string username, 145 | string password, 146 | string fileTarGz, 147 | ILoggerFactory loggerFactory) 148 | { 149 | var logger = loggerFactory.CreateLogger(); 150 | 151 | foreach (var hostAndPort in hostsAndPort.Split(',')) 152 | { 153 | var (host, port) = ParseHostAndPort(hostAndPort); 154 | if (host == fileTarGz[..fileTarGz.IndexOf(FILE_NAME)]) 155 | { 156 | var fileName = FileNameLinuxTarGz(DirectoryToDate(fileTarGz)); 157 | 158 | logger.LogDebug("Host: {host}:{port}", host, port); 159 | 160 | //upload 161 | using var sftp = new SftpClient(host, port, username, password); 162 | using var stream = File.OpenRead(fileTarGz); 163 | sftp.Connect(); 164 | 165 | logger.LogDebug("File upload: {fileName}", fileName); 166 | 167 | sftp.UploadFile(stream, fileName); 168 | sftp.Disconnect(); 169 | 170 | break; 171 | } 172 | } 173 | } 174 | } -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | ## Ignore Visual Studio temporary files, build results, and 2 | ## files generated by popular Visual Studio add-ons. 3 | ## 4 | ## Get latest from https://github.com/github/gitignore/blob/master/VisualStudio.gitignore 5 | 6 | # User-specific files 7 | *.suo 8 | *.user 9 | *.userosscache 10 | *.sln.docstates 11 | 12 | # User-specific files (MonoDevelop/Xamarin Studio) 13 | *.userprefs 14 | 15 | # Build results 16 | [Dd]ebug/ 17 | [Dd]ebugPublic/ 18 | [Rr]elease/ 19 | [Rr]eleases/ 20 | x64/ 21 | x86/ 22 | bld/ 23 | [Bb]in/ 24 | [Oo]bj/ 25 | [Ll]og/ 26 | 27 | # Visual Studio 2015/2017 cache/options directory 28 | .vs/ 29 | # Uncomment if you have tasks that create the project's static files in wwwroot 30 | #wwwroot/ 31 | 32 | # Visual Studio 2017 auto generated files 33 | Generated\ Files/ 34 | 35 | # MSTest test Results 36 | [Tt]est[Rr]esult*/ 37 | [Bb]uild[Ll]og.* 38 | 39 | # NUNIT 40 | *.VisualState.xml 41 | TestResult.xml 42 | 43 | # Build Results of an ATL Project 44 | [Dd]ebugPS/ 45 | [Rr]eleasePS/ 46 | dlldata.c 47 | 48 | # Benchmark Results 49 | BenchmarkDotNet.Artifacts/ 50 | 51 | # .NET Core 52 | project.lock.json 53 | project.fragment.lock.json 54 | artifacts/ 55 | **/Properties/launchSettings.json 56 | 57 | # StyleCop 58 | StyleCopReport.xml 59 | 60 | # Files built by Visual Studio 61 | *_i.c 62 | *_p.c 63 | *_i.h 64 | *.ilk 65 | *.meta 66 | *.obj 67 | *.iobj 68 | *.pch 69 | *.pdb 70 | *.ipdb 71 | *.pgc 72 | *.pgd 73 | *.rsp 74 | *.sbr 75 | *.tlb 76 | *.tli 77 | *.tlh 78 | *.tmp 79 | *.tmp_proj 80 | *.log 81 | *.vspscc 82 | *.vssscc 83 | .builds 84 | *.pidb 85 | *.svclog 86 | *.scc 87 | 88 | # Chutzpah Test files 89 | _Chutzpah* 90 | 91 | # Visual C++ cache files 92 | ipch/ 93 | *.aps 94 | *.ncb 95 | *.opendb 96 | *.opensdf 97 | *.sdf 98 | *.cachefile 99 | *.VC.db 100 | *.VC.VC.opendb 101 | 102 | # Visual Studio profiler 103 | *.psess 104 | *.vsp 105 | *.vspx 106 | *.sap 107 | 108 | # Visual Studio Trace Files 109 | *.e2e 110 | 111 | # TFS 2012 Local Workspace 112 | $tf/ 113 | 114 | # Guidance Automation Toolkit 115 | *.gpState 116 | 117 | # ReSharper is a .NET coding add-in 118 | _ReSharper*/ 119 | *.[Rr]e[Ss]harper 120 | *.DotSettings.user 121 | 122 | # JustCode is a .NET coding add-in 123 | .JustCode 124 | 125 | # TeamCity is a build add-in 126 | _TeamCity* 127 | 128 | # DotCover is a Code Coverage Tool 129 | *.dotCover 130 | 131 | # AxoCover is a Code Coverage Tool 132 | .axoCover/* 133 | !.axoCover/settings.json 134 | 135 | # Visual Studio code coverage results 136 | *.coverage 137 | *.coveragexml 138 | 139 | # NCrunch 140 | _NCrunch_* 141 | .*crunch*.local.xml 142 | nCrunchTemp_* 143 | 144 | # MightyMoose 145 | *.mm.* 146 | AutoTest.Net/ 147 | 148 | # Web workbench (sass) 149 | .sass-cache/ 150 | 151 | # Installshield output folder 152 | [Ee]xpress/ 153 | 154 | # DocProject is a documentation generator add-in 155 | DocProject/buildhelp/ 156 | DocProject/Help/*.HxT 157 | DocProject/Help/*.HxC 158 | DocProject/Help/*.hhc 159 | DocProject/Help/*.hhk 160 | DocProject/Help/*.hhp 161 | DocProject/Help/Html2 162 | DocProject/Help/html 163 | 164 | # Click-Once directory 165 | publish/ 166 | 167 | # Publish Web Output 168 | *.[Pp]ublish.xml 169 | *.azurePubxml 170 | # Note: Comment the next line if you want to checkin your web deploy settings, 171 | # but database connection strings (with potential passwords) will be unencrypted 172 | *.pubxml 173 | *.publishproj 174 | 175 | # Microsoft Azure Web App publish settings. Comment the next line if you want to 176 | # checkin your Azure Web App publish settings, but sensitive information contained 177 | # in these scripts will be unencrypted 178 | PublishScripts/ 179 | 180 | # NuGet Packages 181 | *.nupkg 182 | # The packages folder can be ignored because of Package Restore 183 | **/[Pp]ackages/* 184 | # except build/, which is used as an MSBuild target. 185 | !**/[Pp]ackages/build/ 186 | # Uncomment if necessary however generally it will be regenerated when needed 187 | #!**/[Pp]ackages/repositories.config 188 | # NuGet v3's project.json files produces more ignorable files 189 | *.nuget.props 190 | *.nuget.targets 191 | 192 | # Microsoft Azure Build Output 193 | csx/ 194 | *.build.csdef 195 | 196 | # Microsoft Azure Emulator 197 | ecf/ 198 | rcf/ 199 | 200 | # Windows Store app package directories and files 201 | AppPackages/ 202 | BundleArtifacts/ 203 | Package.StoreAssociation.xml 204 | _pkginfo.txt 205 | *.appx 206 | 207 | # Visual Studio cache files 208 | # files ending in .cache can be ignored 209 | *.[Cc]ache 210 | # but keep track of directories ending in .cache 211 | !*.[Cc]ache/ 212 | 213 | # Others 214 | ClientBin/ 215 | ~$* 216 | *~ 217 | *.dbmdl 218 | *.dbproj.schemaview 219 | *.jfm 220 | *.pfx 221 | *.publishsettings 222 | orleans.codegen.cs 223 | 224 | # Including strong name files can present a security risk 225 | # (https://github.com/github/gitignore/pull/2483#issue-259490424) 226 | #*.snk 227 | 228 | # Since there are multiple workflows, uncomment next line to ignore bower_components 229 | # (https://github.com/github/gitignore/pull/1529#issuecomment-104372622) 230 | #bower_components/ 231 | 232 | # RIA/Silverlight projects 233 | Generated_Code/ 234 | 235 | # Backup & report files from converting an old project file 236 | # to a newer Visual Studio version. Backup files are not needed, 237 | # because we have git ;-) 238 | _UpgradeReport_Files/ 239 | Backup*/ 240 | UpgradeLog*.XML 241 | UpgradeLog*.htm 242 | ServiceFabricBackup/ 243 | *.rptproj.bak 244 | 245 | # SQL Server files 246 | *.mdf 247 | *.ldf 248 | *.ndf 249 | 250 | # Business Intelligence projects 251 | *.rdl.data 252 | *.bim.layout 253 | *.bim_*.settings 254 | *.rptproj.rsuser 255 | 256 | # Microsoft Fakes 257 | FakesAssemblies/ 258 | 259 | # GhostDoc plugin setting file 260 | *.GhostDoc.xml 261 | 262 | # Node.js Tools for Visual Studio 263 | .ntvs_analysis.dat 264 | node_modules/ 265 | 266 | # Visual Studio 6 build log 267 | *.plg 268 | 269 | # Visual Studio 6 workspace options file 270 | *.opt 271 | 272 | # Visual Studio 6 auto-generated workspace file (contains which files were open etc.) 273 | *.vbw 274 | 275 | # Visual Studio LightSwitch build output 276 | **/*.HTMLClient/GeneratedArtifacts 277 | **/*.DesktopClient/GeneratedArtifacts 278 | **/*.DesktopClient/ModelManifest.xml 279 | **/*.Server/GeneratedArtifacts 280 | **/*.Server/ModelManifest.xml 281 | _Pvt_Extensions 282 | 283 | # Paket dependency manager 284 | .paket/paket.exe 285 | paket-files/ 286 | 287 | # FAKE - F# Make 288 | .fake/ 289 | 290 | # JetBrains Rider 291 | .idea/ 292 | *.sln.iml 293 | 294 | # CodeRush 295 | .cr/ 296 | 297 | # Python Tools for Visual Studio (PTVS) 298 | __pycache__/ 299 | *.pyc 300 | 301 | # Cake - Uncomment if you are using it 302 | # tools/** 303 | # !tools/packages.config 304 | 305 | # Tabs Studio 306 | *.tss 307 | 308 | # Telerik's JustMock configuration file 309 | *.jmconfig 310 | 311 | # BizTalk build output 312 | *.btp.cs 313 | *.btm.cs 314 | *.odx.cs 315 | *.xsd.cs 316 | 317 | # OpenCover UI analysis results 318 | OpenCover/ 319 | 320 | # Azure Stream Analytics local run output 321 | ASALocalRun/ 322 | 323 | # MSBuild Binary and Structured Log 324 | *.binlog 325 | 326 | # NVidia Nsight GPU debugger configuration file 327 | *.nvuser 328 | 329 | # MFractors (Xamarin productivity tool) working folder 330 | .mfractor/ 331 | 332 | *.Parm 333 | 334 | .claude -------------------------------------------------------------------------------- /README.MD: -------------------------------------------------------------------------------- 1 | # cv4pve-node-protect 2 | 3 | ``` 4 | ______ _ __ 5 | / ____/___ __________(_)___ _ _____ _____/ /_ 6 | / / / __ \/ ___/ ___/ / __ \ | / / _ \/ ___/ __/ 7 | / /___/ /_/ / / (__ ) / / / / |/ / __(__ ) /_ 8 | \____/\____/_/ /____/_/_/ /_/|___/\___/____/\__/ 9 | 10 | Node Protect for Proxmox VE (Made in Italy) 11 | ``` 12 | 13 | [![License](https://img.shields.io/github/license/Corsinvest/cv4pve-node-protect.svg?style=flat-square)](LICENSE.md) 14 | [![Release](https://img.shields.io/github/release/Corsinvest/cv4pve-node-protect.svg?style=flat-square)](https://github.com/Corsinvest/cv4pve-node-protect/releases/latest) 15 | [![Downloads](https://img.shields.io/github/downloads/Corsinvest/cv4pve-node-protect/total.svg?style=flat-square&logo=download)](https://github.com/Corsinvest/cv4pve-node-protect/releases) 16 | [![NuGet](https://img.shields.io/nuget/v/Corsinvest.ProxmoxVE.NodeProtect.Api.svg?style=flat-square&logo=nuget)](https://www.nuget.org/packages/Corsinvest.ProxmoxVE.NodeProtect.Api/) 17 | 18 | --- 19 | 20 | ## Quick Start 21 | 22 | ```bash 23 | # Check available releases at: https://github.com/Corsinvest/cv4pve-node-protect/releases 24 | # Download specific version (replace VERSION with actual version number) 25 | wget https://github.com/Corsinvest/cv4pve-node-protect/releases/download/VERSION/cv4pve-node-protect-linux-x64.zip 26 | unzip cv4pve-node-protect-linux-x64.zip 27 | 28 | # Create configuration backup 29 | ./cv4pve-node-protect --host=YOUR_HOST --username=root@pam --password=YOUR_PASSWORD backup --directory-work="/backup" --paths="/etc/." --paths="/var/lib/pve-cluster/." --keep=7 30 | 31 | # Upload configuration to node 32 | ./cv4pve-node-protect --host=YOUR_HOST --username=root@pam --password=YOUR_PASSWORD upload --file-path="config.tar.gz" 33 | ``` 34 | 35 | --- 36 | 37 | ## Features 38 | 39 | ### Core Capabilities 40 | 41 | #### **Performance & Reliability** 42 | - **Native C#** implementation 43 | - **Cross-platform** (Windows, Linux, macOS) 44 | - **SSH-based** operations for direct node access 45 | - **Cluster support** with multi-node management 46 | - **High availability** with multiple host support 47 | 48 | #### **Flexible Targeting** 49 | - **Host selection** via names or IP addresses 50 | - **Bulk operations** across multiple nodes 51 | - **Path customization** for selective backups 52 | - **Flexible folder** selection options 53 | 54 | #### **Advanced Management** 55 | - **Intelligent retention** with configurable keep policies 56 | - **Secure upload** of configuration archives 57 | - **Automatic compression** in tar.gz format 58 | - **Multiple schedules** for backup frequency 59 | - **Comprehensive logging** and status reporting 60 | 61 | #### **Enterprise Features** 62 | - **SSL validation options** 63 | - **Timeout management** for operations 64 | - **Comprehensive logging** and status reporting 65 | 66 | --- 67 | 68 | ## Installation 69 | 70 | ### Linux Installation 71 | 72 | ```bash 73 | # Check available releases and get the specific version number 74 | # Visit: https://github.com/Corsinvest/cv4pve-node-protect/releases 75 | 76 | # Download specific version (replace VERSION with actual version like v1.2.3) 77 | wget https://github.com/Corsinvest/cv4pve-node-protect/releases/download/VERSION/cv4pve-node-protect-linux-x64.zip 78 | 79 | # Alternative: Get latest release URL programmatically 80 | LATEST_URL=$(curl -s https://api.github.com/repos/Corsinvest/cv4pve-node-protect/releases/latest | grep browser_download_url | grep linux-x64 | cut -d '"' -f 4) 81 | wget "$LATEST_URL" 82 | 83 | # Extract and make executable 84 | unzip cv4pve-node-protect-linux-x64.zip 85 | chmod +x cv4pve-node-protect 86 | 87 | # Optional: Move to system path 88 | sudo mv cv4pve-node-protect /usr/local/bin/ 89 | ``` 90 | 91 | ### Windows Installation 92 | 93 | ```powershell 94 | # Check available releases at: https://github.com/Corsinvest/cv4pve-node-protect/releases 95 | # Download specific version (replace VERSION with the actual number) 96 | Invoke-WebRequest -Uri "https://github.com/Corsinvest/cv4pve-node-protect/releases/download/VERSION/cv4pve-node-protect-win-x64.zip" -OutFile "cv4pve-node-protect.zip" 97 | 98 | # Extract 99 | Expand-Archive cv4pve-node-protect.zip -DestinationPath "C:\Tools\cv4pve-node-protect" 100 | 101 | # Add to PATH (optional) 102 | $env:PATH += ";C:\Tools\cv4pve-node-protect" 103 | ``` 104 | 105 | ### macOS Installation 106 | 107 | ```bash 108 | # Check available releases at: https://github.com/Corsinvest/cv4pve-node-protect/releases 109 | # Download specific version (replace VERSION with the actual number) 110 | wget https://github.com/Corsinvest/cv4pve-node-protect/releases/download/VERSION/cv4pve-node-protect-osx-x64.zip 111 | unzip cv4pve-node-protect-osx-x64.zip 112 | chmod +x cv4pve-node-protect 113 | 114 | # Move to applications 115 | sudo mv cv4pve-node-protect /usr/local/bin/ 116 | ``` 117 | 118 | --- 119 | 120 | ## Configuration 121 | 122 | ### Authentication Methods 123 | 124 | #### **Username/Password** 125 | ```bash 126 | cv4pve-node-protect --host=192.168.1.100 --username=backup@pve --password=your_password [commands] 127 | ``` 128 | 129 | #### **Password from File** 130 | ```bash 131 | # Use interactive password prompt that stores to file 132 | cv4pve-node-protect --host=192.168.1.100 --username=backup@pve --password=file:/etc/cv4pve/password [commands] 133 | 134 | # First run: prompts for password and saves to file 135 | # Subsequent runs: reads password from file automatically 136 | ``` 137 | 138 | ### Configurable Backup Paths 139 | 140 | The `--paths` parameter supports selection of specific paths for backup: 141 | 142 | | Path | Description | Example | 143 | |------|-------------|---------| 144 | | **System Configuration** | Essential system config files | `--paths="/etc/."` | 145 | | **Proxmox Cluster** | Proxmox VE cluster data | `--paths="/var/lib/pve-cluster/."` | 146 | | **Root Home** | Root user configuration files | `--paths="/root/."` | 147 | | **Ceph Configuration** | Ceph storage configuration | `--paths="/var/lib/ceph/."` | 148 | | **Multiple Paths** | Comma-separated list | `--paths="/etc/." --paths="/var/lib/pve-cluster/." --paths="/root/."` | 149 | 150 | ### Path Examples 151 | 152 |
153 | Real-World Path Examples 154 | 155 | #### Common Configuration Paths 156 | ```bash 157 | # Network configuration 158 | --paths="/etc/network/interfaces" 159 | 160 | # System configuration 161 | --paths="/etc/fstab" 162 | --paths="/etc/hosts" 163 | --paths="/etc/resolv.conf" 164 | 165 | # Proxmox VE configuration 166 | --paths="/etc/pve/" 167 | --paths="/etc/pve/storage.cfg" 168 | --paths="/etc/pve/cluster.conf" 169 | --paths="/etc/pve/priv/" 170 | --paths="/etc/pve/nodes/" 171 | 172 | # Firewall configuration 173 | --paths="/etc/pve/firewall/" 174 | --paths="/etc/pve/lxc/" 175 | --paths="/etc/pve/qemu-server/" 176 | 177 | # Service configuration 178 | --paths="/etc/cron.d/" 179 | --paths="/etc/logrotate.d/" 180 | ``` 181 | 182 |
183 | 184 | --- 185 | 186 | ## Usage Examples 187 | 188 | ### Basic Backup Operations 189 | 190 |
191 | Create Backups 192 | 193 | #### Single node backup 194 | ```bash 195 | cv4pve-node-protect --host=pve1.domain.com --username=root@pam --password=secret backup --directory-work="/backup" --paths="/etc/." --paths="/var/lib/pve-cluster/." --paths="/root/." 196 | ``` 197 | 198 | #### Backup with retention 199 | ```bash 200 | cv4pve-node-protect --host=pve1.domain.com --username=backup@pve --password=secret backup --directory-work="/backup" --paths="/etc/." --keep=10 201 | ``` 202 | 203 | #### Multiple nodes backup 204 | ```bash 205 | cv4pve-node-protect --host=192.168.1.100,192.168.1.101,192.168.1.102 --username=backup@pve --password=secret backup --directory-work="/backup" --paths="/etc/." --paths="/var/lib/pve-cluster/." --paths="/root/." 206 | ``` 207 | 208 |
209 | 210 |
211 | Configuration Upload 212 | 213 | #### Upload configuration to node 214 | ```bash 215 | cv4pve-node-protect --host=pve1.domain.com --username=root@pam --password=secret upload --file-path="config.tar.gz" 216 | ``` 217 | 218 | #### Upload to multiple nodes 219 | ```bash 220 | cv4pve-node-protect --host=192.168.1.100,192.168.1.101 --username=backup@pve --password=secret upload --file-path="config.tar.gz" 221 | ``` 222 | 223 |
224 | 225 |
226 | Verify Operations 227 | 228 | #### Test connection 229 | ```bash 230 | cv4pve-node-protect --host=pve1.domain.com --username=root@pam --password=secret backup --directory-work="/tmp" --paths="/etc/." --dry-run 231 | ``` 232 | 233 | #### Dry run mode 234 | ```bash 235 | # Test without making changes 236 | cv4pve-node-protect --host=pve1.domain.com --username=backup@pve --password=secret backup --directory-work="/tmp" --paths="/etc/." --dry-run 237 | ``` 238 | 239 |
240 | 241 | ### Advanced Targeting Examples 242 | 243 |
244 | Production Environment Patterns 245 | 246 | ```bash 247 | # Critical nodes backup 248 | cv4pve-node-protect --host=cluster.company.com --username=backup@pve --password=secret --host=192.168.1.100,192.168.1.101 backup --directory-work="/backup/critical" --paths="/etc/." --paths="/var/lib/pve-cluster/." --keep=14 249 | 250 | # Disaster recovery backup 251 | cv4pve-node-protect --host=pve.company.com --username=backup@pve --password=secret --host="192.168.1.100:8006,192.168.1.101:8006" backup --directory-work="/backup/dr" --paths="/etc/." --paths="/var/lib/pve-cluster/." --paths="/root/." --keep=30 252 | 253 | # Weekly retention backup 254 | cv4pve-node-protect --host=pve-cluster.local --username=ops@pve --password=secret --host=192.168.1.100 backup --directory-work="/backup/weekly" --paths="/etc/." --paths="/var/lib/pve-cluster/." --keep=7 255 | ``` 256 | 257 |
258 | 259 | ### Scheduling with Cron 260 | 261 |
262 | Cron Examples 263 | 264 | ```bash 265 | # Edit crontab 266 | crontab -e 267 | 268 | # Daily backup at 3 AM (keep 7 days) 269 | 0 3 * * * /usr/local/bin/cv4pve-node-protect --host=pve.local --username=backup@pve --password=secret --host=192.168.1.100 backup --directory-work="/backup/daily" --paths="/etc/." --paths="/var/lib/pve-cluster/." --keep=7 270 | 271 | # Weekly backup on Sunday at 4 AM (keep 4 weeks) 272 | 0 4 * * 0 /usr/local/bin/cv4pve-node-protect --host=pve.local --username=backup@pve --password=secret --host=192.168.1.100,192.168.1.101,192.168.1.102 backup --directory-work="/backup/weekly" --paths="/etc/." --paths="/var/lib/pve-cluster/." --paths="/root/." --keep=4 273 | 274 | # Monthly backup on the 1st day of month at 5 AM 275 | 0 5 1 * * /usr/local/bin/cv4pve-node-protect --host=pve.local --username=backup@pve --password=secret --host=192.168.1.100 backup --directory-work="/backup/monthly" --paths="/etc/." --paths="/var/lib/pve-cluster/." --paths="/root/." --paths="/var/lib/ceph/." --keep=12 276 | ``` 277 | 278 |
279 | 280 | --- 281 | 282 | ## Security & Permissions 283 | 284 | ### Required Permissions 285 | 286 | | Permission | Purpose | Scope | 287 | |------------|---------|-------| 288 | | **Sys.Modify** | Modify system configuration | Nodes | 289 | | **Datastore.Read** | Read data from datastore | Storage systems | 290 | | **Sys.Audit** | View system information | Nodes | 291 | | **VM.Audit** | Read VM information | Virtual machines (for some cluster data) | 292 | 293 | ### Authentication Setup 294 | 295 |
296 | Setting up Authentication 297 | 298 | #### 1. Configure User Permissions 299 | ```bash 300 | # Follow Proxmox VE official documentation for: 301 | # - User creation with appropriate privileges 302 | # - Permission assignment for required roles 303 | # - Required permissions: Sys.Modify, Datastore.Read, Sys.Audit, VM.Audit 304 | # Refer to official Proxmox VE documentation for detailed steps 305 | ``` 306 | 307 | #### 2. Use Credentials in Commands 308 | ```bash 309 | cv4pve-node-protect --host=pve.local --username=backup@pve --password=secret backup --directory-work="/backup" --paths="/etc/." 310 | ``` 311 | 312 |
313 | 314 | --- 315 | 316 | ## Advanced Features 317 | 318 | ### Selective Backup 319 | 320 |
321 | Custom Path Selection 322 | 323 | cv4pve-node-protect allows selecting specific paths for backup: 324 | 325 | ```bash 326 | # Set custom paths 327 | cv4pve-node-protect --host=pve.local --username=backup@pve --password=secret --host=192.168.1.100 backup --directory-work="/backup/custom" --paths="/etc/." --paths="/var/lib/pve-cluster/." --paths="/root/.ssh" --paths="/etc/pve/firewall/" 328 | ``` 329 | 330 | #### Example of Custom Backup Paths 331 | ``` 332 | ---------------------------------------------------------------------------- 333 | | Path | Type | Description | 334 | ---------------------------------------------------------------------------- 335 | | /etc/. | Config | General system configuration | 336 | | /var/lib/pve-cluster/. | Storage | Proxmox VE cluster data | 337 | | /root/. | Home | Personal and root configuration | 338 | | /etc/pve/. | Config | Complete Proxmox VE configuration | 339 | | /etc/pve/firewall/. | Config | Specific firewall rules | 340 | | /etc/pve/lxc/. | Config | LXC container templates | 341 | | /etc/pve/qemu-server/. | Config | QEMU VM configuration | 342 | ---------------------------------------------------------------------------- 343 | ``` 344 | 345 |
346 | 347 | ### Advanced Backup Management 348 | 349 |
350 | Retention and Naming Policies 351 | 352 | Advanced backup retention policy management: 353 | 354 | ```bash 355 | # Set custom retention 356 | cv4pve-node-protect --host=pve.local --username=backup@pve --password=secret --host=192.168.1.100 backup --directory-work="/backup" --paths="/etc/." --keep=30 357 | ``` 358 | 359 | #### Naming Policies 360 | 361 | The backup directory contains files with format: `{ip_address}-config.tar.gz` 362 | 363 | The format is fixed: {ip_address}-config.tar.gz where {ip_address} is the IP address of the Proxmox VE node. 364 | 365 | #### Directory Organization 366 | 367 | Backups are organized by date in a hierarchical structure: 368 | ``` 369 | /backup/ 370 | ├── 2025-01-15-14-30-22/ 371 | │ ├── 192.168.1.100-config.tar.gz 372 | │ ├── 192.168.1.101-config.tar.gz 373 | │ └── 192.168.1.102-config.tar.gz 374 | ├── 2025-01-16-14-30-22/ 375 | │ ├── 192.168.1.100-config.tar.gz 376 | │ ├── 192.168.1.101-config.tar.gz 377 | │ └── 192.168.1.102-config.tar.gz 378 | ``` 379 | 380 |
381 | 382 | ### Configuration Files 383 | 384 |
385 | Parameter Files for Complex Setup 386 | 387 | Use parameter files for complex configurations: 388 | 389 | #### Create Parameter File 390 | ```bash 391 | # /etc/cv4pve/production.conf 392 | --host=cluster.company.com 393 | --username=backup@pve 394 | --password-file=/etc/cv4pve/password 395 | --host=192.168.1.100:8006,192.168.1.101:8006 396 | --directory-work=/backup/production 397 | --timeout=300 398 | --validate-certificate 399 | ``` 400 | 401 | #### Execute with Parameter File 402 | ```bash 403 | cv4pve-node-protect @/etc/cv4pve/production.conf backup --paths="/etc/." --paths="/var/lib/pve-cluster/." --keep=30 404 | ``` 405 | 406 | #### Multiple Environment Configurations 407 | ```bash 408 | # Development environment 409 | cv4pve-node-protect @/etc/cv4pve/dev.conf backup --paths="/etc/." --keep=3 410 | 411 | # Staging environment 412 | cv4pve-node-protect @/etc/cv4pve/staging.conf backup --paths="/etc/." --paths="/var/lib/pve-cluster/." --keep=5 413 | 414 | # Production environment 415 | cv4pve-node-protect @/etc/cv4pve/production.conf backup --paths="/etc/." --paths="/var/lib/pve-cluster/." --paths="/root/." --keep=30 416 | ``` 417 | 418 |
419 | 420 | --- 421 | 422 | ## Best Practices 423 | 424 | ### Backup Strategy Guidelines 425 | 426 | #### **Retention Schedules** 427 | - **Daily**: Keep 7-14 backups (1-2 weeks) 428 | - **Weekly**: Keep 4-8 backups (1-2 months) 429 | - **Monthly**: Keep 12 backups (1 year) 430 | - **Yearly**: Keep 3-5 backups (long-term archival) 431 | 432 | #### **Directory Organization** 433 | - Use descriptive paths (`/backup/daily`, `/backup/weekly`) 434 | - Include environment in path (`/backup/prod-daily`, `/backup/dev-weekly`) 435 | - Consider compliance requirements (`/backup/retention-7y`) 436 | 437 | #### **Performance Optimization** 438 | - **Schedule during low activity** periods 439 | - **Stagger backup times** across nodes 440 | - **Monitor storage growth** regularly 441 | - **Use selective paths** to reduce backup size 442 | - **Implement cleanup routines** for old backups 443 | 444 | #### **Reliability Measures** 445 | - **Test restore procedures** regularly 446 | - **Monitor backup creation** for failures 447 | - **Implement alerting** for storage thresholds 448 | - **Document recovery procedures** 449 | - **Verify SSH access** to nodes 450 | 451 | --- 452 | 453 | ## Troubleshooting 454 | 455 | ### Common Issues & Solutions 456 | 457 |
458 | Authentication Problems 459 | 460 | #### Issue: "Authentication failed" 461 | ```bash 462 | # Check credentials 463 | cv4pve-node-protect --host=pve.local --username=root@pam --password=test backup --directory-work="/tmp" --paths="/etc/." 464 | ``` 465 | 466 | #### Solution: Verify permissions 467 | ```bash 468 | # Check user permissions in Proxmox 469 | pveum user list 470 | pveum user permissions backup@pve 471 | ``` 472 | 473 |
474 | 475 |
476 | Connection Issues 477 | 478 | #### Issue: "Connection timeout" or "Host unreachable" 479 | ```bash 480 | # Test connectivity 481 | ping pve.local 482 | telnet pve.local 8006 483 | 484 | # Check SSL certificate 485 | cv4pve-node-protect --host=pve.local --validate-certificate --username=root@pam --password=secret backup --directory-work="/tmp" --paths="/etc/." 486 | ``` 487 | 488 | #### Solution: Network and certificate verification 489 | ```bash 490 | # Use IP instead of hostname 491 | cv4pve-node-protect --host=192.168.1.100 backup --directory-work="/tmp" --paths="/etc/." 492 | 493 | # Disable SSL validation for testing (not recommended for production) 494 | cv4pve-node-protect --host=pve.local --username=root@pam --password=secret backup --directory-work="/tmp" --paths="/etc/." 495 | ``` 496 | 497 |
498 | 499 |
500 | Disk Space Issues 501 | 502 | #### Issue: "Insufficient disk space" 503 | ```bash 504 | # Check disk space status 505 | df -h 506 | ls -la /backup/ 507 | ``` 508 | 509 | #### Solution: Disk space management 510 | ```bash 511 | # Manually delete old backups 512 | rm -rf /backup/*old*/ 513 | ``` 514 | 515 |
516 | 517 |
518 | Path Selection Issues 519 | 520 | #### Issue: "Cannot access specified paths" 521 | ```bash 522 | # Check paths 523 | cv4pve-node-protect --host=pve.local --username=backup@pve --password=secret backup --directory-work="/tmp" --paths="/nonexistent/path/" 524 | ``` 525 | 526 | #### Solution: Verify existing paths 527 | ```bash 528 | # Verify SSH access and paths 529 | ssh root@pve.local "ls -la /etc/." 530 | ssh root@pve.local "ls -la /var/lib/pve-cluster/." 531 | ``` 532 | 533 |
534 | 535 | ### Debug Mode 536 | 537 |
538 | Enable Detailed Logging 539 | 540 | ```bash 541 | # Enable debug output 542 | cv4pve-node-protect --host=pve.local --username=backup@pve --password=secret backup --directory-work="/tmp" --paths="/etc/." --debug 543 | 544 | # Test without making changes 545 | cv4pve-node-protect --host=pve.local --username=backup@pve --password=secret backup --directory-work="/tmp" --paths="/etc/." --dry-run 546 | ``` 547 | 548 |
549 | 550 | --- 551 | 552 | #### **Web GUI Version** 553 | 554 | [![cv4pve-admin](https://raw.githubusercontent.com/Corsinvest/cv4pve-admin/main/src/Corsinvest.ProxmoxVE.Admin/wwwroot/doc/images/screenshot/modules/node-protect/grid.png)](https://github.com/Corsinvest/cv4pve-admin) 555 | 556 | **Web interface for cv4pve-node-protect** 557 | 558 | --- 559 | 560 | ## SSH Integration 561 | 562 | ### Why SSH Access Matters 563 | 564 | > **Important:** cv4pve-node-protect uses SSH to access Proxmox VE nodes and retrieve configuration files. SSH must be enabled and accessible on all target nodes. 565 | 566 | #### **Without SSH Access** 567 | - Cannot retrieve configuration files 568 | - Backup operations fail 569 | - Unable to access specified paths 570 | - Node protection impossible 571 | 572 | #### **With SSH Access** 573 | - Secure file transfer 574 | - Reliable backup operations 575 | - Automated scheduled backups 576 | - Centralized configuration management 577 | 578 | ### Verify SSH Access 579 | 580 | ```bash 581 | # Test SSH connectivity 582 | ssh root@pve-node "ls -la /etc/." 583 | 584 | # Verify with dry run 585 | cv4pve-node-protect --host=pve-node --username=root@pam --password=password backup --directory-work="/tmp" --paths="/etc/." --dry-run 586 | ``` 587 | 588 | --- 589 | 590 | ## Command Reference 591 | 592 | ### Global Options 593 | 594 |
595 | Complete Parameter List 596 | 597 | ```bash 598 | cv4pve-node-protect [global-options] [command] [command-options] 599 | ``` 600 | 601 | #### Authentication Options 602 | | Parameter | Description | Example | 603 | |-----------|-------------|---------| 604 | | `--host` | Proxmox host(s) | `--host=pve.local:8006` | 605 | | `--username` | Username@realm | `--username=root@pam` | 606 | | `--password` | Password or file | `--password=secret` or `--password=file:/path` | 607 | 608 | #### Connection Options 609 | | Parameter | Description | Default | 610 | |-----------|-------------|---------| 611 | | `--timeout` | Operation timeout (seconds) | `30` | 612 | | `--validate-certificate` | Validate SSL certificate | `false` | 613 | 614 | #### Target Selection 615 | | Parameter | Description | Example | 616 | |-----------|-------------|---------| 617 | | `--host` | Target node(s) | `--host=192.168.1.100:8006,192.168.1.101:8006` | 618 | 619 | #### Storage & Format 620 | | Parameter | Description | Default | 621 | |-----------|-------------|---------| 622 | | `--directory-work` | Backup destination directory | Required | 623 | 624 |
625 | 626 | ### Backup Command 627 | 628 |
629 | Configuration Backup Options 630 | 631 | ```bash 632 | cv4pve-node-protect [global-options] backup [backup-options] 633 | ``` 634 | 635 | #### Backup-Specific Options 636 | | Parameter | Description | Required | 637 | |-----------|-------------|----------| 638 | | `--paths` | Configuration paths to backup | Yes | 639 | | `--directory-work` | Backup destination directory | Yes | 640 | | `--keep` | Retention count (backups to preserve) | No | 641 | | `--debug` | Enable debug output | No | 642 | 643 | #### Examples 644 | ```bash 645 | # Basic backup with retention 646 | cv4pve-node-protect --host=pve.local --username=root@pam --password=secret backup --directory-work="/backup" --paths="/etc/." --keep=7 647 | 648 | # Multiple paths backup 649 | cv4pve-node-protect --host=pve.local --username=root@pam --password=secret backup --directory-work="/backup" --paths="/etc/." --paths="/var/lib/pve-cluster/." --paths="/root/." 650 | 651 | # Debug mode backup 652 | cv4pve-node-protect --host=pve.local --username=root@pam --password=secret backup --directory-work="/backup" --paths="/etc/." --debug 653 | ``` 654 | 655 |
656 | 657 | ### Upload Command 658 | 659 |
660 | Configuration Upload Options 661 | 662 | ```bash 663 | cv4pve-node-protect [global-options] upload [upload-options] 664 | ``` 665 | 666 | #### Upload-Specific Options 667 | | Parameter | Description | Required | 668 | |-----------|-------------|----------| 669 | | `--file-path` | Configuration archive to upload | Yes | 670 | | `--debug` | Enable debug output | No | 671 | 672 | #### Examples 673 | ```bash 674 | # Upload configuration archive 675 | cv4pve-node-protect --host=pve.local --username=root@pam --password=secret upload --file-path="config.tar.gz" 676 | 677 | # Upload with debug output 678 | cv4pve-node-protect --host=pve.local --username=root@pam --password=secret upload --file-path="config.tar.gz" --debug 679 | ``` 680 | 681 |
682 | 683 | --- 684 | 685 | ## Support 686 | 687 | Professional support and consulting available through [Corsinvest](https://www.corsinvest.it/cv4pve). 688 | 689 | --- 690 | 691 | Part of [cv4pve](https://www.corsinvest.it/cv4pve) suite | Made with ❤️ in Italy by [Corsinvest](https://www.corsinvest.it) 692 | 693 | Copyright © Corsinvest Srl 694 | -------------------------------------------------------------------------------- /LICENSE.md: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | {one line to give the program's name and a brief idea of what it does.} 635 | Copyright (C) {year} {name of author} 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | {project} Copyright (C) {year} {fullname} 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------