Skip to content

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.

Sign up for GitHub

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 1 commit into
base: main
Choose a base branch
from
Open

Add rustfs documentation #217

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,7 @@ NethServer 8 administrator manual
dnsmasq
netdata
piler
rustfs

.. toctree::
:maxdepth: 2
Expand Down
29 changes: 29 additions & 0 deletions rustfs.rst
View file
Open in desktop
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
=============

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``.