diff --git a/images/interface/docker-based-rock-ons/Spoolman_homepage.png b/images/interface/docker-based-rock-ons/Spoolman_homepage.png new file mode 100755 index 0000000..e349728 Binary files /dev/null and b/images/interface/docker-based-rock-ons/Spoolman_homepage.png differ diff --git a/images/interface/docker-based-rock-ons/Spoolman_inprogress.png b/images/interface/docker-based-rock-ons/Spoolman_inprogress.png new file mode 100755 index 0000000..dc1d639 Binary files /dev/null and b/images/interface/docker-based-rock-ons/Spoolman_inprogress.png differ diff --git a/images/interface/docker-based-rock-ons/Spoolman_installing.png b/images/interface/docker-based-rock-ons/Spoolman_installing.png new file mode 100755 index 0000000..4255b27 Binary files /dev/null and b/images/interface/docker-based-rock-ons/Spoolman_installing.png differ diff --git a/images/interface/docker-based-rock-ons/Spoolman_port.png b/images/interface/docker-based-rock-ons/Spoolman_port.png new file mode 100755 index 0000000..da67a27 Binary files /dev/null and b/images/interface/docker-based-rock-ons/Spoolman_port.png differ diff --git a/images/interface/docker-based-rock-ons/Spoolman_rockons.png b/images/interface/docker-based-rock-ons/Spoolman_rockons.png new file mode 100755 index 0000000..6b1acd0 Binary files /dev/null and b/images/interface/docker-based-rock-ons/Spoolman_rockons.png differ diff --git a/images/interface/docker-based-rock-ons/Spoolman_share.png b/images/interface/docker-based-rock-ons/Spoolman_share.png new file mode 100755 index 0000000..f26d63b Binary files /dev/null and b/images/interface/docker-based-rock-ons/Spoolman_share.png differ diff --git a/images/interface/docker-based-rock-ons/Spoolman_shareowner.png b/images/interface/docker-based-rock-ons/Spoolman_shareowner.png new file mode 100755 index 0000000..44532ad Binary files /dev/null and b/images/interface/docker-based-rock-ons/Spoolman_shareowner.png differ diff --git a/images/interface/docker-based-rock-ons/Spoolman_submit.png b/images/interface/docker-based-rock-ons/Spoolman_submit.png new file mode 100755 index 0000000..9328720 Binary files /dev/null and b/images/interface/docker-based-rock-ons/Spoolman_submit.png differ diff --git a/images/interface/docker-based-rock-ons/Spoolman_success.png b/images/interface/docker-based-rock-ons/Spoolman_success.png new file mode 100755 index 0000000..a66f0d1 Binary files /dev/null and b/images/interface/docker-based-rock-ons/Spoolman_success.png differ diff --git a/interface/docker-based-rock-ons/spoolman.rst b/interface/docker-based-rock-ons/spoolman.rst new file mode 100644 index 0000000..b6b04fc --- /dev/null +++ b/interface/docker-based-rock-ons/spoolman.rst @@ -0,0 +1,117 @@ +.. _Spoolman_rockon: + +Spoolman Rock-on +================ + +Before you install Spoolman, you should understand the prerequisites +and configurations common to all Rockstor :ref:`rockons_intro`; +specifically the :ref:`rockons_preinstall` and :ref:`rockons_root` +requirement. + + +.. _Spoolman_whatis: + +What is Spoolman +----------------- + +From the author's repository description: "Spoolman is a self-hosted web service +designed to help you efficiently manage your 3D printer filament spools and monitor their usage. +It acts as a centralized database that seamlessly integrates with +popular 3D printing software like OctoPrint and Klipper/Moonraker. +When connected, it automatically updates spool weights as printing progresses, +giving you real-time insights into filament usage." + +For more information go to https://github.com/Donkie/Spoolman. +Be sure to check for compatibility with your print system. + + +.. _Spoolman_install: + +Installing Spoolman Rock-on +---------------------------- +The Spoolman Rock-on requires a Rockstor share to use as the object store. +You should create this share in a pool with sufficient space for your needs +before beginning the Spoolman Rock-on installation. + +Once your share is ready, click the "Install" button next to the Spoolman listing +on the Rock-ons page. + +.. image:: /images/interface/docker-based-rock-ons/Spoolman_rockons.png + :width: 100% + :align: center + + +.. _Spoolman_share: + +Spoolman Share +^^^^^^^^^^^^^^^^ +Specify the share you created for Spoolman. + +.. image:: /images/interface/docker-based-rock-ons/Spoolman_share.png + :width: 100% + :align: center + +The Spoolman docker app does not run as root, so you must change the +ownership of the share so that the user is the same as the user you +created when installing Rockstor (the "admin" user) and the group is +"users". Give group full permissions, as well. + +.. image:: /images/interface/docker-based-rock-ons/Spoolman_shareowner.png + :width: 100% + :align: center + +.. _Spoolman_environment: + +Spoolman Environment +^^^^^^^^^^^^^^^^^^^^ +Spoolman does not need any environment variable defined. + + +.. _Spoolman_port: + +Spoolman Port +^^^^^^^^^^^^^ +Spoolman needs to know what TCP port you would like to assign to the Web admin interface. +Select a port that is not currently in use on your RockStor server. + +.. image:: /images/interface/docker-based-rock-ons/Spoolman_port.png + :width: 100% + :align: center + + +.. _Spoolman_verify: + +Spoolman Verify and Submit +^^^^^^^^^^^^^^^^^^^^^^^^^^ +Verify the information you've provided is correct, then click "Submit". + +.. image:: /images/interface/docker-based-rock-ons/Spoolman_submit.png + :width: 100% + :align: center + +You'll see screens indicating the Rock-on is being installed. Click "Close". + +.. image:: /images/interface/docker-based-rock-ons/Spoolman_installing.png + :width: 100% + :align: center + +.. image:: /images/interface/docker-based-rock-ons/Spoolman_inprogress.png + :width: 100% + :align: center + + +.. _Spoolman_success: + +Spoolman Installation Successful +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +Congratulations! You can click the red "Spoolman UI" button or open a Web browser +and navigate to `http://ROCKSTOR-IP:PORT-NUMBER` to go to the Spoolman Web management interface. +There you can begin to create and manage your filament library. + +.. image:: /images/interface/docker-based-rock-ons/Spoolman_success.png + :width: 100% + :align: center + +.. image:: /images/interface/docker-based-rock-ons/Spoolman_homepage.png + :width: 100% + :align: center diff --git a/interface/overview.rst b/interface/overview.rst index b1a437f..32682be 100644 --- a/interface/overview.rst +++ b/interface/overview.rst @@ -245,6 +245,7 @@ Note that not all Rock-ons have their own specific instructions in these docs. docker-based-rock-ons/openvpn-server docker-based-rock-ons/plex-media-server docker-based-rock-ons/scrutiny + docker-based-rock-ons/spoolman docker-based-rock-ons/syncthing docker-based-rock-ons/transmission-bittorrent docker-based-rock-ons/youtrack