Compare commits
152 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
22d19b4ad4 | ||
|
|
69e5a830ce | ||
|
|
a6ed7d001a | ||
|
|
66c1058970 | ||
|
|
8a21e011f9 | ||
|
|
57c39489f8 | ||
|
|
bc9e4554fa | ||
|
|
7d76126bdf | ||
|
|
b497a0e928 | ||
|
|
38463dd97d | ||
|
|
448aadfffd | ||
|
|
f822293c80 | ||
|
|
a01da7cbb4 | ||
|
|
b38079947e | ||
|
|
e8f659ad22 | ||
|
|
f50f52ae77 | ||
|
|
163b967301 | ||
|
|
fd345b674c | ||
|
|
ea458af9e5 | ||
|
|
d415eb0b8b | ||
|
|
be3e050ffa | ||
|
|
3ab4574789 | ||
|
|
9b1e53a05d | ||
|
|
4a455b6203 | ||
|
|
a3a8543b1c | ||
|
|
be0cc40386 | ||
|
|
d45d0bb80b | ||
|
|
416069e4f1 | ||
|
|
a0f5612994 | ||
|
|
e5a35c7492 | ||
|
|
e822540455 | ||
|
|
6fec30628b | ||
|
|
7d7b5be4bf | ||
|
|
dcea0c267c | ||
|
|
5c66ea3c94 | ||
|
|
529d065690 | ||
|
|
435ccf272a | ||
|
|
1772bf85d2 | ||
|
|
f7455f10a1 | ||
|
|
81483ee853 | ||
|
|
32f2d7a7b6 | ||
|
|
bb14aec611 | ||
|
|
730f9d1e85 | ||
|
|
db2cca1c94 | ||
|
|
bb2179ef2f | ||
|
|
4376798c0d | ||
|
|
ea5f67cfa9 | ||
|
|
a0decccb50 | ||
|
|
eb7c0914f8 | ||
|
|
2d2755bb81 | ||
|
|
201d7f6f29 | ||
|
|
1951b5dbb2 | ||
|
|
13fce0651b | ||
|
|
6e6f2a5e86 | ||
|
|
5fa8fbe00f | ||
|
|
0e040aff44 | ||
|
|
dd2ec07d6b | ||
|
|
98fa2c32d8 | ||
|
|
6a96263dee | ||
|
|
88720b5f56 | ||
|
|
aca15eb2d3 | ||
|
|
d5ab11b03e | ||
|
|
d9ef54e25a | ||
|
|
6f969a618e | ||
|
|
a016784d20 | ||
|
|
4e7cb78aad | ||
|
|
0b794ebd96 | ||
|
|
f017bcd1f0 | ||
|
|
a220eea9fa | ||
|
|
b8da683746 | ||
|
|
25ea01effb | ||
|
|
3ee12c4231 | ||
|
|
8ef4b8cb4f | ||
|
|
616ccda1f9 | ||
|
|
d8d8644775 | ||
|
|
0b39af76b8 | ||
|
|
7dc3ebce92 | ||
|
|
484bb1f79c | ||
|
|
3854fd86fe | ||
|
|
c9d14506c4 | ||
|
|
799500bbf0 | ||
|
|
b7ee090b4d | ||
|
|
7f6171efbf | ||
|
|
f44647c170 | ||
|
|
bac101e6d8 | ||
|
|
1c0fe39e28 | ||
|
|
d1e6694b3c | ||
|
|
2d1a9a8461 | ||
|
|
9acf5ea188 | ||
|
|
cb263ce100 | ||
|
|
1edc89a1e3 | ||
|
|
0ea7243a69 | ||
|
|
98ec70eae6 | ||
|
|
4030c94762 | ||
|
|
644f6069f6 | ||
|
|
512d2eb4f0 | ||
|
|
b5306a767b | ||
|
|
6875e48377 | ||
|
|
e0247a0f74 | ||
|
|
001cadd718 | ||
|
|
fe4ba26229 | ||
|
|
836226bd28 | ||
|
|
c94f29a83d | ||
|
|
1849e06656 | ||
|
|
bff213f253 | ||
|
|
47ab17f97c | ||
|
|
9356994f31 | ||
|
|
3b749aedaf | ||
|
|
c3c3dd353e | ||
|
|
e9a5627187 | ||
|
|
ede3fbb994 | ||
|
|
0b4f042e66 | ||
|
|
71b86cf4f4 | ||
|
|
fd61bc0e24 | ||
|
|
9b3e005d6a | ||
|
|
ee4803b118 | ||
|
|
2d8de9f2d0 | ||
|
|
24d8ede2b2 | ||
|
|
eb92667a9a | ||
|
|
e28c93c858 | ||
|
|
7064e8e5ee | ||
|
|
f2d862e031 | ||
|
|
b61c5a45c0 | ||
|
|
023adcf8f4 | ||
|
|
26705b3ad7 | ||
|
|
4fc20ea4c2 | ||
|
|
30595772fc | ||
|
|
584de2913d | ||
|
|
eeb2067087 | ||
|
|
fa5b42cbc6 | ||
|
|
9fe8dcd4f4 | ||
|
|
fc2d3b2ba9 | ||
|
|
c465a63fb7 | ||
|
|
46bb766dcd | ||
|
|
3318c68ed9 | ||
|
|
aefe6263c5 | ||
|
|
3ce76d6d77 | ||
|
|
6056406323 | ||
|
|
c3a2474beb | ||
|
|
5bc97d285f | ||
|
|
d725c622ec | ||
|
|
30273a1d07 | ||
|
|
d4154c2b09 | ||
|
|
32310d0e61 | ||
|
|
dcfa1250ad | ||
|
|
9aaadaca1c | ||
|
|
4950738e31 | ||
|
|
b368a2b94c | ||
|
|
c4d2dbe880 | ||
|
|
f064e5c4f5 | ||
|
|
f74dae3e69 | ||
|
|
cb8ebe639e |
37
.github/ISSUE_TEMPLATE/🐛-bug-report.md
vendored
Normal file
@@ -0,0 +1,37 @@
|
||||
---
|
||||
name: "\U0001F41B Bug Report"
|
||||
about: Create a report to help us improve the module!
|
||||
title: ''
|
||||
labels: bug
|
||||
assignees: ''
|
||||
|
||||
---
|
||||
|
||||
**Describe the bug**
|
||||
A clear and concise description of what the bug is.
|
||||
|
||||
**To Reproduce**
|
||||
Steps to reproduce the behaviour:
|
||||
1. Go to '...'
|
||||
2. Click on '....'
|
||||
3. Scroll down to '....'
|
||||
4. See error
|
||||
|
||||
**Expected behaviour**
|
||||
A clear and concise description of what you expected to happen.
|
||||
|
||||
**Screenshots**
|
||||
If applicable, add screenshots to help explain your problem to us.
|
||||
|
||||
**Module > Support/Health tab (remove IP and paste here):**
|
||||
- Version of module
|
||||
- Web Server info
|
||||
- PHP version
|
||||
- etc.
|
||||
|
||||
**WHMCS Information (please complete the following):**
|
||||
- WHMCS Version (must be supported):
|
||||
- Using HTTPS: Yes or No
|
||||
|
||||
**Confirm that you have MORE THAN 100 services (all statuses) in WHMCS?**
|
||||
Otherwise you will receive a "value does not look like a valid VM ID" error. Check the error!
|
||||
20
.github/ISSUE_TEMPLATE/🚀-feature-request.md
vendored
Normal file
@@ -0,0 +1,20 @@
|
||||
---
|
||||
name: "\U0001F680 Feature Request"
|
||||
about: How can we improve Proxmox VE for WHMCS?
|
||||
title: ''
|
||||
labels: enhancement
|
||||
assignees: ''
|
||||
|
||||
---
|
||||
|
||||
**Is your feature request related to a problem? Please describe.**
|
||||
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
|
||||
|
||||
**Describe the solution you'd like**
|
||||
A clear and concise description of what you want to happen.
|
||||
|
||||
**Describe alternatives you've considered**
|
||||
A clear and concise description of any alternative solutions or features you've considered.
|
||||
|
||||
**Additional context**
|
||||
Add any other context or screenshots about the feature request here.
|
||||
128
CHANGELOG.md
Normal file
@@ -0,0 +1,128 @@
|
||||
# Changelog
|
||||
All notable changes to Proxmox VE for WHMCS will be documented in this file.
|
||||
|
||||
## [1.2.3] - 2023-12-31 - _"NY Tidy-up 123"_
|
||||
|
||||
### 🚀 Feature
|
||||
- x86-64-ABI: Add options; Emulation default now `x86-64-v2-AES` (#58)
|
||||
- Intel/AMD: Add new CPU Emulation options (8~ Intel, 2x EPYC) (#58)
|
||||
|
||||
### 💅 Polish
|
||||
- Debug Logs: Improved quality & scope of logged info (#59)
|
||||
- SECURITY.md: Add file to repository, clarifying process (#61)
|
||||
- README.md: Add VM/CT creation explanations from old Manual (#57)
|
||||
- Logo: Per request from Proxmox Server Solutions, we got a logo (#56)
|
||||
- SPICE: Ground-work for future potential addition of 2nd HTML5/etc VNC
|
||||
|
||||
### 🐛 Bug Fix
|
||||
- PHP v8.1: Verified no problems operating on v8 old-stable ver.
|
||||
- Connection Test: Fixed, so it reports OK/Green or an error (#29)
|
||||
- Admin, Edit Service: Should now populate existing config OK (#36)
|
||||
|
||||
## [1.2.2] - 2023-09-15 - _"Nice refinements"_
|
||||
|
||||
### 🚀 Feature
|
||||
- Debugging Mode: Allow admin to turn on/off Module Log feed (#38)*
|
||||
- VLAN ID: Set the required Virtual LAN ID against VM/CT Plan (#35)*
|
||||
- Version: Report in-use & latest versions in Health; ver alert (#21)
|
||||
- Power Actions: Now available in Admin Area as well as Client Area
|
||||
- (Note: Suspend/Unsuspend/Terminate remain admin-only functions)
|
||||
|
||||
### 💅 Polish
|
||||
- Suspend/Unsuspend: Functions changed to Stop/Start (fixes #34)
|
||||
- Client Area: Power Action wording amended (Soft Stop, Hard Stop)
|
||||
- Admin, Module Config: Explain what the VNC Secret field is about
|
||||
- Admin, Module Config: House-keeping to design, Support/Health tab
|
||||
|
||||
### 🐛 Bug Fix
|
||||
- Admin, Create Service: Fails if Plan/Pool not assigned in WHMCS (#36)
|
||||
- Client, VNC: Fails early if VNC Secret is not set or adequate (#27)
|
||||
- On-boot Status: Enabled/Disabled now properly applied for CTs (#34)
|
||||
|
||||
(\*): SQL Note: There are new columns in 2 of the module tables, see [SQL.md](https://github.com/The-Network-Crew/Proxmox-VE-for-WHMCS/blob/master/SQL.md)
|
||||
|
||||
## [1.2.1b] - 2023-06-19 - _"Working, including VNC!"_
|
||||
|
||||
### 🚀 Feature
|
||||
- Module Config tab, allowing for configuration of the VNC Secret
|
||||
- Reboot command/action added to Client Area (ie. on/off/hard-off)
|
||||
- Link from Health tab of Admin GUI to WHMCS Marketplace re: reviews
|
||||
- Images for all supported Operating Systems & Kernel types (some fixed)
|
||||
- noVNC overhauled, to send PVE Cookie (ticket) and VNC Access Ticket also
|
||||
|
||||
### 💅 Polish
|
||||
- Stop VM/CT (Client Area) renamed to Hard Stop, compared to Shut Down
|
||||
- Modify the PHP API2 class, adding getTicket() so we can dual-auth (VNC)
|
||||
- Move VNC Clients from root-level to vnc-only-level access to Proxmox VE
|
||||
|
||||
### 🐛 Bug Fix
|
||||
- noVNC render method updated to stop out-of-order data flow problem
|
||||
- noVNC back-end vncproxy and vncwebsocket methods updated re: spec
|
||||
- Client Area actions (Power Off/On, etc) fixed for LXC (QEMU OK)
|
||||
- Error with both VNC methods. We are going to remove TigerVNC
|
||||
|
||||
## [1.2.0b] - 2023-06-18 - _"Loads of key fixes"_
|
||||
|
||||
### 🚀 Feature
|
||||
- Link off to GitHub Issues for Support from the Module page in WHMCS
|
||||
- CHANGELOG.md file added to repository to track in recommended format
|
||||
- Try-catch around the Creation API Call, routing OK/error into WHMCS
|
||||
- Feed the IP/GW configuration into QEMU and LXC creation attempts
|
||||
- PVE Storage > Volume Name and Disk I/O Limit fields added (#7)
|
||||
- Module, PHP & Server reported on the Health/Support GUI tab
|
||||
- Licensed repository/module via GPLv3 (link-back attribution)
|
||||
- Warning in README.md re: WHMCS Service ID being > 100
|
||||
- Zero Tolerance Abuse Policy added to README file
|
||||
|
||||
### 💅 Polish
|
||||
- Module versioning changed to semver (semantic versioning) 1.2.0
|
||||
- Change rel. path to ROOTDIR in IPv4 file, in case of other issues
|
||||
- Use /cluster/resources via API, not /node/, to get stats (ex. swap)
|
||||
- Updated noVNC, TigerVNC, Ubuntu, Debian and CentOS interface images
|
||||
- Improved error handling and pass-back from Proxmox to Class to WHMCS
|
||||
- Updated the PVE2 API Class and improved its logging (prefix/exception)
|
||||
- Method to fire API Calls updated due to reduction in WHMCS param scope
|
||||
|
||||
### 🐛 Bug Fix
|
||||
- Regression in v1.1 with missing semicolon breaking activation (#14)
|
||||
- Edit Icon not rendering on IP/Pool edit page, missing asset (#13)
|
||||
- Relative link to PVE2 API Class file broken, use ROOTDIR (#13/15)
|
||||
- IPv4 Address functions, update file to use float not real (#13)
|
||||
- Container (CT/LXC) Swap reporting in Client Area now working
|
||||
- RRD (Usage) measurements: params attached to requests OK
|
||||
- API Requests for Creation now functional (fixes #17)
|
||||
- Client Area pages/actions now fixed (fixes #19)
|
||||
- Font Awesome icons fixed in the Client Area
|
||||
|
||||
## [1.1b] - 2023-06-06 - _"The overhaul begins!"_
|
||||
|
||||
### 🚀 Feature
|
||||
- Swap space editing for plans; back-end existed but not GUI editing
|
||||
- Modern-day language to GUI according to changes in the 6 years
|
||||
- README now links out to all Dependencies and Documentation
|
||||
|
||||
### 💅 Polish
|
||||
- Module Name from "PRVE" to "pvewhmcs" (ie. Proxmox VE for WHMCS)
|
||||
- Default storage/disk type changed from IDE to Virtio (fastest)
|
||||
- Updated 3 dependencies to latest: PVE2-PHP, noVNC, TigerVNC
|
||||
- Removed all code segments relating to Software Licensing
|
||||
- DNS defaults changed from Google DNS to Cloudflare DNS
|
||||
|
||||
### 🐛 Bug Fix
|
||||
- Module can now be installed onto WHMCS 8.x installations
|
||||
- OpenVZ changed to LXC, to support PVE 4.x installs & up
|
||||
- Removed I/O Priority setting, to re-do via Throttling
|
||||
- Catch exception in Client Area if can't reach Proxmox
|
||||
|
||||
## [1.0] - 2017-01-26 - _"FOSS Foundations"_
|
||||
|
||||
**_Thank you @cybercoder for open-sourcing your code!_**
|
||||
|
||||
### 🚀 Feature
|
||||
- Open-sourced the previously commercial plugin
|
||||
|
||||
### 💅 Polish
|
||||
- Commented out the licensing code segments
|
||||
|
||||
### 🐛 Bug Fix
|
||||
- Removed old database schema import file
|
||||
674
LICENSE
Normal file
@@ -0,0 +1,674 @@
|
||||
GNU GENERAL PUBLIC LICENSE
|
||||
Version 3, 29 June 2007
|
||||
|
||||
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
||||
Everyone is permitted to copy and distribute verbatim copies
|
||||
of this license document, but changing it is not allowed.
|
||||
|
||||
Preamble
|
||||
|
||||
The GNU General Public License is a free, copyleft license for
|
||||
software and other kinds of works.
|
||||
|
||||
The licenses for most software and other practical works are designed
|
||||
to take away your freedom to share and change the works. By contrast,
|
||||
the GNU General Public License is intended to guarantee your freedom to
|
||||
share and change all versions of a program--to make sure it remains free
|
||||
software for all its users. We, the Free Software Foundation, use the
|
||||
GNU General Public License for most of our software; it applies also to
|
||||
any other work released this way by its authors. You can apply it to
|
||||
your programs, too.
|
||||
|
||||
When we speak of free software, we are referring to freedom, not
|
||||
price. Our General Public Licenses are designed to make sure that you
|
||||
have the freedom to distribute copies of free software (and charge for
|
||||
them if you wish), that you receive source code or can get it if you
|
||||
want it, that you can change the software or use pieces of it in new
|
||||
free programs, and that you know you can do these things.
|
||||
|
||||
To protect your rights, we need to prevent others from denying you
|
||||
these rights or asking you to surrender the rights. Therefore, you have
|
||||
certain responsibilities if you distribute copies of the software, or if
|
||||
you modify it: responsibilities to respect the freedom of others.
|
||||
|
||||
For example, if you distribute copies of such a program, whether
|
||||
gratis or for a fee, you must pass on to the recipients the same
|
||||
freedoms that you received. You must make sure that they, too, receive
|
||||
or can get the source code. And you must show them these terms so they
|
||||
know their rights.
|
||||
|
||||
Developers that use the GNU GPL protect your rights with two steps:
|
||||
(1) assert copyright on the software, and (2) offer you this License
|
||||
giving you legal permission to copy, distribute and/or modify it.
|
||||
|
||||
For the developers' and authors' protection, the GPL clearly explains
|
||||
that there is no warranty for this free software. For both users' and
|
||||
authors' sake, the GPL requires that modified versions be marked as
|
||||
changed, so that their problems will not be attributed erroneously to
|
||||
authors of previous versions.
|
||||
|
||||
Some devices are designed to deny users access to install or run
|
||||
modified versions of the software inside them, although the manufacturer
|
||||
can do so. This is fundamentally incompatible with the aim of
|
||||
protecting users' freedom to change the software. The systematic
|
||||
pattern of such abuse occurs in the area of products for individuals to
|
||||
use, which is precisely where it is most unacceptable. Therefore, we
|
||||
have designed this version of the GPL to prohibit the practice for those
|
||||
products. If such problems arise substantially in other domains, we
|
||||
stand ready to extend this provision to those domains in future versions
|
||||
of the GPL, as needed to protect the freedom of users.
|
||||
|
||||
Finally, every program is threatened constantly by software patents.
|
||||
States should not allow patents to restrict development and use of
|
||||
software on general-purpose computers, but in those that do, we wish to
|
||||
avoid the special danger that patents applied to a free program could
|
||||
make it effectively proprietary. To prevent this, the GPL assures that
|
||||
patents cannot be used to render the program non-free.
|
||||
|
||||
The precise terms and conditions for copying, distribution and
|
||||
modification follow.
|
||||
|
||||
TERMS AND CONDITIONS
|
||||
|
||||
0. Definitions.
|
||||
|
||||
"This License" refers to version 3 of the GNU General Public License.
|
||||
|
||||
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||
works, such as semiconductor masks.
|
||||
|
||||
"The Program" refers to any copyrightable work licensed under this
|
||||
License. Each licensee is addressed as "you". "Licensees" and
|
||||
"recipients" may be individuals or organizations.
|
||||
|
||||
To "modify" a work means to copy from or adapt all or part of the work
|
||||
in a fashion requiring copyright permission, other than the making of an
|
||||
exact copy. The resulting work is called a "modified version" of the
|
||||
earlier work or a work "based on" the earlier work.
|
||||
|
||||
A "covered work" means either the unmodified Program or a work based
|
||||
on the Program.
|
||||
|
||||
To "propagate" a work means to do anything with it that, without
|
||||
permission, would make you directly or secondarily liable for
|
||||
infringement under applicable copyright law, except executing it on a
|
||||
computer or modifying a private copy. Propagation includes copying,
|
||||
distribution (with or without modification), making available to the
|
||||
public, and in some countries other activities as well.
|
||||
|
||||
To "convey" a work means any kind of propagation that enables other
|
||||
parties to make or receive copies. Mere interaction with a user through
|
||||
a computer network, with no transfer of a copy, is not conveying.
|
||||
|
||||
An interactive user interface displays "Appropriate Legal Notices"
|
||||
to the extent that it includes a convenient and prominently visible
|
||||
feature that (1) displays an appropriate copyright notice, and (2)
|
||||
tells the user that there is no warranty for the work (except to the
|
||||
extent that warranties are provided), that licensees may convey the
|
||||
work under this License, and how to view a copy of this License. If
|
||||
the interface presents a list of user commands or options, such as a
|
||||
menu, a prominent item in the list meets this criterion.
|
||||
|
||||
1. Source Code.
|
||||
|
||||
The "source code" for a work means the preferred form of the work
|
||||
for making modifications to it. "Object code" means any non-source
|
||||
form of a work.
|
||||
|
||||
A "Standard Interface" means an interface that either is an official
|
||||
standard defined by a recognized standards body, or, in the case of
|
||||
interfaces specified for a particular programming language, one that
|
||||
is widely used among developers working in that language.
|
||||
|
||||
The "System Libraries" of an executable work include anything, other
|
||||
than the work as a whole, that (a) is included in the normal form of
|
||||
packaging a Major Component, but which is not part of that Major
|
||||
Component, and (b) serves only to enable use of the work with that
|
||||
Major Component, or to implement a Standard Interface for which an
|
||||
implementation is available to the public in source code form. A
|
||||
"Major Component", in this context, means a major essential component
|
||||
(kernel, window system, and so on) of the specific operating system
|
||||
(if any) on which the executable work runs, or a compiler used to
|
||||
produce the work, or an object code interpreter used to run it.
|
||||
|
||||
The "Corresponding Source" for a work in object code form means all
|
||||
the source code needed to generate, install, and (for an executable
|
||||
work) run the object code and to modify the work, including scripts to
|
||||
control those activities. However, it does not include the work's
|
||||
System Libraries, or general-purpose tools or generally available free
|
||||
programs which are used unmodified in performing those activities but
|
||||
which are not part of the work. For example, Corresponding Source
|
||||
includes interface definition files associated with source files for
|
||||
the work, and the source code for shared libraries and dynamically
|
||||
linked subprograms that the work is specifically designed to require,
|
||||
such as by intimate data communication or control flow between those
|
||||
subprograms and other parts of the work.
|
||||
|
||||
The Corresponding Source need not include anything that users
|
||||
can regenerate automatically from other parts of the Corresponding
|
||||
Source.
|
||||
|
||||
The Corresponding Source for a work in source code form is that
|
||||
same work.
|
||||
|
||||
2. Basic Permissions.
|
||||
|
||||
All rights granted under this License are granted for the term of
|
||||
copyright on the Program, and are irrevocable provided the stated
|
||||
conditions are met. This License explicitly affirms your unlimited
|
||||
permission to run the unmodified Program. The output from running a
|
||||
covered work is covered by this License only if the output, given its
|
||||
content, constitutes a covered work. This License acknowledges your
|
||||
rights of fair use or other equivalent, as provided by copyright law.
|
||||
|
||||
You may make, run and propagate covered works that you do not
|
||||
convey, without conditions so long as your license otherwise remains
|
||||
in force. You may convey covered works to others for the sole purpose
|
||||
of having them make modifications exclusively for you, or provide you
|
||||
with facilities for running those works, provided that you comply with
|
||||
the terms of this License in conveying all material for which you do
|
||||
not control copyright. Those thus making or running the covered works
|
||||
for you must do so exclusively on your behalf, under your direction
|
||||
and control, on terms that prohibit them from making any copies of
|
||||
your copyrighted material outside their relationship with you.
|
||||
|
||||
Conveying under any other circumstances is permitted solely under
|
||||
the conditions stated below. Sublicensing is not allowed; section 10
|
||||
makes it unnecessary.
|
||||
|
||||
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||
|
||||
No covered work shall be deemed part of an effective technological
|
||||
measure under any applicable law fulfilling obligations under article
|
||||
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||
similar laws prohibiting or restricting circumvention of such
|
||||
measures.
|
||||
|
||||
When you convey a covered work, you waive any legal power to forbid
|
||||
circumvention of technological measures to the extent such circumvention
|
||||
is effected by exercising rights under this License with respect to
|
||||
the covered work, and you disclaim any intention to limit operation or
|
||||
modification of the work as a means of enforcing, against the work's
|
||||
users, your or third parties' legal rights to forbid circumvention of
|
||||
technological measures.
|
||||
|
||||
4. Conveying Verbatim Copies.
|
||||
|
||||
You may convey verbatim copies of the Program's source code as you
|
||||
receive it, in any medium, provided that you conspicuously and
|
||||
appropriately publish on each copy an appropriate copyright notice;
|
||||
keep intact all notices stating that this License and any
|
||||
non-permissive terms added in accord with section 7 apply to the code;
|
||||
keep intact all notices of the absence of any warranty; and give all
|
||||
recipients a copy of this License along with the Program.
|
||||
|
||||
You may charge any price or no price for each copy that you convey,
|
||||
and you may offer support or warranty protection for a fee.
|
||||
|
||||
5. Conveying Modified Source Versions.
|
||||
|
||||
You may convey a work based on the Program, or the modifications to
|
||||
produce it from the Program, in the form of source code under the
|
||||
terms of section 4, provided that you also meet all of these conditions:
|
||||
|
||||
a) The work must carry prominent notices stating that you modified
|
||||
it, and giving a relevant date.
|
||||
|
||||
b) The work must carry prominent notices stating that it is
|
||||
released under this License and any conditions added under section
|
||||
7. This requirement modifies the requirement in section 4 to
|
||||
"keep intact all notices".
|
||||
|
||||
c) You must license the entire work, as a whole, under this
|
||||
License to anyone who comes into possession of a copy. This
|
||||
License will therefore apply, along with any applicable section 7
|
||||
additional terms, to the whole of the work, and all its parts,
|
||||
regardless of how they are packaged. This License gives no
|
||||
permission to license the work in any other way, but it does not
|
||||
invalidate such permission if you have separately received it.
|
||||
|
||||
d) If the work has interactive user interfaces, each must display
|
||||
Appropriate Legal Notices; however, if the Program has interactive
|
||||
interfaces that do not display Appropriate Legal Notices, your
|
||||
work need not make them do so.
|
||||
|
||||
A compilation of a covered work with other separate and independent
|
||||
works, which are not by their nature extensions of the covered work,
|
||||
and which are not combined with it such as to form a larger program,
|
||||
in or on a volume of a storage or distribution medium, is called an
|
||||
"aggregate" if the compilation and its resulting copyright are not
|
||||
used to limit the access or legal rights of the compilation's users
|
||||
beyond what the individual works permit. Inclusion of a covered work
|
||||
in an aggregate does not cause this License to apply to the other
|
||||
parts of the aggregate.
|
||||
|
||||
6. Conveying Non-Source Forms.
|
||||
|
||||
You may convey a covered work in object code form under the terms
|
||||
of sections 4 and 5, provided that you also convey the
|
||||
machine-readable Corresponding Source under the terms of this License,
|
||||
in one of these ways:
|
||||
|
||||
a) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by the
|
||||
Corresponding Source fixed on a durable physical medium
|
||||
customarily used for software interchange.
|
||||
|
||||
b) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by a
|
||||
written offer, valid for at least three years and valid for as
|
||||
long as you offer spare parts or customer support for that product
|
||||
model, to give anyone who possesses the object code either (1) a
|
||||
copy of the Corresponding Source for all the software in the
|
||||
product that is covered by this License, on a durable physical
|
||||
medium customarily used for software interchange, for a price no
|
||||
more than your reasonable cost of physically performing this
|
||||
conveying of source, or (2) access to copy the
|
||||
Corresponding Source from a network server at no charge.
|
||||
|
||||
c) Convey individual copies of the object code with a copy of the
|
||||
written offer to provide the Corresponding Source. This
|
||||
alternative is allowed only occasionally and noncommercially, and
|
||||
only if you received the object code with such an offer, in accord
|
||||
with subsection 6b.
|
||||
|
||||
d) Convey the object code by offering access from a designated
|
||||
place (gratis or for a charge), and offer equivalent access to the
|
||||
Corresponding Source in the same way through the same place at no
|
||||
further charge. You need not require recipients to copy the
|
||||
Corresponding Source along with the object code. If the place to
|
||||
copy the object code is a network server, the Corresponding Source
|
||||
may be on a different server (operated by you or a third party)
|
||||
that supports equivalent copying facilities, provided you maintain
|
||||
clear directions next to the object code saying where to find the
|
||||
Corresponding Source. Regardless of what server hosts the
|
||||
Corresponding Source, you remain obligated to ensure that it is
|
||||
available for as long as needed to satisfy these requirements.
|
||||
|
||||
e) Convey the object code using peer-to-peer transmission, provided
|
||||
you inform other peers where the object code and Corresponding
|
||||
Source of the work are being offered to the general public at no
|
||||
charge under subsection 6d.
|
||||
|
||||
A separable portion of the object code, whose source code is excluded
|
||||
from the Corresponding Source as a System Library, need not be
|
||||
included in conveying the object code work.
|
||||
|
||||
A "User Product" is either (1) a "consumer product", which means any
|
||||
tangible personal property which is normally used for personal, family,
|
||||
or household purposes, or (2) anything designed or sold for incorporation
|
||||
into a dwelling. In determining whether a product is a consumer product,
|
||||
doubtful cases shall be resolved in favor of coverage. For a particular
|
||||
product received by a particular user, "normally used" refers to a
|
||||
typical or common use of that class of product, regardless of the status
|
||||
of the particular user or of the way in which the particular user
|
||||
actually uses, or expects or is expected to use, the product. A product
|
||||
is a consumer product regardless of whether the product has substantial
|
||||
commercial, industrial or non-consumer uses, unless such uses represent
|
||||
the only significant mode of use of the product.
|
||||
|
||||
"Installation Information" for a User Product means any methods,
|
||||
procedures, authorization keys, or other information required to install
|
||||
and execute modified versions of a covered work in that User Product from
|
||||
a modified version of its Corresponding Source. The information must
|
||||
suffice to ensure that the continued functioning of the modified object
|
||||
code is in no case prevented or interfered with solely because
|
||||
modification has been made.
|
||||
|
||||
If you convey an object code work under this section in, or with, or
|
||||
specifically for use in, a User Product, and the conveying occurs as
|
||||
part of a transaction in which the right of possession and use of the
|
||||
User Product is transferred to the recipient in perpetuity or for a
|
||||
fixed term (regardless of how the transaction is characterized), the
|
||||
Corresponding Source conveyed under this section must be accompanied
|
||||
by the Installation Information. But this requirement does not apply
|
||||
if neither you nor any third party retains the ability to install
|
||||
modified object code on the User Product (for example, the work has
|
||||
been installed in ROM).
|
||||
|
||||
The requirement to provide Installation Information does not include a
|
||||
requirement to continue to provide support service, warranty, or updates
|
||||
for a work that has been modified or installed by the recipient, or for
|
||||
the User Product in which it has been modified or installed. Access to a
|
||||
network may be denied when the modification itself materially and
|
||||
adversely affects the operation of the network or violates the rules and
|
||||
protocols for communication across the network.
|
||||
|
||||
Corresponding Source conveyed, and Installation Information provided,
|
||||
in accord with this section must be in a format that is publicly
|
||||
documented (and with an implementation available to the public in
|
||||
source code form), and must require no special password or key for
|
||||
unpacking, reading or copying.
|
||||
|
||||
7. Additional Terms.
|
||||
|
||||
"Additional permissions" are terms that supplement the terms of this
|
||||
License by making exceptions from one or more of its conditions.
|
||||
Additional permissions that are applicable to the entire Program shall
|
||||
be treated as though they were included in this License, to the extent
|
||||
that they are valid under applicable law. If additional permissions
|
||||
apply only to part of the Program, that part may be used separately
|
||||
under those permissions, but the entire Program remains governed by
|
||||
this License without regard to the additional permissions.
|
||||
|
||||
When you convey a copy of a covered work, you may at your option
|
||||
remove any additional permissions from that copy, or from any part of
|
||||
it. (Additional permissions may be written to require their own
|
||||
removal in certain cases when you modify the work.) You may place
|
||||
additional permissions on material, added by you to a covered work,
|
||||
for which you have or can give appropriate copyright permission.
|
||||
|
||||
Notwithstanding any other provision of this License, for material you
|
||||
add to a covered work, you may (if authorized by the copyright holders of
|
||||
that material) supplement the terms of this License with terms:
|
||||
|
||||
a) Disclaiming warranty or limiting liability differently from the
|
||||
terms of sections 15 and 16 of this License; or
|
||||
|
||||
b) Requiring preservation of specified reasonable legal notices or
|
||||
author attributions in that material or in the Appropriate Legal
|
||||
Notices displayed by works containing it; or
|
||||
|
||||
c) Prohibiting misrepresentation of the origin of that material, or
|
||||
requiring that modified versions of such material be marked in
|
||||
reasonable ways as different from the original version; or
|
||||
|
||||
d) Limiting the use for publicity purposes of names of licensors or
|
||||
authors of the material; or
|
||||
|
||||
e) Declining to grant rights under trademark law for use of some
|
||||
trade names, trademarks, or service marks; or
|
||||
|
||||
f) Requiring indemnification of licensors and authors of that
|
||||
material by anyone who conveys the material (or modified versions of
|
||||
it) with contractual assumptions of liability to the recipient, for
|
||||
any liability that these contractual assumptions directly impose on
|
||||
those licensors and authors.
|
||||
|
||||
All other non-permissive additional terms are considered "further
|
||||
restrictions" within the meaning of section 10. If the Program as you
|
||||
received it, or any part of it, contains a notice stating that it is
|
||||
governed by this License along with a term that is a further
|
||||
restriction, you may remove that term. If a license document contains
|
||||
a further restriction but permits relicensing or conveying under this
|
||||
License, you may add to a covered work material governed by the terms
|
||||
of that license document, provided that the further restriction does
|
||||
not survive such relicensing or conveying.
|
||||
|
||||
If you add terms to a covered work in accord with this section, you
|
||||
must place, in the relevant source files, a statement of the
|
||||
additional terms that apply to those files, or a notice indicating
|
||||
where to find the applicable terms.
|
||||
|
||||
Additional terms, permissive or non-permissive, may be stated in the
|
||||
form of a separately written license, or stated as exceptions;
|
||||
the above requirements apply either way.
|
||||
|
||||
8. Termination.
|
||||
|
||||
You may not propagate or modify a covered work except as expressly
|
||||
provided under this License. Any attempt otherwise to propagate or
|
||||
modify it is void, and will automatically terminate your rights under
|
||||
this License (including any patent licenses granted under the third
|
||||
paragraph of section 11).
|
||||
|
||||
However, if you cease all violation of this License, then your
|
||||
license from a particular copyright holder is reinstated (a)
|
||||
provisionally, unless and until the copyright holder explicitly and
|
||||
finally terminates your license, and (b) permanently, if the copyright
|
||||
holder fails to notify you of the violation by some reasonable means
|
||||
prior to 60 days after the cessation.
|
||||
|
||||
Moreover, your license from a particular copyright holder is
|
||||
reinstated permanently if the copyright holder notifies you of the
|
||||
violation by some reasonable means, this is the first time you have
|
||||
received notice of violation of this License (for any work) from that
|
||||
copyright holder, and you cure the violation prior to 30 days after
|
||||
your receipt of the notice.
|
||||
|
||||
Termination of your rights under this section does not terminate the
|
||||
licenses of parties who have received copies or rights from you under
|
||||
this License. If your rights have been terminated and not permanently
|
||||
reinstated, you do not qualify to receive new licenses for the same
|
||||
material under section 10.
|
||||
|
||||
9. Acceptance Not Required for Having Copies.
|
||||
|
||||
You are not required to accept this License in order to receive or
|
||||
run a copy of the Program. Ancillary propagation of a covered work
|
||||
occurring solely as a consequence of using peer-to-peer transmission
|
||||
to receive a copy likewise does not require acceptance. However,
|
||||
nothing other than this License grants you permission to propagate or
|
||||
modify any covered work. These actions infringe copyright if you do
|
||||
not accept this License. Therefore, by modifying or propagating a
|
||||
covered work, you indicate your acceptance of this License to do so.
|
||||
|
||||
10. Automatic Licensing of Downstream Recipients.
|
||||
|
||||
Each time you convey a covered work, the recipient automatically
|
||||
receives a license from the original licensors, to run, modify and
|
||||
propagate that work, subject to this License. You are not responsible
|
||||
for enforcing compliance by third parties with this License.
|
||||
|
||||
An "entity transaction" is a transaction transferring control of an
|
||||
organization, or substantially all assets of one, or subdividing an
|
||||
organization, or merging organizations. If propagation of a covered
|
||||
work results from an entity transaction, each party to that
|
||||
transaction who receives a copy of the work also receives whatever
|
||||
licenses to the work the party's predecessor in interest had or could
|
||||
give under the previous paragraph, plus a right to possession of the
|
||||
Corresponding Source of the work from the predecessor in interest, if
|
||||
the predecessor has it or can get it with reasonable efforts.
|
||||
|
||||
You may not impose any further restrictions on the exercise of the
|
||||
rights granted or affirmed under this License. For example, you may
|
||||
not impose a license fee, royalty, or other charge for exercise of
|
||||
rights granted under this License, and you may not initiate litigation
|
||||
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||
any patent claim is infringed by making, using, selling, offering for
|
||||
sale, or importing the Program or any portion of it.
|
||||
|
||||
11. Patents.
|
||||
|
||||
A "contributor" is a copyright holder who authorizes use under this
|
||||
License of the Program or a work on which the Program is based. The
|
||||
work thus licensed is called the contributor's "contributor version".
|
||||
|
||||
A contributor's "essential patent claims" are all patent claims
|
||||
owned or controlled by the contributor, whether already acquired or
|
||||
hereafter acquired, that would be infringed by some manner, permitted
|
||||
by this License, of making, using, or selling its contributor version,
|
||||
but do not include claims that would be infringed only as a
|
||||
consequence of further modification of the contributor version. For
|
||||
purposes of this definition, "control" includes the right to grant
|
||||
patent sublicenses in a manner consistent with the requirements of
|
||||
this License.
|
||||
|
||||
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||
patent license under the contributor's essential patent claims, to
|
||||
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||
propagate the contents of its contributor version.
|
||||
|
||||
In the following three paragraphs, a "patent license" is any express
|
||||
agreement or commitment, however denominated, not to enforce a patent
|
||||
(such as an express permission to practice a patent or covenant not to
|
||||
sue for patent infringement). To "grant" such a patent license to a
|
||||
party means to make such an agreement or commitment not to enforce a
|
||||
patent against the party.
|
||||
|
||||
If you convey a covered work, knowingly relying on a patent license,
|
||||
and the Corresponding Source of the work is not available for anyone
|
||||
to copy, free of charge and under the terms of this License, through a
|
||||
publicly available network server or other readily accessible means,
|
||||
then you must either (1) cause the Corresponding Source to be so
|
||||
available, or (2) arrange to deprive yourself of the benefit of the
|
||||
patent license for this particular work, or (3) arrange, in a manner
|
||||
consistent with the requirements of this License, to extend the patent
|
||||
license to downstream recipients. "Knowingly relying" means you have
|
||||
actual knowledge that, but for the patent license, your conveying the
|
||||
covered work in a country, or your recipient's use of the covered work
|
||||
in a country, would infringe one or more identifiable patents in that
|
||||
country that you have reason to believe are valid.
|
||||
|
||||
If, pursuant to or in connection with a single transaction or
|
||||
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||
covered work, and grant a patent license to some of the parties
|
||||
receiving the covered work authorizing them to use, propagate, modify
|
||||
or convey a specific copy of the covered work, then the patent license
|
||||
you grant is automatically extended to all recipients of the covered
|
||||
work and works based on it.
|
||||
|
||||
A patent license is "discriminatory" if it does not include within
|
||||
the scope of its coverage, prohibits the exercise of, or is
|
||||
conditioned on the non-exercise of one or more of the rights that are
|
||||
specifically granted under this License. You may not convey a covered
|
||||
work if you are a party to an arrangement with a third party that is
|
||||
in the business of distributing software, under which you make payment
|
||||
to the third party based on the extent of your activity of conveying
|
||||
the work, and under which the third party grants, to any of the
|
||||
parties who would receive the covered work from you, a discriminatory
|
||||
patent license (a) in connection with copies of the covered work
|
||||
conveyed by you (or copies made from those copies), or (b) primarily
|
||||
for and in connection with specific products or compilations that
|
||||
contain the covered work, unless you entered into that arrangement,
|
||||
or that patent license was granted, prior to 28 March 2007.
|
||||
|
||||
Nothing in this License shall be construed as excluding or limiting
|
||||
any implied license or other defenses to infringement that may
|
||||
otherwise be available to you under applicable patent law.
|
||||
|
||||
12. No Surrender of Others' Freedom.
|
||||
|
||||
If conditions are imposed on you (whether by court order, agreement or
|
||||
otherwise) that contradict the conditions of this License, they do not
|
||||
excuse you from the conditions of this License. If you cannot convey a
|
||||
covered work so as to satisfy simultaneously your obligations under this
|
||||
License and any other pertinent obligations, then as a consequence you may
|
||||
not convey it at all. For example, if you agree to terms that obligate you
|
||||
to collect a royalty for further conveying from those to whom you convey
|
||||
the Program, the only way you could satisfy both those terms and this
|
||||
License would be to refrain entirely from conveying the Program.
|
||||
|
||||
13. Use with the GNU Affero General Public License.
|
||||
|
||||
Notwithstanding any other provision of this License, you have
|
||||
permission to link or combine any covered work with a work licensed
|
||||
under version 3 of the GNU Affero General Public License into a single
|
||||
combined work, and to convey the resulting work. The terms of this
|
||||
License will continue to apply to the part which is the covered work,
|
||||
but the special requirements of the GNU Affero General Public License,
|
||||
section 13, concerning interaction through a network will apply to the
|
||||
combination as such.
|
||||
|
||||
14. Revised Versions of this License.
|
||||
|
||||
The Free Software Foundation may publish revised and/or new versions of
|
||||
the GNU General Public License from time to time. Such new versions will
|
||||
be similar in spirit to the present version, but may differ in detail to
|
||||
address new problems or concerns.
|
||||
|
||||
Each version is given a distinguishing version number. If the
|
||||
Program specifies that a certain numbered version of the GNU General
|
||||
Public License "or any later version" applies to it, you have the
|
||||
option of following the terms and conditions either of that numbered
|
||||
version or of any later version published by the Free Software
|
||||
Foundation. If the Program does not specify a version number of the
|
||||
GNU General Public License, you may choose any version ever published
|
||||
by the Free Software Foundation.
|
||||
|
||||
If the Program specifies that a proxy can decide which future
|
||||
versions of the GNU General Public License can be used, that proxy's
|
||||
public statement of acceptance of a version permanently authorizes you
|
||||
to choose that version for the Program.
|
||||
|
||||
Later license versions may give you additional or different
|
||||
permissions. However, no additional obligations are imposed on any
|
||||
author or copyright holder as a result of your choosing to follow a
|
||||
later version.
|
||||
|
||||
15. Disclaimer of Warranty.
|
||||
|
||||
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
||||
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
||||
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
||||
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
||||
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||
|
||||
16. Limitation of Liability.
|
||||
|
||||
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
||||
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
||||
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
||||
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
||||
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
||||
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
||||
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
||||
SUCH DAMAGES.
|
||||
|
||||
17. Interpretation of Sections 15 and 16.
|
||||
|
||||
If the disclaimer of warranty and limitation of liability provided
|
||||
above cannot be given local legal effect according to their terms,
|
||||
reviewing courts shall apply local law that most closely approximates
|
||||
an absolute waiver of all civil liability in connection with the
|
||||
Program, unless a warranty or assumption of liability accompanies a
|
||||
copy of the Program in return for a fee.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
How to Apply These Terms to Your New Programs
|
||||
|
||||
If you develop a new program, and you want it to be of the greatest
|
||||
possible use to the public, the best way to achieve this is to make it
|
||||
free software which everyone can redistribute and change under these terms.
|
||||
|
||||
To do so, attach the following notices to the program. It is safest
|
||||
to attach them to the start of each source file to most effectively
|
||||
state the exclusion of warranty; and each file should have at least
|
||||
the "copyright" line and a pointer to where the full notice is found.
|
||||
|
||||
<one line to give the program's name and a brief idea of what it does.>
|
||||
Copyright (C) <year> <name of author>
|
||||
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
|
||||
Also add information on how to contact you by electronic and paper mail.
|
||||
|
||||
If the program does terminal interaction, make it output a short
|
||||
notice like this when it starts in an interactive mode:
|
||||
|
||||
<program> Copyright (C) <year> <name of author>
|
||||
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
||||
This is free software, and you are welcome to redistribute it
|
||||
under certain conditions; type `show c' for details.
|
||||
|
||||
The hypothetical commands `show w' and `show c' should show the appropriate
|
||||
parts of the General Public License. Of course, your program's commands
|
||||
might be different; for a GUI interface, you would use an "about box".
|
||||
|
||||
You should also get your employer (if you work as a programmer) or school,
|
||||
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
||||
For more information on this, and how to apply and follow the GNU GPL, see
|
||||
<https://www.gnu.org/licenses/>.
|
||||
|
||||
The GNU General Public License does not permit incorporating your program
|
||||
into proprietary programs. If your program is a subroutine library, you
|
||||
may consider it more useful to permit linking proprietary applications with
|
||||
the library. If this is what you want to do, use the GNU Lesser General
|
||||
Public License instead of this License. But first, please read
|
||||
<https://www.gnu.org/licenses/why-not-lgpl.html>.
|
||||
245
README.md
@@ -1,35 +1,246 @@
|
||||
# Proxmox VE for WHMCS (Module) Provision & Manage
|
||||
|
||||
- Automatically Provision VMs & CTs in [Proxmox VE](https://proxmox.com/en/proxmox-ve/features) from [WHMCS](https://www.whmcs.com/tour/)
|
||||
- Allow clients to view/manage VMs using WHMCS Client Area
|
||||
**Salvation, a free and open-source solution for beloved PVE!** If you love it, REVIEW & SHARE IT! ❤️
|
||||
|
||||
The original module was written in 2 months by @cybercoder for sale online in 2016, though didn't sell any copies so they kindly open-sourced it and removed the licensing requirement.
|
||||
<img alt="Logo for the Proxmox VE for WHMCS module" src="zLOGO.png">
|
||||
|
||||
We're slowly overhauling the Module to suit our internal needs at [LEOPARD.host](https://leopard.host).
|
||||
- Configure VM/CT plans with custom CPU/RAM/VLAN/On-boot/Bandwidth/etc
|
||||
- Automatically Provision VMs & CTs in [Proxmox VE](https://proxmox.com/en/proxmox-virtual-environment/features) from [WHMCS](https://www.whmcs.com/tour/) easily
|
||||
- Allow clients to view/manage VMs using the WHMCS Client Area
|
||||
- Create/Suspend/Unsuspend/Terminate via WHMCS Admin Area
|
||||
- Statistics/Graphing is available in the Client Area for services :)
|
||||
|
||||
**System Requirements:**
|
||||
## ❤️ RTFM: Read the Manual & Review the Module!
|
||||
|
||||
- WHMCS 8.x stable
|
||||
- PHP 8.x stable
|
||||
- Proxmox VE 7
|
||||
**Please read the entire README.md file before getting started with Proxmox VE for WHMCS.** Thanks!
|
||||
|
||||
**Libraries & Dependencies:**
|
||||
We're pretty much done overhauling the Module to suit our needs at [The Network Crew Pty Ltd (TNC)](https://thenetworkcrew.com.au).
|
||||
|
||||
- [PHP Client for PVE2 API](https://github.com/CpuID/pve2-api-php-client) (Dec 5th, 2022)
|
||||
- [TigerVNC VncViewer.jar](https://sourceforge.net/projects/tigervnc/files/stable/) (v1.13.1 in repo)
|
||||
- [NoVNC HTML5 Viewer](https://github.com/novnc/noVNC) (v1.4.0 in repo)
|
||||
> **Please review the module!** https://marketplace.whmcs.com/product/6935-proxmox-ve-for-whmcs
|
||||
>
|
||||
> If you want it to remain free and fabulous, it could use a moment of your time in reviewing it. Thanks!
|
||||
|
||||
**Documentation & Resources:**
|
||||
## 🎯 MODULE: System Requirements (PVE/WHMCS)
|
||||
|
||||
New Biz: Fresh Installations/Businesses using WHMCS need to take note of the Service ID < 100 case.
|
||||
|
||||
**SID >100:** The WHMCS Service ID requirement is CRITICAL, as Proxmox reserves VMIDs <100 (system).
|
||||
|
||||
- (WHMCS) v8.x.x stable (HTTPS)
|
||||
- (WHMCS) **Service ID above 100**
|
||||
- (PHP) v8.x (stable version)
|
||||
- (Proxmox) VE v8.x (current)
|
||||
- (Proxmox) 2 users (API/VNC)
|
||||
|
||||
_If you don't have enough services (of any status) in WHMCS (DB: tblhosting.id), create enough dummy/test entries to reach Service ID 101+._ **Else you're likely to see an error which explains this:** `HTTP/1.1 400 Parameter verification failed. (invalid format - value does not look like a valid VM ID)`
|
||||
|
||||
## ✅ MODULE: Installation & Configuration
|
||||
|
||||
**DON'T SKIP ANY PART OF THIS README.md - please don't raise pointless Issues - thank you!**
|
||||
|
||||
Firstly, you need to upload, activate and make the WHMCS Module available to Administrators.
|
||||
|
||||
Once you've done all of that, in order to get the module working properly, you need to:
|
||||
|
||||
0. Proxmox VE > Create an additional VNC-only user, per instructions below
|
||||
1. WHMCS Admin > Config > Servers > Add your PVE host/s (user: root; IP: PVE's)
|
||||
2. WHMCS Admin > Addons > Proxmox VE for WHMCS > Module Config > VNC Secret (see below)
|
||||
3. WHMCS Admin > Addons > Proxmox VE for WHMCS > Add KVM/LXC Plan/s
|
||||
4. WHMCS Admin > Addons > Proxmox VE for WHMCS > Add an IP Pool
|
||||
5. WHMCS Admin > Config > Products/Services > New Service (create offering)
|
||||
6. " " > Newly-added Service > Tab 3 > **SAVE** (links Module Plan to WHMCS Service type)
|
||||
|
||||
## 🥽 noVNC: Console Tunnel (Client Area)
|
||||
|
||||
After forking the module, we considered how to improve security of Console Tunneling via WHMCS. We decided to implement a routing method which uses a secondary user in Proxmox VE with very restrictive permissions. This requires more work to make it function, however improves security.
|
||||
|
||||
### To offer VNC via WHMCS Client Area
|
||||
|
||||
1. Install & configure the module properly
|
||||
2. Follow the PVE User Requirement info below
|
||||
3. Public IPv4 for PVE (or proxy to private)
|
||||
4. PVE and WHMCS on the same Domain Name*
|
||||
5. Have valid PTR/rDNS for the PVE Address
|
||||
|
||||
noVNC has been overhauled. It isn't guaranteed, nor the project at all. :-)
|
||||
|
||||
- Note #1 = You must use different Subdomains on the same Domain Name, for the cookie (anti-CSRF).
|
||||
- Note #2 = If your Domain Name has a 2-part TLD (ie. co.uk) then you will need to fork & amend `novnc_router.php` - ideally we/someone will optimise this to better cater to all formats.
|
||||
|
||||
## 👥 PVE: User Requirements (API & VNC)
|
||||
|
||||
**You must have a root account to use the Module at all.** Configured via WHMCS > Servers.
|
||||
|
||||
Additionally, to improve security, for VNC you must also have a Restricted User. Configured in the _Module_.
|
||||
|
||||
### Creating the VNC user within PVE
|
||||
|
||||
1. Create User Group "VNC" via PVE > Datacenter / Permissions / Group
|
||||
2. Create new User "vnc" > Datacenter / Permissions / Users - select Group: "VNC", Realm: pve
|
||||
3. Create new Role -> Datacenter / Permissions / Roles - select Name: "VNC", Privileges: VM.Console (only)
|
||||
4. Add permission to access VNC -> Datacenter / Node / VM / Permissions / Add Group Permissions - select Group: "VNC", Role: "VNC"
|
||||
5. Configure the WHMCS > Modules > Proxmox VE for WHMCS > Module Config > VNC Secret with 'vnc' password.
|
||||
|
||||
> Do NOT set less restrictive permissions. The above is designed for hypervisor security.
|
||||
|
||||
## ⚙️ VM/CT PLANS: Setting everything up
|
||||
|
||||
These steps explain the unique requirements per-option.
|
||||
|
||||
Custom Fields: Values need to go in Name & Select Options.
|
||||
|
||||
> **Unsure?** Consult the zMANUAL-PVE4.pdf _legacy_ manual file.
|
||||
|
||||
### VM Option 1: KVM, using PVE Template VM
|
||||
|
||||
Firstly, create the Template in PVE. You need its unique PVE ID.
|
||||
|
||||
Use that ID in the Custom Field `KVMTemplate`, as in `ID|Name`.
|
||||
|
||||
> Note: `Name` is what's displayed in the WHMCS Client Area.
|
||||
|
||||
### VM Option 2: KVM, WHMCS Plan + PVE ISO
|
||||
|
||||
Firstly, create the Plan in WHMCS Module. Then, WHMCS Config > Services.
|
||||
|
||||
Under the Service, you need to add a Custom Field `ISO` with the full location.
|
||||
|
||||
### CT Option: LXC, using PVE Template File
|
||||
|
||||
Firstly, store the Template in PVE. You need its unique File Name.
|
||||
|
||||
Use that full file name in the Custom Field `Template`, as in:
|
||||
|
||||
`ubuntu-99.99-standard_amd64.tar.gz|Ubuntu 99`
|
||||
|
||||
Then make a 2nd Custom Field `Password` for the CT's root user.
|
||||
|
||||
## 🌐 IPv4/v6: Networking (IP Pools)
|
||||
|
||||
Please make sure you create an IP Pool with sufficient scope/size to be able to deploy addresses within it to your guest VMs and CTs. Else it won't be able to create a Service for you.
|
||||
|
||||
**Private IPs for PVE Hosts:** Note that VNC may be problematic without work due to the strict requirements introduced in Proxmox v8.0 (strict same-site attribute).
|
||||
|
||||
### IPv6: Not yet functional! 😐
|
||||
|
||||
Per The-Network-Crew/Proxmox-VE-for-WHMCS#33 there is not yet functional IPv6 in this module.
|
||||
|
||||
You can of course add this via PVE/`pvesh` manually, however it isn't module-supported as of late 2023.
|
||||
|
||||
## 💅 FEATURES: PVE v8.0/8.1 bling
|
||||
|
||||
There are new features deployed into Proxmox VE upstream in the v8 branch which are exciting and should be added to this module.
|
||||
|
||||
### Proxmox v8.0
|
||||
|
||||
1. Create, manage and assign resource mappings for PCI and USB devices for use in virtual machines (VMs) via API and web UI.
|
||||
2. (DONE) Add virtual machine CPU models based on the x86-64 psABI Micro-Architecture Levels and use the widely supported x86-64-v2-AES as default for new VMs created via the web UI.
|
||||
|
||||
### Proxmox v8.1
|
||||
|
||||
1. Secure Boot support.
|
||||
2. Software Defined Networking (SDN).
|
||||
3. New flexible notification system (SMTP & Gotify).
|
||||
4. MAC Organizationally Unique Identifier (OUI) BC:24:11: prefix!
|
||||
|
||||
Reference: https://pve.proxmox.com/wiki/Roadmap
|
||||
|
||||
## 🤬 ABUSE: Zero Tolerance (ZT)
|
||||
|
||||
This module has been overhauled and remains functionally-OK but not thoroughly tested nor reviewed.
|
||||
|
||||
Your support and assistance is always welcomed per the spirit of FOSS (Free Open-source Software)!
|
||||
|
||||
If you cannot accept this, do not download nor use the code. Complaints, nasty reviews, and similar behaviour is against the spirit of FOSS and will not be tolerated.
|
||||
|
||||
**Be grateful & considerate - thank you!**
|
||||
|
||||
## 🆘 HELP: Best-effort Support
|
||||
|
||||
**Before raising a [GitHub Issue](https://github.com/The-Network-Crew/Proxmox-VE-for-WHMCS/issues), please check:**
|
||||
|
||||
1. The [Wiki](https://github.com/The-Network-Crew/Proxmox-VE-for-WHMCS/wiki)
|
||||
2. The [README.md](https://github.com/The-Network-Crew/Proxmox-VE-for-WHMCS/tree/master)
|
||||
3. Open [GitHub Issues](https://github.com/The-Network-Crew/Proxmox-VE-for-WHMCS/issues)
|
||||
4. HTTP, PHP, WHMCS & debug logs (see below).
|
||||
5. PVE logs; best practices; network; etc.
|
||||
6. Read the errors. Do they explain it?
|
||||
|
||||
> Help: Including logs, details, steps to reproduce, etc, please raise a [GitHub Issue](https://github.com/The-Network-Crew/Proxmox-VE-for-WHMCS/issues).
|
||||
>
|
||||
> Logs: We work to ensure that Proxmox VE for WHMCS passes through error details to you.
|
||||
|
||||
### Issues/etc raised must include:
|
||||
|
||||
#### Logging & Debug Logging
|
||||
|
||||
- (Logs: PHP) `error_log` contents
|
||||
- (Logs: WHMCS) Module Debug Logging*
|
||||
- (Logs: Config) WHMCS Display/Log Errors = ON
|
||||
- (Logs: PVE) Logs from Proxmox Host (`pveproxy` etc)
|
||||
|
||||
#### Other Support Requirements
|
||||
|
||||
- (Visibility) Screenshots of the issue
|
||||
- (Configs) WHMCS/PHP/Module/Proxmox/etc
|
||||
- (Reproduction) `pvesh` etc variants of failing calls
|
||||
- (Network) Proof WHMCS Server can talk to PVE OK
|
||||
- (PEBKAC) _PROOF THAT YOU'VE FOLLOWED THIS README!_
|
||||
|
||||
The more info/context you provide up-front, the quicker & easier it will be!
|
||||
|
||||
\* Debug: Make sure you enable Debug Logging in the Module Settings, as needed.
|
||||
|
||||
**Please note that this is FOSS and Support is not guaranteed at all.**
|
||||
|
||||
**If you don't read, listen or actively try, no help given.**
|
||||
|
||||
## 🔄 UPDATING: Patching the Module
|
||||
|
||||
WHMCS Admin > Addon Modules > Proxmox VE for WHMCS > Support/Health shows updates.
|
||||
|
||||
You can download the new version and upload it over the top, then run any needed SQL ops.
|
||||
|
||||
Please consult the [UPDATE-SQL.md](https://github.com/The-Network-Crew/Proxmox-VE-for-WHMCS/blob/master/UPDATE-SQL.md) file, open your WHMCS DB & run the statements. Then you're done.
|
||||
|
||||
## 🖥️ INC: Libraries & Dependencies
|
||||
|
||||
- (MIT) [PHP Client for PVE2 API](https://github.com/CpuID/pve2-api-php-client) (Dec 5th, 2022)
|
||||
- (GPLv2) [TigerVNC VncViewer.jar](https://sourceforge.net/projects/tigervnc/files/stable/) (v1.13.1 in repo)
|
||||
- (MPLv2) [noVNC HTML5 Viewer](https://github.com/novnc/noVNC) (v1.4.0 in repo)
|
||||
- (GPLv3) [SPICE HTML5 Viewer](https://gitlab.freedesktop.org/spice/spice-html5) (v0.3 in repo)
|
||||
- (MIT) [IPv4/SN Validation](https://github.com/tapmodo/php-ipv4/) (August 2012)
|
||||
|
||||
## 📄 DIY: Documentation & Resources
|
||||
|
||||
- Proxmox API: https://pve.proxmox.com/pve-docs/api-viewer/
|
||||
- TigerVNC: https://github.com/TigerVNC/tigervnc/wiki
|
||||
- NoVNC: https://github.com/novnc/noVNC/wiki
|
||||
- noVNC: https://github.com/novnc/noVNC/wiki
|
||||
- WHMCS: https://developers.whmcs.com/
|
||||
- x86-64-ABI: [latest PDF download](https://gitlab.com/x86-psABIs/x86-64-ABI/-/jobs/artifacts/master/raw/x86-64-ABI/abi.pdf?job=build)
|
||||
|
||||
**Problems & Contributions**
|
||||
## 🎉 FOSS: Contributions & Open-source
|
||||
|
||||
If you have any problems with the Module, please raise an [Issue](https://github.com/LEOPARD-host/Proxmox-VE-for-WHMCS/issues).
|
||||
If you'd like to contribute to the Module, please open a [PR](https://github.com/The-Network-Crew/Proxmox-VE-for-WHMCS/pulls).
|
||||
|
||||
If you'd like to contribute to the Module, please open a [PR](https://github.com/LEOPARD-host/Proxmox-VE-for-WHMCS/pulls).
|
||||
The original module was written in 2 months by @cybercoder for sale online in 2016, though didn't sell any copies so they kindly open-sourced it and removed the licensing requirement.
|
||||
|
||||
We would like to thank [@cybercoder](https://github.com/cybercoder/) and [@WaldperlachFabi](https://github.com/WaldperlachFabi) for their original contributions and troubleshooting assistance respectively.
|
||||
|
||||
Thank you to [psyborg®](https://www.psyborg.com.au/graphic-design-services-newcastle/logo-design/) for the module's logo design! We love it.
|
||||
|
||||
FOSS is only possible thanks to dedicated individuals!
|
||||
|
||||
## Usage License (GPLv3) & Links to TNC & Co.
|
||||
|
||||
_**This module is licensed under the GNU General Public License (GPL) v3.0.**_
|
||||
|
||||
GPLv3: https://www.gnu.org/licenses/gpl-3.0.txt (by the Free Software Foundation)
|
||||
|
||||
**[The Network Crew Pty Ltd](https://thenetworkcrew.com.au)**
|
||||
|
||||
**[LEOPARD.host](https://leopard.host)**
|
||||
|
||||
### Support: Best-effort via GitHub Issues
|
||||
|
||||
Browse issues, raise a new one: **[GitHub Issues](https://github.com/The-Network-Crew/Proxmox-VE-for-WHMCS/issues)**
|
||||
|
||||
57
SECURITY.md
Normal file
@@ -0,0 +1,57 @@
|
||||
# Security Policy
|
||||
|
||||
## 🏥 Supported Versions
|
||||
|
||||
The single latest available release is the only release supported by this Security Policy.
|
||||
|
||||
| Version | Supported |
|
||||
| ------- | ------------------ |
|
||||
| 1.x.x latest | :white_check_mark: |
|
||||
| 1.2.x | :x: |
|
||||
| 1.1.x | :x: |
|
||||
| 1.0.x | :x: |
|
||||
|
||||
> \* Note: Latest version - if it is v1.2.3 then that is supported, if latest is v1.4.1 then that is supported, etc.
|
||||
|
||||
## 🔒 Secure Code Contributions
|
||||
|
||||
Please refrain from depending on any external source - for instance, noVNC-latest is bundled into the Module.
|
||||
|
||||
Best practices should be followed during Software Engineering which is especially hard when only patching.
|
||||
|
||||
### For instance, work to implement:
|
||||
|
||||
- Principle of Least Privilege
|
||||
- Input Validation & Sanitisation
|
||||
- Secure Communication (HTTPS etc)
|
||||
- Compatibility with core/updates
|
||||
- Thorough inline comments/specs
|
||||
- Robust error handling/logging
|
||||
- Secure configs by default
|
||||
|
||||
### References:
|
||||
|
||||
- https://owasp.org/
|
||||
- [CERT Secure Coding](https://wiki.sei.cmu.edu/confluence/display/seccode/SEI+CERT+Coding+Standards)
|
||||
- [NIST Secure SW Dev](https://csrc.nist.gov/Projects/ssdf)
|
||||
- [MIT Open Security](https://ocw.mit.edu/courses/6-858-computer-systems-security-fall-2014/)
|
||||
|
||||
## 🐛 Reporting a Vulnerability
|
||||
|
||||
GitHub "Private vulnerability reporting" is enabled for The-Network-Crew/Proxmox-VE-for-WHMCS repository.
|
||||
|
||||
Or, use a publicly-available email address for The Network Crew Pty Ltd to submit it via email instead.
|
||||
|
||||
DO NOT raise a public issue where there is threat to users of the module. Raise it properly.
|
||||
|
||||
### No bounties offered
|
||||
|
||||
As a company, we do not believe in paying security bounties, rather in writing good code.
|
||||
|
||||
We appreciate your input and work to address issues as quickly as possible, security first and foremost.
|
||||
|
||||
Updates can be provided as promptly as days apart, however this depends on severity/scope, and is always reasonable.
|
||||
|
||||
## ❤️ Thank you for responsibly disclosing
|
||||
|
||||
We & the entire FOSS community thank you for reviewing this file & being aware of how to improve the project.
|
||||
8
UPDATE-SQL.md
Normal file
@@ -0,0 +1,8 @@
|
||||
# SQL Statements for Updates (nav to DB first)
|
||||
|
||||
### v1.2.1 to v1.2.2
|
||||
|
||||
```
|
||||
ALTER TABLE mod_pvewhmcs ADD COLUMN `debug_mode` tinyint(1) unsigned DEFAULT '0';
|
||||
ALTER TABLE mod_pvewhmcs_plans ADD COLUMN `vlanid` varchar(10) DEFAULT NULL;
|
||||
```
|
||||
@@ -23,13 +23,13 @@ class Ipv4_Address
|
||||
* fromLong
|
||||
* Creates Ipv4_Address object from a decimal (long) address
|
||||
*
|
||||
* @param real $data
|
||||
* @param float $data
|
||||
* @static
|
||||
* @access public
|
||||
* @return Ipv4_Address
|
||||
*/
|
||||
static function fromLong($data) {
|
||||
return new self((real)$data);
|
||||
return new self((float)$data);
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -61,7 +61,7 @@ class Ipv4_Address
|
||||
* Returns value as decimal (long) address
|
||||
*
|
||||
* @access public
|
||||
* @return real
|
||||
* @return float
|
||||
*/
|
||||
public function toLong() {
|
||||
return $this->ip_long;
|
||||
@@ -93,7 +93,7 @@ class Ipv4_Address
|
||||
* __construct
|
||||
* Private constructor
|
||||
*
|
||||
* @param real $long
|
||||
* @param float $long
|
||||
* @access private
|
||||
* @return void
|
||||
*/
|
||||
|
||||
@@ -1,9 +1,11 @@
|
||||
CREATE TABLE IF NOT EXISTS `mod_pvewhmcs` (
|
||||
`id` int(10) unsigned NOT NULL AUTO_INCREMENT,
|
||||
`config` text,
|
||||
`config` varchar(255),
|
||||
`vnc_secret` varchar(255),
|
||||
`debug_mode` tinyint(1) unsigned DEFAULT '0',
|
||||
PRIMARY KEY (`id`)
|
||||
);
|
||||
INSERT INTO `mod_pvewhmcs` (`id`, `config`) VALUES (1, NULL);
|
||||
INSERT INTO `mod_pvewhmcs` (`id`, `config`, `vnc_secret`) VALUES (1, NULL, NULL);
|
||||
CREATE TABLE IF NOT EXISTS `mod_pvewhmcs_ip_addresses` (
|
||||
`id` int(11) NOT NULL AUTO_INCREMENT,
|
||||
`pool_id` int(11) NOT NULL DEFAULT '0',
|
||||
@@ -20,13 +22,13 @@ CREATE TABLE IF NOT EXISTS `mod_pvewhmcs_ip_pools` (
|
||||
);
|
||||
CREATE TABLE IF NOT EXISTS `mod_pvewhmcs_plans` (
|
||||
`id` int(10) unsigned NOT NULL AUTO_INCREMENT,
|
||||
`title` varchar(255) CHARACTER SET utf8 NOT NULL COMMENT 'Plan name',
|
||||
`vmtype` varchar(8) NOT NULL COMMENT 'Type of Guest e.g KVM or Openvz or others in feuture',
|
||||
`ostype` varchar(8) DEFAULT NULL COMMENT 'Operating System Type',
|
||||
`title` varchar(255) CHARACTER SET utf8 NOT NULL,
|
||||
`vmtype` varchar(8) NOT NULL,
|
||||
`ostype` varchar(8) DEFAULT NULL,
|
||||
`cpus` tinyint(2) unsigned DEFAULT NULL,
|
||||
`cpuemu` varchar(30) CHARACTER SET utf8 DEFAULT NULL COMMENT 'Emulated CPU Type e.g: 486 | athlon | pentium | pentium2 | pentium3 | coreduo | core2duo | kvm32 | kvm64 | qemu32 | qemu64 | phenom | Conroe | Penryn | Nehalem | Westmere | SandyBridge | IvyBridge | Haswell | Broadwell | Opteron_G1 | Opteron_G2 | Opteron_G3 | Opteron_G4 | Opteron_G5 | host',
|
||||
`cores` tinyint(2) unsigned DEFAULT NULL COMMENT 'The number of cores per socket',
|
||||
`cpulimit` smallint(5) unsigned DEFAULT NULL COMMENT 'Limit of CPU usage. Note if the computer has 2 CPUs, it has total of ''2'' CPU time. Value ''0'' indicates no CPU limit.',
|
||||
`cpuemu` varchar(30) CHARACTER SET utf8 DEFAULT NULL,
|
||||
`cores` tinyint(2) unsigned DEFAULT NULL,
|
||||
`cpulimit` smallint(5) unsigned DEFAULT NULL,
|
||||
`cpuunits` smallint(5) unsigned DEFAULT NULL,
|
||||
`memory` smallint(5) unsigned NOT NULL,
|
||||
`swap` smallint(5) unsigned DEFAULT NULL,
|
||||
@@ -34,6 +36,8 @@ CREATE TABLE IF NOT EXISTS `mod_pvewhmcs_plans` (
|
||||
`diskformat` varchar(10) DEFAULT NULL,
|
||||
`diskcache` varchar(20) DEFAULT NULL,
|
||||
`disktype` varchar(20) DEFAULT NULL,
|
||||
`storage` varchar(20) DEFAULT 'local',
|
||||
`diskio` varchar(20) DEFAULT '0',
|
||||
`netmode` varchar(10) DEFAULT NULL,
|
||||
`bridge` varchar(20) NOT NULL DEFAULT 'vmbr',
|
||||
`vmbr` tinyint(1) unsigned NOT NULL DEFAULT '0',
|
||||
@@ -43,6 +47,7 @@ CREATE TABLE IF NOT EXISTS `mod_pvewhmcs_plans` (
|
||||
`bw` int(6) unsigned DEFAULT '0',
|
||||
`kvm` tinyint(1) unsigned DEFAULT '0',
|
||||
`onboot` tinyint(1) unsigned DEFAULT '0',
|
||||
`vlanid` varchar(10) DEFAULT NULL,
|
||||
PRIMARY KEY (`id`)
|
||||
);
|
||||
CREATE TABLE IF NOT EXISTS `mod_pvewhmcs_vms` (
|
||||
|
||||
@@ -1,5 +1,26 @@
|
||||
<?php
|
||||
|
||||
/*
|
||||
Proxmox VE for WHMCS - Addon/Server Modules for WHMCS (& PVE)
|
||||
https://github.com/The-Network-Crew/Proxmox-VE-for-WHMCS/
|
||||
File: /modules/addons/pvewhmcs/hooks.php (WHMCS Hooks)
|
||||
|
||||
Copyright (C) The Network Crew Pty Ltd (TNC) & Co.
|
||||
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
if (!defined("WHMCS"))
|
||||
die("This file cannot be accessed directly");
|
||||
|
||||
@@ -15,4 +36,4 @@ function pvewhmcs_hook_logout($vars) {
|
||||
}
|
||||
|
||||
// Define Client Logout Hook Call
|
||||
add_hook("ClientLogout",1,"pvewhmcs_hook_logout");
|
||||
add_hook("ClientLogout",1,"pvewhmcs_hook_logout");
|
||||
|
||||
@@ -1,5 +1,31 @@
|
||||
<?php
|
||||
|
||||
/*
|
||||
|
||||
Proxmox VE APIv2 (PVE2) Client - PHP Class
|
||||
https://github.com/CpuID/pve2-api-php-client/
|
||||
|
||||
Copyright (c) Nathan Sullivan
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy of
|
||||
this software and associated documentation files (the "Software"), to deal in
|
||||
the Software without restriction, including without limitation the rights to
|
||||
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
|
||||
the Software, and to permit persons to whom the Software is furnished to do so,
|
||||
subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
|
||||
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
|
||||
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
|
||||
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
|
||||
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
|
||||
*/
|
||||
|
||||
class PVE2_Exception extends RuntimeException {}
|
||||
|
||||
class PVE2_API {
|
||||
@@ -16,19 +42,19 @@ class PVE2_API {
|
||||
|
||||
public function __construct ($hostname, $username, $realm, $password, $port = 8006, $verify_ssl = false) {
|
||||
if (empty($hostname) || empty($username) || empty($realm) || empty($password) || empty($port)) {
|
||||
throw new PVE2_Exception("Hostname/Username/Realm/Password/Port required for PVE2_API object constructor.", 1);
|
||||
throw new PVE2_Exception("PVE2 API: Hostname/Username/Realm/Password/Port required for PVE2_API object constructor.", 1);
|
||||
}
|
||||
// Check hostname resolves.
|
||||
if (gethostbyname($hostname) == $hostname && !filter_var($hostname, FILTER_VALIDATE_IP)) {
|
||||
throw new PVE2_Exception("Cannot resolve {$hostname}.", 2);
|
||||
throw new PVE2_Exception("PVE2 API: Cannot resolve {$hostname}.", 2);
|
||||
}
|
||||
// Check port is between 1 and 65535.
|
||||
if (!filter_var($port, FILTER_VALIDATE_INT, ['options' => ['min_range' => 1, 'max_range' => 65535]])) {
|
||||
throw new PVE2_Exception("Port must be an integer between 1 and 65535.", 6);
|
||||
throw new PVE2_Exception("PVE2 API: Port must be an integer between 1 and 65535.", 6);
|
||||
}
|
||||
// Check that verify_ssl is boolean.
|
||||
if (!is_bool($verify_ssl)) {
|
||||
throw new PVE2_Exception("verify_ssl must be boolean.", 7);
|
||||
throw new PVE2_Exception("PVE2 API: verify_ssl must be boolean.", 7);
|
||||
}
|
||||
|
||||
$this->hostname = $hostname;
|
||||
@@ -81,7 +107,7 @@ class PVE2_API {
|
||||
// Just to be safe, set this to null again.
|
||||
$this->login_ticket_timestamp = null;
|
||||
if ($login_request_info['ssl_verify_result'] == 1) {
|
||||
throw new PVE2_Exception("Invalid SSL cert on {$this->hostname} - check that the hostname is correct, and that it appears in the server certificate's SAN list. Alternatively set the verify_ssl flag to false if you are using internal self-signed certs (ensure you are aware of the security risks before doing so).", 4);
|
||||
throw new PVE2_Exception("PVE2 API: Invalid SSL cert on {$this->hostname} - check that the hostname is correct, and that it appears in the server certificate's SAN list. Alternatively set the verify_ssl flag to false if you are using internal self-signed certs (ensure you are aware of the security risks before doing so).", 4);
|
||||
}
|
||||
return false;
|
||||
} else {
|
||||
@@ -101,12 +127,21 @@ class PVE2_API {
|
||||
# Use with care, and DO NOT use with root, it may harm your system
|
||||
public function setCookie() {
|
||||
if (!$this->check_login_ticket()) {
|
||||
throw new PVE2_Exception("Not logged into Proxmox host. No Login access ticket found or ticket expired.", 3);
|
||||
throw new PVE2_Exception("PVE2 API: Not logged into Proxmox. No login Access Ticket found or Ticket expired.", 3);
|
||||
}
|
||||
|
||||
setrawcookie("PVEAuthCookie", $this->login_ticket['ticket'], 0, "/");
|
||||
}
|
||||
|
||||
# Gets the PVE Access Ticket
|
||||
public function getTicket() {
|
||||
if ($this->login_ticket['ticket']) {
|
||||
return $this->login_ticket['ticket'];
|
||||
} else {
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
/*
|
||||
* bool check_login_ticket ()
|
||||
* Checks if the login ticket is valid still, returns false if not.
|
||||
@@ -140,7 +175,7 @@ class PVE2_API {
|
||||
}
|
||||
|
||||
if (!$this->check_login_ticket()) {
|
||||
throw new PVE2_Exception("Not logged into Proxmox host. No Login access ticket found or ticket expired.", 3);
|
||||
throw new PVE2_Exception("PVE2 API: Not logged into Proxmox. No login Access Ticket found or Ticket expired.", 3);
|
||||
}
|
||||
|
||||
// Prepare cURL resource.
|
||||
@@ -184,7 +219,7 @@ class PVE2_API {
|
||||
curl_setopt($prox_ch, CURLOPT_HTTPHEADER, $put_post_http_headers);
|
||||
break;
|
||||
default:
|
||||
throw new PVE2_Exception("Error - Invalid HTTP Method specified.", 5);
|
||||
throw new PVE2_Exception("PVE2 API: Error - Invalid HTTP Method specified.", 5);
|
||||
return false;
|
||||
}
|
||||
|
||||
@@ -205,12 +240,12 @@ class PVE2_API {
|
||||
$action_response_array = json_decode($body_response, true);
|
||||
|
||||
$action_response_export = var_export($action_response_array, true);
|
||||
error_log("----------------------------------------------\n" .
|
||||
"FULL RESPONSE:\n\n{$action_response}\n\nEND FULL RESPONSE\n\n" .
|
||||
"Headers:\n\n{$header_response}\n\nEnd Headers\n\n" .
|
||||
"Data:\n\n{$body_response}\n\nEnd Data\n\n" .
|
||||
"RESPONSE ARRAY:\n\n{$action_response_export}\n\nEND RESPONSE ARRAY\n" .
|
||||
"----------------------------------------------");
|
||||
// error_log("----------------------------------------------\n" .
|
||||
// "FULL RESPONSE:\n\n{$action_response}\n\nEND FULL RESPONSE\n\n" .
|
||||
// "Headers:\n\n{$header_response}\n\nEnd Headers\n\n" .
|
||||
// "Data:\n\n{$body_response}\n\nEnd Data\n\n" .
|
||||
// "RESPONSE ARRAY:\n\n{$action_response_export}\n\nEND RESPONSE ARRAY\n" .
|
||||
// "----------------------------------------------");
|
||||
|
||||
unset($action_response);
|
||||
unset($action_response_export);
|
||||
@@ -226,20 +261,21 @@ class PVE2_API {
|
||||
return $action_response_array['data'];
|
||||
}
|
||||
} else {
|
||||
error_log("This API Request Failed.\n" .
|
||||
"HTTP Response - {$split_http_response_line[1]}\n" .
|
||||
"HTTP Error - {$split_headers[0]}");
|
||||
throw new PVE2_Exception("PVE2 API: This API Request Failed.\n" .
|
||||
"HTTP CODE: {$split_http_response_line[1]},\n" .
|
||||
"HTTP ERROR: {$split_headers[0]},\n" .
|
||||
"REPLY INFO: {$body_response}");
|
||||
return false;
|
||||
}
|
||||
} else {
|
||||
error_log("Error - Invalid HTTP Response.\n" . var_export($split_headers, true));
|
||||
throw new PVE2_Exception("PVE2 API: Error - Invalid HTTP Response.\n" . var_export($split_headers, true));
|
||||
return false;
|
||||
}
|
||||
|
||||
if (!empty($action_response_array['data'])) {
|
||||
return $action_response_array['data'];
|
||||
} else {
|
||||
error_log("\$action_response_array['data'] is empty. Returning false.\n" .
|
||||
throw new PVE2_Exception("PVE2 API: \$action_response_array['data'] is empty. Returning false.\n" .
|
||||
var_export($action_response_array['data'], true));
|
||||
return false;
|
||||
}
|
||||
@@ -261,7 +297,7 @@ class PVE2_API {
|
||||
$this->cluster_node_list = $nodes_array;
|
||||
return true;
|
||||
} else {
|
||||
error_log(" Empty list of nodes returned in this cluster.");
|
||||
error_log("PVE2 API: Empty list of Nodes returned in this Cluster.");
|
||||
return false;
|
||||
}
|
||||
}
|
||||
@@ -317,12 +353,12 @@ class PVE2_API {
|
||||
$this->$cluster_vms_list = $result;
|
||||
return $this->$cluster_vms_list;
|
||||
} else {
|
||||
error_log(" Empty list of vms returned in this cluster.");
|
||||
error_log("PVE2 API: Empty list of VMs returned in this Cluster.");
|
||||
return false;
|
||||
}
|
||||
}
|
||||
} else {
|
||||
error_log(" Empty list of nodes returned in this cluster.");
|
||||
error_log("PVE2 API: Empty list of Nodes returned in this Cluster.");
|
||||
return false;
|
||||
}
|
||||
}
|
||||
@@ -340,14 +376,14 @@ class PVE2_API {
|
||||
$url = "/nodes/" . $node . "/qemu/" . $vmid . "/status/start";
|
||||
$post = $this->post($url,$parameters);
|
||||
if ($post) {
|
||||
error_log("Started vm " . $vmid . "");
|
||||
error_log("PVE2 API: Started VM " . $vmid . "");
|
||||
return true;
|
||||
} else {
|
||||
error_log("Error starting vm " . $vmid . "");
|
||||
error_log("PVE2 API: Error starting VM " . $vmid . "");
|
||||
return false;
|
||||
}
|
||||
} else {
|
||||
error_log("no vm or node valid");
|
||||
error_log("PVE2 API: No VM or Node valid");
|
||||
return false;
|
||||
}
|
||||
}
|
||||
@@ -366,14 +402,14 @@ class PVE2_API {
|
||||
$url = "/nodes/" . $node . "/qemu/" . $vmid . "/status/shutdown";
|
||||
$post = $this->post($url,$parameters);
|
||||
if ($post) {
|
||||
error_log("Shutdown vm " . $vmid . "");
|
||||
error_log("PVE2 API: Shutdown VM " . $vmid . "");
|
||||
return true;
|
||||
} else {
|
||||
error_log("Error shutting down vm " . $vmid . "");
|
||||
error_log("PVE2 API: Error shutting down VM " . $vmid . "");
|
||||
return false;
|
||||
}
|
||||
} else {
|
||||
error_log("no vm or node valid");
|
||||
error_log("PVE2 API: No VM or Node valid");
|
||||
return false;
|
||||
}
|
||||
}
|
||||
@@ -392,14 +428,14 @@ class PVE2_API {
|
||||
$url = "/nodes/" . $node . "/qemu/" . $vmid . "/status/stop";
|
||||
$post = $this->post($url,$parameters);
|
||||
if ($post) {
|
||||
error_log("Stopped vm " . $vmid . "");
|
||||
error_log("PVE2 API: Stopped VM " . $vmid . "");
|
||||
return true;
|
||||
} else {
|
||||
error_log("Error stopping vm " . $vmid . "");
|
||||
error_log("PVE2 API: Error stopping VM " . $vmid . "");
|
||||
return false;
|
||||
}
|
||||
} else {
|
||||
error_log("no vm or node valid");
|
||||
error_log("PVE2 API: No VM or Node valid");
|
||||
return false;
|
||||
}
|
||||
}
|
||||
@@ -417,14 +453,14 @@ class PVE2_API {
|
||||
$url = "/nodes/" . $node . "/qemu/" . $vmid . "/status/resume";
|
||||
$post = $this->post($url,$parameters);
|
||||
if ($post) {
|
||||
error_log("Resumed vm " . $vmid . "");
|
||||
error_log("PVE2 API: Resumed VM " . $vmid . "");
|
||||
return true;
|
||||
} else {
|
||||
error_log("Error resuming vm " . $vmid . "");
|
||||
error_log("PVE2 API: Error resuming VM " . $vmid . "");
|
||||
return false;
|
||||
}
|
||||
} else {
|
||||
error_log("no vm or node valid");
|
||||
error_log("PVE2 API: No VM or Node valid");
|
||||
return false;
|
||||
}
|
||||
}
|
||||
@@ -442,14 +478,14 @@ class PVE2_API {
|
||||
$url = "/nodes/" . $node . "/qemu/" . $vmid . "/status/suspend";
|
||||
$post = $this->post($url,$parameters);
|
||||
if ($post) {
|
||||
error_log("Suspended vm " . $vmid . "");
|
||||
error_log("PVE2 API: Suspended VM " . $vmid . "");
|
||||
return true;
|
||||
} else {
|
||||
error_log("Error suspending vm " . $vmid . "");
|
||||
error_log("PVE2 API: Error suspending VM " . $vmid . "");
|
||||
return false;
|
||||
}
|
||||
} else {
|
||||
error_log("no vm or node valid");
|
||||
error_log("PVE2 API: No VM or Node valid");
|
||||
return false;
|
||||
}
|
||||
}
|
||||
@@ -470,14 +506,14 @@ class PVE2_API {
|
||||
$url = "/nodes/" . $node . "/qemu/" . $vmid . "/clone";
|
||||
$post = $this->post($url,$parameters);
|
||||
if ($post) {
|
||||
error_log("Cloned vm " . $vmid . " to " . $lastid . "");
|
||||
error_log("PVE2 API: Cloned VM " . $vmid . " to " . $lastid . "");
|
||||
return true;
|
||||
} else {
|
||||
error_log("Error cloning vm " . $vmid . " to " . $lastid . "");
|
||||
error_log("PVE2 API: Error cloning VM " . $vmid . " to " . $lastid . "");
|
||||
return false;
|
||||
}
|
||||
} else {
|
||||
error_log("no vm or node valid");
|
||||
error_log("PVE2 API: No VM or Node valid");
|
||||
return false;
|
||||
}
|
||||
}
|
||||
@@ -506,14 +542,14 @@ class PVE2_API {
|
||||
$url = "/nodes/" . $node . "/qemu/" . $vmid . "/snapshot";
|
||||
$post = $this->post($url,$parameters);
|
||||
if ($post) {
|
||||
error_log("Cloned vm " . $vmid . " to " . $lastid . "");
|
||||
error_log("PVE2 API: Snapshotted VM " . $vmid . " to " . $lastid . "");
|
||||
return true;
|
||||
} else {
|
||||
error_log("Error cloning vm " . $vmid . " to " . $lastid . "");
|
||||
error_log("PVE2 API: Error snapshotting VM " . $vmid . " to " . $lastid . "");
|
||||
return false;
|
||||
}
|
||||
} else {
|
||||
error_log("no vm or node valid");
|
||||
error_log("PVE2 API: No VM or Node valid");
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -6,35 +6,35 @@
|
||||
<div class="col col-md-3">
|
||||
<div class="row">
|
||||
<div class="col col-md-12">
|
||||
<img src="{$WEB_ROOT}./modules/servers/pvewhmcs/img/{$vm_config['vtype']}.png"/>
|
||||
<img src="/modules/servers/pvewhmcs/img/{$vm_config['vtype']}.png"/>
|
||||
</div>
|
||||
</div>
|
||||
<div class="row">
|
||||
<div class="col col-md-12">
|
||||
<img src="{$WEB_ROOT}./modules/servers/pvewhmcs/img/os/{$vm_config['ostype']}.png"/>
|
||||
<img src="/modules/servers/pvewhmcs/img/os/{$vm_config['ostype']}.png"/>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="col col-md-2">
|
||||
<img src="{$WEB_ROOT}./modules/servers/pvewhmcs/img/{$vm_status['status']}.png"/><br/>
|
||||
{$vm_status['status']}<br/>
|
||||
Uptime: {$vm_status['uptime']}
|
||||
<img src="/modules/servers/pvewhmcs/img/{$vm_status['status']}.png"/><br/>
|
||||
<span style="text-transform: uppercase"><strong><i>{$vm_status['status']}</i></strong></span><br/>
|
||||
Up: {$vm_status['uptime']}
|
||||
|
||||
</div>
|
||||
<div class="col col-md-7">
|
||||
<div class="row">
|
||||
<script src="{$WEB_ROOT}/modules/servers/pvewhmcs/js/CircularLoader.js"></script>
|
||||
<script src="/modules/servers/pvewhmcs/js/CircularLoader.js"></script>
|
||||
<div class="col col-md-3" style="height:106px;">
|
||||
<div id="c1" class="circle" data-percent="{$vm_status['cpu']}">CPU</div>
|
||||
<div id="c1" class="circle" data-percent="{$vm_status['cpu']}"><strong>CPU</strong></div>
|
||||
</div>
|
||||
<div class="col col-md-3">
|
||||
<div id="c2" class="circle" data-percent="{$vm_status['memusepercent']}">RAM</div>
|
||||
<div id="c2" class="circle" data-percent="{$vm_status['memusepercent']}"><strong>RAM</strong></div>
|
||||
</div>
|
||||
<div class="col col-md-3">
|
||||
<div id="c3" class="circle" data-percent="{$vm_status['diskusepercent']}">Disk</div>
|
||||
<div id="c3" class="circle" data-percent="{$vm_status['diskusepercent']}"><strong>Disk</strong></div>
|
||||
</div>
|
||||
<div class="col col-md-3">
|
||||
<div id="c4" class="circle" data-percent="{$vm_status['swapusepercent']}">Swap</div>
|
||||
<div id="c4" class="circle" data-percent="{$vm_status['swapusepercent']}"><strong>Swap</strong></div>
|
||||
</div>
|
||||
</div>
|
||||
<script>
|
||||
@@ -57,37 +57,39 @@
|
||||
|
||||
<table class="table table-bordered table-striped">
|
||||
<tr>
|
||||
<td>Assigned IPv4 Address</td><td>{$vm_config['ipv4']} Subnet Mask: {$vm_config['netmask4']} Gateway: {$vm_config['gateway4']}</td>
|
||||
<td><strong>IP</strong> (Addressing)</td><td><strong>{$vm_config['ipv4']}</strong><br/>Subnet Mask: {$vm_config['netmask4']}<br/>Gateway: {$vm_config['gateway4']}</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>OS (Type)</td>
|
||||
<td>{$vm_config['ostype']}</td>
|
||||
<td><strong>OS/etc</strong> (System)</td>
|
||||
<td>Kernel: {$vm_config['ostype']}</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>CPU (Spec)</td>
|
||||
<td>{$vm_config['sockets']} {$vm_config['cpu']} {$vm_config['cores']} core(s).</td>
|
||||
<td><strong>Compute</strong> (CPU)</td>
|
||||
<td>{$vm_config['sockets']} socket/s, {$vm_config['cores']} core/s<br />
|
||||
Emulation: {$vm_config['cpu']}</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Memory (RAM)</td>
|
||||
<td>{$vm_config['memory']} MB</td>
|
||||
<td><strong>Memory</strong> (RAM)</td>
|
||||
<td>{$vm_config['memory']}MB</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Network Interface #1</td>
|
||||
<td><strong>NIC</strong> (Interface #1)</td>
|
||||
<td>{($vm_config['net0']|replace:',':'<br/>')}</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Network Interface #2</td>
|
||||
<td><strong>NIC</strong> (Interface #2)</td>
|
||||
<td>{$vm_config['net1']}</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Storage (SSD/HDD)</td>
|
||||
<td><strong>Storage</strong> (SSD/HDD)</td>
|
||||
<td>
|
||||
{$rootfs=(","|explode:$vm_config['rootfs'])}
|
||||
{$disk=(","|explode:$vm_config['ide0'])}
|
||||
{$disk[1]}
|
||||
{$rootfs[1]}
|
||||
|
||||
<br/>{$vm_config['scsci0']}</td>
|
||||
{($vm_config['scsi0']|replace:',':'<br/>')}
|
||||
{($vm_config['virtio0']|replace:',':'<br/>')}
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
{if ($smarty.get.a eq 'vmStat')}
|
||||
|
||||
|
Before Width: | Height: | Size: 7.6 KiB After Width: | Height: | Size: 13 KiB |
|
Before Width: | Height: | Size: 1.7 KiB After Width: | Height: | Size: 1.0 KiB |
|
Before Width: | Height: | Size: 15 KiB After Width: | Height: | Size: 14 KiB |
|
Before Width: | Height: | Size: 23 KiB After Width: | Height: | Size: 9.3 KiB |
BIN
modules/servers/pvewhmcs/img/os/l24.png
Normal file
|
After Width: | Height: | Size: 10 KiB |
BIN
modules/servers/pvewhmcs/img/os/l26.png
Normal file
|
After Width: | Height: | Size: 10 KiB |
BIN
modules/servers/pvewhmcs/img/os/other.png
Normal file
|
After Width: | Height: | Size: 29 KiB |
BIN
modules/servers/pvewhmcs/img/os/solaris.png
Normal file
|
After Width: | Height: | Size: 7.3 KiB |
|
Before Width: | Height: | Size: 18 KiB After Width: | Height: | Size: 12 KiB |
|
Before Width: | Height: | Size: 15 KiB After Width: | Height: | Size: 12 KiB |
|
Before Width: | Height: | Size: 20 KiB After Width: | Height: | Size: 13 KiB |
|
Before Width: | Height: | Size: 16 KiB After Width: | Height: | Size: 11 KiB |
BIN
modules/servers/pvewhmcs/img/os/win10.png
Normal file
|
After Width: | Height: | Size: 6.4 KiB |
BIN
modules/servers/pvewhmcs/img/os/win11.png
Normal file
|
After Width: | Height: | Size: 5.3 KiB |
|
Before Width: | Height: | Size: 30 KiB After Width: | Height: | Size: 19 KiB |
BIN
modules/servers/pvewhmcs/img/os/win8.png
Normal file
|
After Width: | Height: | Size: 6.3 KiB |
|
Before Width: | Height: | Size: 18 KiB After Width: | Height: | Size: 12 KiB |
|
Before Width: | Height: | Size: 23 KiB After Width: | Height: | Size: 15 KiB |
BIN
modules/servers/pvewhmcs/img/spice.png
Normal file
|
After Width: | Height: | Size: 2.4 KiB |
|
Before Width: | Height: | Size: 1.6 KiB After Width: | Height: | Size: 3.3 KiB |
50
modules/servers/pvewhmcs/novnc_router.php
Normal file
@@ -0,0 +1,50 @@
|
||||
<?php
|
||||
|
||||
/*
|
||||
Proxmox VE for WHMCS - Addon/Server Modules for WHMCS (& PVE)
|
||||
https://github.com/The-Network-Crew/Proxmox-VE-for-WHMCS/
|
||||
File: /modules/servers/pvewhmcs/novnc_router.php (VNC)
|
||||
|
||||
Copyright (C) The Network Crew Pty Ltd (TNC) & Co.
|
||||
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
if (isset($_GET['pveticket']) && isset($_GET['host']) && isset($_GET['path']) && isset($_GET['vncticket'])) {
|
||||
// Take passed-in variables and re-assign for usage
|
||||
$pveticket = $_GET['pveticket'];
|
||||
$vncticket = $_GET['vncticket'];
|
||||
$host = $_GET['host'];
|
||||
$path = $_GET['path'];
|
||||
|
||||
// Get the requesting hostname/domain from the WHMCS-originated request
|
||||
$whmcsdomain = parse_url($_SERVER['HTTP_HOST']);
|
||||
// Now extract just the domain parts we need (FUTURE: capacity/option for multi-part TLDs)
|
||||
$domainonly = preg_replace("/^(.*?)\.(.*)$/","$2",$whmcsdomain['path']);
|
||||
// Set the cookie as Proxmox will be expecting it, so it is WHMCS to VNC without further login
|
||||
setrawcookie('PVEAuthCookie', $pveticket, 0, '/', $domainonly);
|
||||
|
||||
// Create the final noVNC URL with the re-encoded vncticket
|
||||
$hostname = gethostbyaddr($host);
|
||||
$redirect_url = '/modules/servers/pvewhmcs/novnc/vnc.html?autoconnect=true&encrypt=true&host=' . $hostname . '&port=8006&password=' . urlencode($vncticket) . '&path=' . urlencode($path);
|
||||
|
||||
// Redirect the visitor to noVNC & we're done
|
||||
header('Location: ' . $redirect_url);
|
||||
exit;
|
||||
} else {
|
||||
// Passed in values not present, exit
|
||||
echo 'Error: Missing required info to route your request. Please try again.';
|
||||
exit;
|
||||
}
|
||||
?>
|
||||
@@ -1,3 +1,25 @@
|
||||
|
||||
/*
|
||||
Proxmox VE for WHMCS - Addon/Server Modules for WHMCS (& PVE)
|
||||
https://github.com/The-Network-Crew/Proxmox-VE-for-WHMCS/
|
||||
File: /modules/servers/pvewhmcs/tigervnc.php (VNC)
|
||||
|
||||
Copyright (C) The Network Crew Pty Ltd (TNC) & Co.
|
||||
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see https://www.gnu.org/licenses
|
||||
*/
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<title>Serial Console</title>
|
||||
|
||||