Add rustfs documentation #217
Open
+30
−0
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
stephdl
approved these changes
Jan 29, 2026
Contributor
stephdl
left a comment
stephdl
left a comment
There was a problem hiding this comment.
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 |
Member
There was a problem hiding this comment.
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``. |
Member
There was a problem hiding this comment.
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``. |
stephdl
reviewed
Feb 4, 2026
| ============= | ||
|
|
||
| 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, |
Contributor
There was a problem hiding this comment.
do we need to refer to path if virtualhost is a mandatory ?
Member
Author
There was a problem hiding this comment.
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. |
Contributor
There was a problem hiding this comment.
this is good, state on the mandatory and explain why, seems good to me
DavidePrincipi
approved these changes
Feb 4, 2026
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add rustfs to index and create documentation
NethServer/dev#7788