Skip to content

Add rustfs documentation#217

Open
mrmarkuz wants to merge 3 commits intoNethServer:mainfrom
mrmarkuz:rustfsdoc
Open

Add rustfs documentation#217
mrmarkuz wants to merge 3 commits intoNethServer:mainfrom
mrmarkuz:rustfsdoc

Conversation

@mrmarkuz
Copy link
Member

Add rustfs to index and create documentation

NethServer/dev#7788

@mrmarkuz mrmarkuz self-assigned this Jan 28, 2026
@mrmarkuz mrmarkuz requested a review from stephdl January 28, 2026 13:30
Copy link
Contributor

@stephdl stephdl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

do not merge the PR now we will do it later, I ask the review of davidep too

rustfs.rst Outdated
Comment on lines 22 to 25
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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd add some examples:

Suggested change
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
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, 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, e.g. ``rustfs.example.org``

rustfs.rst Outdated
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``.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In documentation, use RFC 2606 domain names: example.org, example.com...

Suggested change
6. open the entered host name inside the browser, eg: ``https://rustfs-ui.nethserver.org``.
6. open the entered host name inside the browser, eg: ``https://rustfs.example.org``.

=============

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,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

do we need to refer to path if virtualhost is a mandatory ?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's just the explanation why we need 2 virtual hosts, see https://mattermost.nethesis.it/nethserver/pl/af1whyd1fjyr7bd7kffzjk7euy


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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is good, state on the mandatory and explain why, seems good to me

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants