Skip to main content

Automation helper for Fluxnodes

Project description

Arcane Mage - Automated Fluxnode ArcaneOS Installation

Introduction

Arcane Mage is a suite of tools designed to ease the installation (and configuration) burden of installing a Fluxnode.

The following is available via the GUI, or CLI:

  • Fully automated A to Z Proxmox installs, including Secure Boot key enrollment.
  • Mutlicast config broadcast on LANs - fully automated installs, except Secure Boot Key enrollement.
  • USB stick creation for plug and play automated installs on bare metal

Configuration Options

See the examples directory for sample configurations.

Any option can be easily set via a yaml configuration file, for example, for Proxmox, start on VM creation, rate limits, etc.

It can also reboot direct into systemd-boot for systems that allow easy enrollment of keys (usually bare metal systems)

Installation

Install uv - https://docs.astral.sh/uv/getting-started/installation/

To run once without installing:

uvx --with arcane_mage python -m arcane_mage

Install as a tool:

uv tool install arcane-mage

To use the default config file fluxnodes.yaml in the directory you are in (this will run the GUI):

arcane-mage

Run the following for help:

arcane-mage --help

Hypervisor Setup - Proxmox Automation

In order to use Arcane Mage with Proxmox, the following needs to be set up on your hypervisor:

  • A user for the API
  • An API token (strongly recommended)
  • Nginx reverse proxy (strongly recommended)

To set up your Proxmox Instance behind an Nginx reverse proxy, follow these instructions, it doesn't take much effort:

https://pve.proxmox.com/wiki/Web_Interface_Via_Nginx_Proxy

If you don't reverse proxy the api, you can run into connection issues.

To set up your user, go to "Datacenter" on the Proxmox GUI and add a user:

Proxmox User Page

Next, add an api token for your user:

Proxmox Api Token

Finally, give BOTH your user and api token PVEAdmin permissions:

Proxmox Permissions

You're now good to run Arcane Mage.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

arcane_mage-0.1.6.tar.gz (379.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

arcane_mage-0.1.6-py3-none-any.whl (47.1 kB view details)

Uploaded Python 3

File details

Details for the file arcane_mage-0.1.6.tar.gz.

File metadata

  • Download URL: arcane_mage-0.1.6.tar.gz
  • Upload date:
  • Size: 379.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.6.3

File hashes

Hashes for arcane_mage-0.1.6.tar.gz
Algorithm Hash digest
SHA256 5ed7a36b0cf67be32ff109e38ccacbd32b46d34570c74f9bd325376377b2653b
MD5 20dc311df0bea04c17687fbad51cd3ad
BLAKE2b-256 45775561caaa094c2e5d85329f66e748a2a947fafc26c4dfffe80511fdad991d

See more details on using hashes here.

File details

Details for the file arcane_mage-0.1.6-py3-none-any.whl.

File metadata

File hashes

Hashes for arcane_mage-0.1.6-py3-none-any.whl
Algorithm Hash digest
SHA256 8386fa1bde7c6ea4f7d865dc1c7f77433bf7be4dd479dde4830399fe42d58b91
MD5 97f18ef9c6c2fd08bfcc46a0d074457b
BLAKE2b-256 1216778c7d3272c3e2b69a94abddf941a39471360cc80b8aa8e8a27b97043f33

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page