This page still requires rewriting. This is not the final version
What are Script Recipes?#
Script Recipes are predefined scripts that automate complex tasks on your servers. They are used to streamline processes such as installing software, configuring settings, and performing routine maintenance. By using Script Recipes, you can ensure that all your servers are configured uniformly and according to best practices.Creating Script Recipes#
To create a Script Recipe in Hexallion, follow these steps:1.
Access the Script Recipes Section: Log in to the Hexallion admin panel and navigate to the "Settings" menu. Select "Recipes" to access the Script Recipes section.
2.
Add New Recipe: Click on "Add New Recipe" to create a new script. Provide a descriptive name and version for the recipe.
3.
Write the Script: In the script editor, write the commands and scripts necessary to perform the desired task. For example, you might write a script to install OpenVPN on a server or update firewall rules.
4.
Save the Recipe: Once you have written and reviewed your script, click "Save" to add the recipe to your list of available scripts.
Caption: Create new Script Recipes by writing and saving scripts to automate server management tasks.Using Script Recipes#
Once you have created a Script Recipe, you can apply it to your servers:1.
Select Server: Navigate to the "Servers" section and select the server you want to manage.
2.
Install Recipe: In the server details page, go to the "Install Recipe" tab. Choose the desired recipe from the list and click "Install."
3.
Monitor Execution: The Hexallion agent will execute the script on the selected server. You can monitor the progress and status of the execution in real-time.
What are Macroses?#
Macroses (or Dynamic Values) are placeholders used within Script Recipes to insert dynamic values. These values are automatically replaced with actual data during script execution, allowing for flexible and reusable scripts. Examples of dynamic values include {{SERVER_IP}}, {{SERVER_PORT}}, and {{USER_NAME}}.Using Macroses in Scripts#
To use Macroses in your Script Recipes, simply include the placeholders within your script. During execution, Hexallion will replace these placeholders with the appropriate values. Here are some common Macroses and their uses:{{SERVER_IP}}: The IP address of the server where the script is being executed.
{{SERVER_PORT}}: The port number assigned to the server.
{{USER_NAME}}: The username for accessing the server.
{{VPN_PROTOCOL}}: The VPN protocol being configured, such as OpenVPN or WireGuard.
#!/bin/bash
# Install OpenVPN
apt-get update
apt-get install -y openvpn
# Configure OpenVPN
echo "Configuring OpenVPN for server {{SERVER_IP}} on port {{SERVER_PORT}}"
cat <<EOF > /etc/openvpn/server.conf
port {{SERVER_PORT}}
proto udp
dev tun
server {{VPN_SUBNET}} {{VPN_NETMASK}}
push "route {{SERVER_IP}} 255.255.255.0"
EOF
# Start OpenVPN service
systemctl start openvpn@server
systemctl enable openvpn@server
Benefits of Using Script Recipes and Macroses#
Consistency: Ensure all your servers are configured uniformly by using standardized scripts.
Efficiency: Automate repetitive tasks, reducing manual effort and the potential for errors.
Scalability: Easily apply configurations across multiple servers, allowing your infrastructure to scale seamlessly.
Flexibility: Use Macroses to create dynamic and reusable scripts that adapt to different server environments.Best Practices#
Test Scripts: Always test your scripts on a staging server before deploying them to production environments.
Version Control: Use versioning for your recipes to keep track of changes and ensure compatibility.
Documentation: Document your recipes and macroses clearly, making it easier for other administrators to understand and use them.
Caption: Apply Script Recipes to servers to automate configuration and management tasks.Summary#
Script Recipes and Macroses (Dynamic Values) in Hexallion provide a powerful way to automate and streamline server management. By creating and using these tools, you can ensure consistent, efficient, and flexible management of your VPN infrastructure. Embrace the automation capabilities of Hexallion to optimize your operations and focus on delivering exceptional VPN services to your users.Stay tuned for more updates as we continue to enhance the Hexallion platform with even more automation and management tools.[Image Placeholder: Diagram showing the workflow of creating and applying Script Recipes with Macroses]
Caption: The workflow involves creating Script Recipes, using Macroses for dynamic values, and applying them to servers for automated management.