-
Notifications
You must be signed in to change notification settings - Fork 16
Add rustfs documentation #217
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
mrmarkuz
wants to merge
3
commits into
NethServer:main
Choose a base branch
from
mrmarkuz:rustfsdoc
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+30
−0
Open
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -66,6 +66,7 @@ NethServer 8 administrator manual | |
| dnsmasq | ||
| netdata | ||
| piler | ||
| rustfs | ||
|
|
||
| .. toctree:: | ||
| :maxdepth: 2 | ||
|
|
||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| .. _rustfs-section: | ||
|
|
||
| ====== | ||
| RustFS | ||
| ====== | ||
|
|
||
| `RustFS <https://rustfs.com/>`_ offers high-performance, S3 compatible object storage. | ||
|
|
||
| You can install multiple RustFS instances on the same node from the :ref:`software_center-section`. | ||
|
|
||
| Configuration | ||
| ============= | ||
|
|
||
| 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. Choose a reason for hiding this commentThe 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 |
||
|
|
||
| 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, 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`` | ||
| 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, e.g. ``https://rustfs.example.org``. | ||
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.
There was a problem hiding this comment.
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 ?
There was a problem hiding this comment.
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