From 3ce93514d522c4399009e3efbeeeccb57efc4b8d Mon Sep 17 00:00:00 2001 From: mrmarkuz Date: Wed, 28 Jan 2026 14:25:20 +0100 Subject: [PATCH 1/3] Add rustfs documentation --- index.rst | 1 + rustfs.rst | 29 +++++++++++++++++++++++++++++ 2 files changed, 30 insertions(+) create mode 100644 rustfs.rst diff --git a/index.rst b/index.rst index 8d90e65f..6f0bb29a 100644 --- a/index.rst +++ b/index.rst @@ -66,6 +66,7 @@ NethServer 8 administrator manual dnsmasq netdata piler + rustfs .. toctree:: :maxdepth: 2 diff --git a/rustfs.rst b/rustfs.rst new file mode 100644 index 00000000..e6670821 --- /dev/null +++ b/rustfs.rst @@ -0,0 +1,29 @@ +.. _rustfs-section: + +====== +RustFS +====== + +`RustFS `_ offers high-performance, S3 compatible object storage. + +You can install multiple RustFS instances on the same node from the :ref:`software_center-section`. + +Configuration +============= + +RustFS needs two dedicated virtual hosts, a FQDN like ``rustfs-api.nethserver.org`` and ``rustfs-ui.nethserver.org``. + +Before proceeding with the configuration, make sure to create the corresponding name records inside your DNS server. +If you are planning to use a Let's Encrypt certificate as default, make also sure to have corresponding public DNS records. + +How to configure: + +1. access the application configuration page and enter the ``API server host name``: + this will be the FQDN used by hosts to connect to S3 services +2. fill the ``Web interface host name``: you will be able to configure your + RustFS instance from this FQDN +3. enable ``Let's Encrypt`` option accordingly to your needs +4. fill the ``rustfs root user name`` and the ``rustfs root password``: those are the login credentials +5. click the :guilabel:`Save` button +6. open the entered host name inside the browser, eg: ``https://rustfs-ui.nethserver.org``. + From 0a8d8c225e196327f3dcbaddb2598c4d9383f590 Mon Sep 17 00:00:00 2001 From: mrmarkuz Date: Wed, 4 Feb 2026 09:04:35 +0100 Subject: [PATCH 2/3] Add 2 FQDN requirement explanation --- rustfs.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/rustfs.rst b/rustfs.rst index e6670821..388198fe 100644 --- a/rustfs.rst +++ b/rustfs.rst @@ -11,7 +11,8 @@ You can install multiple RustFS instances on the same node from the :ref:`softwa Configuration ============= -RustFS needs two dedicated virtual hosts, a FQDN like ``rustfs-api.nethserver.org`` and ``rustfs-ui.nethserver.org``. +Some S3 clients do not correctly support API endpoints exposed under a path prefix. For better compatibility, +two distinct server names need to be assigned: one dedicated to the S3 protocol endpoint and another dedicated to the administrative console. Before proceeding with the configuration, make sure to create the corresponding name records inside your DNS server. If you are planning to use a Let's Encrypt certificate as default, make also sure to have corresponding public DNS records. @@ -26,4 +27,3 @@ How to configure: 4. fill the ``rustfs root user name`` and the ``rustfs root password``: those are the login credentials 5. click the :guilabel:`Save` button 6. open the entered host name inside the browser, eg: ``https://rustfs-ui.nethserver.org``. - From 59ed4d20ce1ffdd1a9634422d810fa1ef2aeacac Mon Sep 17 00:00:00 2001 From: mrmarkuz Date: Wed, 4 Feb 2026 09:43:01 +0100 Subject: [PATCH 3/3] Add RFC 2606 example domains --- rustfs.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/rustfs.rst b/rustfs.rst index 388198fe..1968c381 100644 --- a/rustfs.rst +++ b/rustfs.rst @@ -20,10 +20,10 @@ If you are planning to use a Let's Encrypt certificate as default, make also sur How to configure: 1. access the application configuration page and enter the ``API server host name``: - this will be the FQDN used by hosts to connect to S3 services + this will be the FQDN used by hosts to connect to S3 services, e.g. ``s3.example.org``, ``storage.example.org`` 2. fill the ``Web interface host name``: you will be able to configure your - RustFS instance from this FQDN + RustFS instance from this FQDN, e.g. ``rustfs.example.org`` 3. enable ``Let's Encrypt`` option accordingly to your needs 4. fill the ``rustfs root user name`` and the ``rustfs root password``: those are the login credentials 5. click the :guilabel:`Save` button -6. open the entered host name inside the browser, eg: ``https://rustfs-ui.nethserver.org``. +6. open the entered host name inside the browser, e.g. ``https://rustfs.example.org``.