2025-03-07 18:12:27 +01:00

209 lines
8.8 KiB
TypeScript
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

import type { Metadata } from "next";
import { HelpCircle } from "lucide-react";
import Link from "next/link";
export const metadata: Metadata = {
title: "ProxMenux FAQ Frequently Asked Questions",
description: "Frequently Asked Questions about ProxMenux, including installation, updates, compatibility, and security.",
openGraph: {
title: "ProxMenux FAQ Frequently Asked Questions",
description: "Frequently Asked Questions about ProxMenux, including installation, updates, compatibility, and security.",
type: "article",
url: "https://macrimi.github.io/ProxMenux/docs/faq",
images: [
{
url: "https://macrimi.github.io/ProxMenux/faq-image.png",
width: 1200,
height: 630,
alt: "ProxMenux FAQ",
},
],
},
twitter: {
card: "summary_large_image",
title: "ProxMenux FAQ Frequently Asked Questions",
description: "Frequently Asked Questions about ProxMenux, including installation, updates, compatibility, and security.",
images: ["https://macrimi.github.io/ProxMenux/faq-image.png"],
},
};
function StepNumber({ number }: { number: number }) {
return (
<div className="inline-flex items-center justify-center w-8 h-8 mr-3 text-white bg-blue-500 rounded-full">
<span className="text-sm font-bold">{number}</span>
</div>
);
}
export default function FaqPage() {
return (
<div className="container mx-auto px-4 py-8">
<div className="flex items-center mb-6">
<HelpCircle className="h-8 w-8 mr-2 text-blue-500" />
<h1 className="text-3xl font-bold">Frequently Asked Questions (FAQ)</h1>
</div>
{/* 1⃣ What is ProxMenux? */}
<h3 className="text-xl font-semibold mt-16 mb-4 flex items-center">
<StepNumber number={1} />
What is ProxMenux, and what is it used for?
</h3>
<p className="mb-4">
<strong>ProxMenux</strong> is an interactive menu-driven tool designed to make <strong>Proxmox VE</strong> more accessible
to all users, regardless of their technical experience. It simplifies command execution, allowing users to perform
actions on their system without requiring advanced Linux knowledge.
</p>
<p className="mb-4">
For less experienced users, <strong>ProxMenux</strong> provides an intuitive way to run commands through a structured
menu interface, reducing the need for manual terminal input.
</p>
<p className="mb-4">
Proxmox VE is widely used for:
</p>
<ul className="list-disc list-inside mb-4 ml-4">
<li>Enterprise-grade virtualization</li>
<li>HomeLab and personal cloud solutions</li>
<li>Multimedia servers, automation, and more</li>
</ul>
{/* 2⃣ Installation */}
<h3 className="text-xl font-semibold mt-16 mb-4 flex items-center">
<StepNumber number={2} />
How do I install ProxMenux?
</h3>
<p className="mb-4">
Follow the instructions in the{" "}
<Link href="https://macrimi.github.io/ProxMenux/docs/installation" className="text-blue-500 hover:underline">
Installation Guide
</Link>. You can install ProxMenux by running:
</p>
<pre className="bg-gray-100 p-4 rounded-md overflow-x-auto text-sm">
<code>
bash -c "$(wget -qLO - https://raw.githubusercontent.com/MacRimi/ProxMenux/main/install_proxmenux.sh)"
</code>
</pre>
<p className="mt-4">Once installed, simply start it with:</p>
<pre className="bg-gray-100 p-4 rounded-md overflow-x-auto text-sm">
<code>menu</code>
</pre>
{/* 3⃣ Compatibility */}
<h3 className="text-xl font-semibold mt-16 mb-4 flex items-center">
<StepNumber number={3} />
Is ProxMenux compatible with all Proxmox versions?
</h3>
<p className="mb-4">
No, <strong>ProxMenux is only compatible with Proxmox VE 8 and later versions.</strong>
</p>
{/* 4⃣ Customization */}
<h3 className="text-xl font-semibold mt-16 mb-4 flex items-center">
<StepNumber number={4} />
Can I customize ProxMenux?
</h3>
<p className="mb-4">
The core scripts cannot be modified directly as they are hosted on GitHub. However, users can
personalize the <strong>console logo</strong> using the <strong>FastFetch</strong> tool available in the
<strong>Post-Install options</strong>.
</p>
{/* 5⃣ Updates */}
<h3 className="text-xl font-semibold mt-16 mb-4 flex items-center">
<StepNumber number={5} />
How do I update ProxMenux?
</h3>
<p className="mb-4">
When a new version is available, ProxMenux will automatically detect it upon launch and prompt
users to update. If accepted, the update process will replace utility files and configurations.
</p>
{/* 6⃣ Reporting Issues */}
<h3 className="text-xl font-semibold mt-16 mb-4 flex items-center">
<StepNumber number={6} />
Where can I report issues?
</h3>
<p className="mb-4">
If you encounter bugs or errors, report them in the{" "}
<Link href="https://github.com/MacRimi/ProxMenux/issues" className="text-blue-500 hover:underline">
Issues section
</Link>.
</p>
<p className="mb-4">
If you find a <strong>security issue</strong>, please <strong>do not publish it</strong>.
Instead, review the{" "}
<Link href="https://github.com/MacRimi/ProxMenux/blob/main/CODE_OF_CONDUCT.md" className="text-blue-500 hover:underline">
Code of Conduct & Best Practices
</Link>{" "}
for guidance on how to proceed.
</p>
{/* 7⃣ Contributing */}
<h3 className="text-xl font-semibold mt-16 mb-4 flex items-center">
<StepNumber number={7} />
Can I contribute to ProxMenux?
</h3>
<p className="mb-4">
<strong>Absolutely!</strong>
</p>
<p className="mb-4">
ProxMenux is an open-source and collaborative project where you can contribute by developing
new features, opening discussions, or sharing ideas and improvements.
</p>
<p className="mb-4">
Join the{" "}
<Link href="https://github.com/MacRimi/ProxMenux/discussions" className="text-blue-500 hover:underline">
Discussions section
</Link>{" "}
to share ideas and propose enhancements.
</p>
<p className="mb-4">
Make sure to review the{" "}
<Link href="https://github.com/MacRimi/ProxMenux/blob/main/CODE_OF_CONDUCT.md" className="text-blue-500 hover:underline">
Code of Conduct & Best Practices
</Link>.
</p>
<p className="mb-4">
<strong>All ideas are welcome!</strong>
</p>
{/* 8⃣ Modifying System Files */}
<h3 className="text-xl font-semibold mt-16 mb-4 flex items-center">
<StepNumber number={8} />
Does ProxMenux modify critical system files?
</h3>
<p className="mb-4">
No, <strong>ProxMenux does not modify critical Proxmox system files.</strong>
It only installs dependencies such as <code className="bg-gray-200 px-1 rounded">whiptail</code>, <code className="bg-gray-200 px-1 rounded">curl</code>,
<code className="bg-gray-200 px-1 rounded">jq</code>, and <code className="bg-gray-200 px-1 rounded">Python3</code>, sets up a virtual environment for translations,
and downloads its scripts into <code className="bg-gray-200 px-1 rounded">/usr/local/share/proxmenux/</code>.
The executable <code className="bg-gray-200 px-1 rounded">menu</code> is placed in <code className="bg-gray-200 px-1 rounded">/usr/local/bin/</code>.
ProxMenux does not interfere with Proxmoxs core operations.
</p>
{/* 9⃣ Production Use */}
<h3 className="text-xl font-semibold mt-16 mb-4 flex items-center">
<StepNumber number={9} />
Is it safe to use ProxMenux in production?
</h3>
<p className="mb-4">
Yes, <strong>ProxMenux is safe for production</strong>.
Since it does not modify core Proxmox files, it can be used in production environments.
However, it is always recommended to test it in a controlled environment first.
</p>
{/* 🔟 Uninstallation */}
<h3 className="text-xl font-semibold mt-16 mb-4 flex items-center">
<StepNumber number={10} />
How do I uninstall ProxMenux?
</h3>
<p className="mb-4">
You can uninstall ProxMenux from the <strong>Settings menu</strong> using the <strong>Uninstall ProxMenux</strong> option.
Detailed steps can be found in the{" "}
<Link href="https://macrimi.github.io/ProxMenux/docs/settings/uninstall-proxmenux" className="text-blue-500 hover:underline">
Uninstall Guide
</Link>.
</p>
</div>
);
}