diff --git a/web/app/docs/post-install/customization/page.tsx b/web/app/docs/post-install/customization/page.tsx
index ec5e31c..a00ec6e 100644
--- a/web/app/docs/post-install/customization/page.tsx
+++ b/web/app/docs/post-install/customization/page.tsx
@@ -1,21 +1,156 @@
import type { Metadata } from "next"
-import { Sliders } from "lucide-react"
+import { Paintbrush } from "lucide-react"
+import CopyableCode from "@/components/CopyableCode"
export const metadata: Metadata = {
title: "ProxMenux Post-Install: Customization Settings",
description:
- "Detailed guide to Customization Settings in the ProxMenux post-install script for personalizing your Proxmox VE environment.",
- // ... (rest of the metadata remains the same)
+ "Guide to Customization Settings in the ProxMenux post-install script for personalizing your Proxmox VE environment.",
+ openGraph: {
+ title: "ProxMenux Post-Install: Customization Settings",
+ description:
+ "Guide to Customization Settings in the ProxMenux post-install script for personalizing your Proxmox VE environment.",
+ type: "article",
+ url: "https://macrimi.github.io/ProxMenux/docs/post-install/customization",
+ images: [
+ {
+ url: "https://macrimi.github.io/ProxMenux/customization-settings-image.png",
+ width: 1200,
+ height: 630,
+ alt: "ProxMenux Post-Install Customization Settings",
+ },
+ ],
+ },
+ twitter: {
+ card: "summary_large_image",
+ title: "ProxMenux Post-Install: Customization Settings",
+ description:
+ "Guide to Customization Settings in the ProxMenux post-install script for personalizing your Proxmox VE environment.",
+ images: ["https://macrimi.github.io/ProxMenux/customization-settings-image.png"],
+ },
+}
+
+function StepNumber({ number }: { number: number }) {
+ return (
+
+ {number}
+
+ )
}
export default function CustomizationSettingsPage() {
return (
-
+
Customization Settings
- {/* ... (rest of the component remains the same) */}
+
+ The Customization Settings category allows you to personalize various aspects of your Proxmox
+ VE installation. These settings are optional and can be adjusted according to your preferences.
+
+
Available Customizations
+
+
+
+ Customize bashrc
+
+
+ This customization modifies the .bashrc file for the root user, adding various aliases and configurations.
+
+
The following changes are made:
+
+ - Sets HISTTIMEFORMAT to include date and time in command history
+ - Configures a custom colorful prompt
+ - Adds aliases for common ls commands (l, la, ll)
+ - Enables color output for ls, grep, fgrep, and egrep commands
+ - Sources bash completion script
+
+
This adjustment automates the following commands:
+
> /root/.bashrc
+echo 'export PS1="\[\e[31m\][\[\e[m\]\[\e[38;5;172m\]\u\[\e[m\]@\[\e[38;5;153m\]\h\[\e[m\] \[\e[38;5;214m\]\W\[\e[m\]\[\e[31m\]]\[\e[m\]\\$ "' >> /root/.bashrc
+echo "alias l='ls -CF'" >> /root/.bashrc
+echo "alias la='ls -A'" >> /root/.bashrc
+echo "alias ll='ls -alF'" >> /root/.bashrc
+echo "alias ls='ls --color=auto'" >> /root/.bashrc
+echo "alias grep='grep --color=auto'" >> /root/.bashrc
+echo "alias fgrep='fgrep --color=auto'" >> /root/.bashrc
+echo "alias egrep='egrep --color=auto'" >> /root/.bashrc
+echo "source /etc/profile.d/bash_completion.sh" >> /root/.bashrc
+
+# Ensure .bashrc is sourced in .bash_profile
+echo "source /root/.bashrc" >> /root/.bash_profile
+ `}
+ />
+
+
+
+ Remove Subscription Banner
+
+
+ This customization removes the Proxmox VE subscription banner and nag messages from the web interface.
+
+ The following changes are made:
+
+ - Creates a daily cron job to remove the subscription banner
+ - Adds an APT hook to remove the nag message after package updates
+ - Applies the changes immediately by reinstalling the proxmox-widget-toolkit
+
+ This adjustment automates the following commands:
+ /etc/cron.daily/xs-pve-nosub
+#!/bin/sh
+sed -i "s/data.status !== 'Active'/false/g" /usr/share/javascript/proxmox-widget-toolkit/proxmoxlib.js
+sed -i "s/checked_command: function(orig_cmd) {/checked_command: function() {} || function(orig_cmd) {/g" /usr/share/javascript/proxmox-widget-toolkit/proxmoxlib.js
+EOF
+chmod 755 /etc/cron.daily/xs-pve-nosub
+
+# Create APT hook for nag removal
+echo "DPkg::Post-Invoke { \"dpkg -V proxmox-widget-toolkit | grep -q '/proxmoxlib\.js$'; if [ \$? -eq 1 ]; then { echo 'Removing subscription nag from UI...'; sed -i '/data.status/{s/\!//;s/Active/NoMoreNagging/}' /usr/share/javascript/proxmox-widget-toolkit/proxmoxlib.js; }; fi\"; };" > /etc/apt/apt.conf.d/xs-pve-no-nag
+
+# Apply changes immediately
+apt --reinstall install proxmox-widget-toolkit
+ `}
+ />
+
+
+
+ Set up Custom MOTD Banner
+
+
+ This customization adds a custom message to the MOTD (Message of the Day) that appears when logging into the
+ system via SSH.
+
+ The following changes are made:
+
+ - Adds a custom message at the beginning of the MOTD file
+ - Creates a backup of the original MOTD file
+ - Removes any empty lines from the MOTD file
+
+ This adjustment automates the following commands:
+ /etc/motd
+sed -i '/^$/N;/^\n$/D' /etc/motd
+ `}
+ />
+
+
+ Automatic Application
+
+ All of these customizations are automatically applied when selected in the Customization section. This
+ automation ensures that these personalized settings are applied consistently and correctly, saving time and
+ reducing the potential for manual configuration errors.
+
+
)
}
diff --git a/web/app/docs/post-install/monitoring/page.tsx b/web/app/docs/post-install/monitoring/page.tsx
index 201aff2..108e29b 100644
--- a/web/app/docs/post-install/monitoring/page.tsx
+++ b/web/app/docs/post-install/monitoring/page.tsx
@@ -1,14 +1,15 @@
import type { Metadata } from "next"
import { LineChart } from "lucide-react"
+import CopyableCode from "@/components/CopyableCode"
export const metadata: Metadata = {
title: "ProxMenux Post-Install: Monitoring Settings",
description:
- "Comprehensive guide to Monitoring Settings in the ProxMenux post-install script for optimizing Proxmox VE system monitoring and alerting.",
+ "Guide to Monitoring Settings in the ProxMenux post-install script for enhancing your Proxmox VE monitoring capabilities.",
openGraph: {
title: "ProxMenux Post-Install: Monitoring Settings",
description:
- "Comprehensive guide to Monitoring Settings in the ProxMenux post-install script for optimizing Proxmox VE system monitoring and alerting.",
+ "Guide to Monitoring Settings in the ProxMenux post-install script for enhancing your Proxmox VE monitoring capabilities.",
type: "article",
url: "https://macrimi.github.io/ProxMenux/docs/post-install/monitoring",
images: [
@@ -24,11 +25,19 @@ export const metadata: Metadata = {
card: "summary_large_image",
title: "ProxMenux Post-Install: Monitoring Settings",
description:
- "Comprehensive guide to Monitoring Settings in the ProxMenux post-install script for optimizing Proxmox VE system monitoring and alerting.",
+ "Guide to Monitoring Settings in the ProxMenux post-install script for enhancing your Proxmox VE monitoring capabilities.",
images: ["https://macrimi.github.io/ProxMenux/monitoring-settings-image.png"],
},
}
+function StepNumber({ number }: { number: number }) {
+ return (
+
+ {number}
+
+ )
+}
+
export default function MonitoringSettingsPage() {
return (
@@ -37,27 +46,52 @@ export default function MonitoringSettingsPage() {
Monitoring Settings
- The Monitoring Settings category in the customizable_post_install.sh script focuses on setting up and optimizing
- system monitoring and alerting for your Proxmox VE installation.
+ The Monitoring Settings category focuses on enhancing the monitoring capabilities of your
+ Proxmox VE installation. These settings are designed to provide better insights into your system's performance
+ and health.
- Available Optimizations
-
- -
- System Metrics: Configure collection and storage of key system metrics.
-
- -
- Alert Configuration: Set up alerts for critical system events and thresholds.
-
- -
- Logging Optimization: Fine-tune system logging for better troubleshooting and analysis.
-
- {/* Add more list items for each optimization in this category */}
-
- Usage
+ Available Optimizations
+
+
+
+ Install OVH Real Time Monitoring (RTM)
+
- When running the customizable_post_install.sh script, you'll be prompted to choose which Monitoring Settings to
- apply. Select the options that best suit your monitoring needs and system requirements.
+ This optimization detects if the server is hosted by OVH and installs the OVH Real Time Monitoring (RTM) tool if
+ applicable.
+ The following steps are performed:
+
+ - Detects the server's public IP address
+ - Checks if the IP belongs to OVH using WHOIS information
+ - If it's an OVH server, installs the OVH RTM tool
+
+
+ Note: This optimization is only applicable to servers hosted by OVH. If your server is not
+ hosted by OVH, this step will be skipped.
+
+ This adjustment automates the following commands:
+
+
+
+ Automatic Application
+
+ This monitoring optimization is automatically applied when selected in the Monitoring section. The automation
+ ensures that the OVH RTM tool is installed correctly if your server is hosted by OVH, enhancing your server's
+ monitoring capabilities without manual intervention.
+
+
)
}
diff --git a/web/app/docs/post-install/optional/page.tsx b/web/app/docs/post-install/optional/page.tsx
index b87396a..302ce16 100644
--- a/web/app/docs/post-install/optional/page.tsx
+++ b/web/app/docs/post-install/optional/page.tsx
@@ -1,14 +1,15 @@
import type { Metadata } from "next"
import { Plus } from "lucide-react"
+import CopyableCode from "@/components/CopyableCode"
export const metadata: Metadata = {
title: "ProxMenux Post-Install: Optional Settings",
description:
- "Guide to Optional Settings in the ProxMenux post-install script for additional Proxmox VE customizations and features.",
+ "Guide to Optional Settings in the ProxMenux post-install script for additional Proxmox VE features and optimizations.",
openGraph: {
title: "ProxMenux Post-Install: Optional Settings",
description:
- "Guide to Optional Settings in the ProxMenux post-install script for additional Proxmox VE customizations and features.",
+ "Guide to Optional Settings in the ProxMenux post-install script for additional Proxmox VE features and optimizations.",
type: "article",
url: "https://macrimi.github.io/ProxMenux/docs/post-install/optional",
images: [
@@ -24,11 +25,19 @@ export const metadata: Metadata = {
card: "summary_large_image",
title: "ProxMenux Post-Install: Optional Settings",
description:
- "Guide to Optional Settings in the ProxMenux post-install script for additional Proxmox VE customizations and features.",
+ "Guide to Optional Settings in the ProxMenux post-install script for additional Proxmox VE features and optimizations.",
images: ["https://macrimi.github.io/ProxMenux/optional-settings-image.png"],
},
}
+function StepNumber({ number }: { number: number }) {
+ return (
+
+ {number}
+
+ )
+}
+
export default function OptionalSettingsPage() {
return (
@@ -37,27 +46,150 @@ export default function OptionalSettingsPage() {
Optional Settings
- The Optional Settings category in the customizable_post_install.sh script provides additional customizations and
- features that you may choose to implement in your Proxmox VE environment.
+ The Optional Settings category provides additional features and optimizations that you can
+ choose to apply to your Proxmox VE installation. These settings are not essential but can enhance your system's
+ capabilities in specific scenarios.
- Available Options
-
- -
- Additional Software: Install optional software packages or tools.
-
- -
- Custom Scripts: Add your own scripts to run post-installation.
-
- -
- Extended Configurations: Apply additional, non-essential configurations.
-
- {/* Add more list items for each option in this category */}
-
- Usage
+ Available Optional Features
+
+
+
+ Add Latest Ceph Support
+
- When running the customizable_post_install.sh script, you'll be presented with these Optional Settings. You can
- choose to apply any or all of these settings based on your specific needs and preferences.
+ This option installs the latest Ceph storage system support for Proxmox VE. Ceph is a distributed storage system
+ that provides high performance, reliability, and scalability.
+ What it does:
+
+ - Adds the Ceph repository to your system
+ - Updates package lists
+ - Installs Ceph packages using the 'pveceph install' command
+ - Verifies the installation
+
+
+ How to use: After installation, you can configure and manage Ceph storage using the Proxmox VE web interface or
+ command-line tools.
+
+ This adjustment automates the following commands:
+ /etc/apt/sources.list.d/ceph-squid.list
+
+# Update package lists
+apt-get update
+
+# Install Ceph
+pveceph install
+
+# Verify installation
+pveceph status
+ `}
+ />
+
+
+
+ Apply AMD CPU Fixes
+
+
+ This option applies specific fixes for AMD EPYC and Ryzen CPUs to improve stability and compatibility.
+
+ What it does:
+
+ - Detects if an AMD EPYC or Ryzen CPU is present
+ - Applies kernel parameter 'idle=nomwait' to prevent random crashes
+ - Configures KVM to ignore certain MSRs (Model Specific Registers) for better Windows guest compatibility
+ - Installs the latest Proxmox VE kernel
+
+
+ How to use: These fixes are applied automatically and require a system reboot to take effect.
+
+ This adjustment automates the following commands:
+ > /etc/modprobe.d/kvm.conf
+echo "options kvm report_ignored_msrs=N" >> /etc/modprobe.d/kvm.conf
+
+# Install latest Proxmox VE kernel
+apt-get install pve-kernel-$(uname -r | cut -d'-' -f1-2)
+ `}
+ />
+
+
+
+ Enable High Availability Services
+
+
+ This option enables High Availability (HA) services in Proxmox VE, allowing for automatic failover of VMs and
+ containers in case of node failure.
+
+ What it does:
+
+ - Enables and starts the pve-ha-lrm (Local Resource Manager) service
+ - Enables and starts the pve-ha-crm (Cluster Resource Manager) service
+ - Enables and starts the corosync service for cluster communication
+
+
+ How to use: After enabling these services, you can configure HA groups and resources in the Proxmox VE web
+ interface.
+
+ This adjustment automates the following commands:
+
+
+
+
+ Install and Configure Fastfetch
+
+
+ This option installs and configures Fastfetch, a system information tool that displays system specs and a custom
+ logo at login.
+
+ What it does:
+
+ - Downloads and installs Fastfetch
+ -
+ Allows you to choose a custom logo (ProxMenux, Proxmox, Helper-Scripts, Home-Labs-Club, Proxmology, or a
+ custom one)
+
+ - Configures Fastfetch to display "System optimised by ProxMenux"
+ - Sets up Fastfetch to run automatically at console login
+
+
+ How to use: After installation, Fastfetch will run automatically when you log into the console, displaying
+ system information and your chosen logo.
+
+ This adjustment automates the following commands:
+ > ~/.bashrc
+ `}
+ />
+
+
+ Automatic Application
+
+ These optional features are applied only when specifically selected during the post-install process. Each
+ feature can be individually chosen based on your specific needs and preferences.
+
+
)
}
diff --git a/web/app/docs/post-install/performance/page.tsx b/web/app/docs/post-install/performance/page.tsx
index 03f4221..7a6b6b8 100644
--- a/web/app/docs/post-install/performance/page.tsx
+++ b/web/app/docs/post-install/performance/page.tsx
@@ -1,14 +1,15 @@
import type { Metadata } from "next"
import { Zap } from "lucide-react"
+import CopyableCode from "@/components/CopyableCode"
export const metadata: Metadata = {
title: "ProxMenux Post-Install: Performance Settings",
description:
- "Detailed guide to Performance Settings in the ProxMenux post-install script for optimizing Proxmox VE system performance.",
+ "Guide to Performance Settings in the ProxMenux post-install script for optimizing your Proxmox VE system performance.",
openGraph: {
title: "ProxMenux Post-Install: Performance Settings",
description:
- "Detailed guide to Performance Settings in the ProxMenux post-install script for optimizing Proxmox VE system performance.",
+ "Guide to Performance Settings in the ProxMenux post-install script for optimizing your Proxmox VE system performance.",
type: "article",
url: "https://macrimi.github.io/ProxMenux/docs/post-install/performance",
images: [
@@ -24,11 +25,19 @@ export const metadata: Metadata = {
card: "summary_large_image",
title: "ProxMenux Post-Install: Performance Settings",
description:
- "Detailed guide to Performance Settings in the ProxMenux post-install script for optimizing Proxmox VE system performance.",
+ "Guide to Performance Settings in the ProxMenux post-install script for optimizing your Proxmox VE system performance.",
images: ["https://macrimi.github.io/ProxMenux/performance-settings-image.png"],
},
}
+function StepNumber({ number }: { number: number }) {
+ return (
+
+ {number}
+
+ )
+}
+
export default function PerformanceSettingsPage() {
return (
@@ -37,27 +46,64 @@ export default function PerformanceSettingsPage() {
Performance Settings
- The Performance Settings category in the customizable_post_install.sh script is dedicated to optimizing the
- overall performance of your Proxmox VE system.
+ The Performance Settings category focuses on optimizing various aspects of your Proxmox VE
+ system to enhance overall performance. These settings are designed to improve system efficiency and speed up
+ certain operations.
- Available Optimizations
-
- -
- CPU Tuning: Optimize CPU governor and other CPU-related settings.
-
- -
- Memory Management: Fine-tune memory allocation and swapping behavior.
-
- -
- I/O Optimization: Adjust I/O scheduler and other disk-related performance settings.
-
- {/* Add more list items for each optimization in this category */}
-
- Usage
+ Available Optimizations
+
+
+
+ Configure pigz for Faster gzip Compression
+
- During the execution of customizable_post_install.sh, you'll have the option to apply various Performance
- Settings. Choose the optimizations that best match your hardware configuration and workload requirements.
+ This optimization configures pigz as a faster replacement for gzip compression. pigz is a parallel
+ implementation of gzip for modern multi-processor, multi-core machines.
+ The following steps are performed:
+
+ - Enables pigz in the vzdump configuration for faster backups
+ - Installs the pigz package if not already installed
+ - Creates a pigz wrapper script to replace the standard gzip command
+ - Replaces the system gzip command with the pigz wrapper
+
+
+ Note: This optimization can significantly speed up compression tasks, especially on systems
+ with multiple CPU cores.
+
+ This adjustment automates the following commands:
+ /bin/pigzwrapper
+#!/bin/sh
+PATH=/bin:\$PATH
+GZIP="-1"
+exec /usr/bin/pigz "\$@"
+EOF
+chmod +x /bin/pigzwrapper
+
+# Replace gzip with pigz wrapper
+mv -f /bin/gzip /bin/gzip.original
+cp -f /bin/pigzwrapper /bin/gzip
+chmod +x /bin/gzip
+ `}
+ />
+
+
+ Automatic Application
+
+ This performance optimization is automatically applied when selected in the Performance section. The
+ automation ensures that pigz is correctly configured and integrated into your system, potentially improving
+ the speed of compression operations without requiring manual intervention.
+
+
)
}