lift knowhow from examples in forum into doc section "Troubleshooting"
https://forum.openmediavault.org/index.php?thread/37269-upgrade-scripts-for-non-interactive-major-release-upgrades-2-3-3-4-4-5/&postID=279556#post279556

Describe the improvement you'd like
"Contributing rules" have been created in GitHub because developers would look there first.
Add reference to this page instead of duplicating content

https://openmediavault.readthedocs.io/en/5.x/installation/index.html refers to 'several preconfigured images for ARM devices' that seem long obsolete.
Is my understanding correct?
If confirmed I'd replace it with 'an automated installation script'.
Please comment

Describe the improvement you'd like
Likely the warning "Filesystems greater than 16TB in ext4
The default mkfs.ext4 of Debian Wheezy does not use the 64bit flag for filesystems under 16TB," could be removed in https://openmediavault.readthedocs.io/en/5.x/administration/storage/filesystems.html

Additional context
Add any other context or screenshots about the improvement request here.

Describe the improvement you'd like
The current workflow requires a correctly working Sphinx setup but this requirement is too much effort for occasional editors wanting to contribute just a "1 line change". Example is "broken rending" in #109 (comment)
This is the reason for raising this suggestion and looking for feedback.

Additional context
GitHub free tire announcement of GitHub CodeSpace

Is your feature request related to a problem? Please describe.
users misread the statement
HDD:
System Drive: min. 4 GiB capacity (but more than the capacity of the RAM)
example here
Describe the solution you'd like
change to

HDD:
System Drive: min. 4 GiB plus capacity of the RAM

Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.

Additional context
Add any other context or screenshots about the feature request here.

OMV was reviewed on 8Feb2021 in a German NAS forum
Based on feedback of tester & moderator of this forum the incorrect understanding was that OMV has no capability to backup OMV configuration but openmediavault-backup exists since a long time!

To fix this wrong conclusion documentation should be improved by adding openmediavault-backup to "new user" & "backup" sections

Describe the improvement you'd like
Please add it to "latest"

Additional context
V5:

latest:

Is your feature request related to a problem? Please describe.
To create better visibility of OMV's official documentation

Describe the solution you'd like
Update link in SF SBC readme.txt
to ReadTheDocs New user Guide

mkconf seems not used since version 5
reference https://forum.openmediavault.org/index.php?thread/39537-omv-tool-documentation/&postID=277666#post277666

@votdev Change from 6Apr2021 doesn't appear on official doc despite being merged

The documentation of plugin guide of OMV6​, there is some link should be modify because of the internal UI library renamed.
commit #1080

The links at components.d, descripting about the "name" field.
formPage
selectionListPage

and the link depends on the old internal UI library name.

obsolete content found in https://openmediavault.readthedocs.io/en/5.x/new_user_guide/newuserguide.html?highlight=rsync#full-disk-mirroring-backup-with-rsync likely more such incorrect references exist

@flmaxey could you please have a look?

New users are overwhelmed on how to diagnose root cause of an issue.
These issues are frequently caused by kernel or OMV updates (ie 5.4 to 5.10).
An example would help to build skills.
Reference forum thread: "something changed"

• add "USB backup plugin uses rsync to perform the backup. Because of that everything should be visible when selecting 'Rsync - Jobs' in the log page." as mentioned in openmediavault/openmediavault#686

• add links from openmediavault-docs/plugins.rst

Describe the improvement you'd like
On the "Plugins" page for the OMV documentation, it lists the built-in plugins for OMV, but for 3rd-party plugins it refers to omv-extras.org. However, all that site has is documentation on installing plugins, but no listing of available plugins.

There either needs to be a list of 3rd-party pluging on the OMV site, or a link to a site that actually has the 3rd-party plugins listed.

Greetings everyone,
I was trying to install openmediavault, while running in the error above.
This is the first time for me to submit an issue, so if I am not doing it well enough I am very open for criticism.

First let me round up my setup and the installation instructions I used.
I have an homeserver which runs Proxmox, with an Debian 10 container (lxc) and after executing the the last step (omv-confdbadm populate) in mentioned instruction I ran in following error code:
’multicast’ does not appear to be an IPv4 or IPv6 network

Here is my the complete output of my error message:

[ERROR   ] An un-handled exception was caught by salt's global exception handler:
ValueError: 'multicast' does not appear to be an IPv4 or IPv6 network
Traceback (most recent call last):
  File "/usr/bin/salt-call", line 11, in <module>
    load_entry_point('salt==3003', 'console_scripts', 'salt-call')()
  File "/usr/lib/python3/dist-packages/salt/scripts.py", line 449, in salt_call
    client.run()
  File "/usr/lib/python3/dist-packages/salt/cli/call.py", line 58, in run
    caller.run()
  File "/usr/lib/python3/dist-packages/salt/cli/caller.py", line 112, in run
    ret = self.call()
  File "/usr/lib/python3/dist-packages/salt/cli/caller.py", line 220, in call
    self.opts, data, func, args, kwargs
  File "/usr/lib/python3/dist-packages/salt/loader.py", line 1235, in __call__
    return self.loader.run(run_func, *args, **kwargs)
  File "/usr/lib/python3/dist-packages/salt/loader.py", line 2268, in run
    return self._last_context.run(self._run_as, _func_or_method, *args, **kwargs)
  File "/usr/lib/python3/dist-packages/salt/loader.py", line 2283, in _run_as
    return _func_or_method(*args, **kwargs)
  File "/usr/lib/python3/dist-packages/salt/executors/direct_call.py", line 12, in execute
    return func(*args, **kwargs)
  File "/usr/lib/python3/dist-packages/salt/loader.py", line 1235, in __call__
    return self.loader.run(run_func, *args, **kwargs)
  File "/usr/lib/python3/dist-packages/salt/loader.py", line 2268, in run
    return self._last_context.run(self._run_as, _func_or_method, *args, **kwargs)
  File "/usr/lib/python3/dist-packages/salt/loader.py", line 2283, in _run_as
    return _func_or_method(*args, **kwargs)
  File "/usr/lib/python3/dist-packages/salt/modules/network.py", line 1764, in routes
    routes_ = _ip_route_linux()
  File "/usr/lib/python3/dist-packages/salt/modules/network.py", line 609, in _ip_route_linux
    address_mask = convert_cidr(comps[0])
  File "/usr/lib/python3/dist-packages/salt/modules/network.py", line 1232, in convert_cidr
    cidr = calc_net(cidr)
  File "/usr/lib/python3/dist-packages/salt/modules/network.py", line 1255, in calc_net
    return __utils__["network.calc_net"](ip_addr, netmask)
  File "/usr/lib/python3/dist-packages/salt/loader.py", line 1235, in __call__
    return self.loader.run(run_func, *args, **kwargs)
  File "/usr/lib/python3/dist-packages/salt/loader.py", line 2268, in run
    return self._last_context.run(self._run_as, _func_or_method, *args, **kwargs)
  File "/usr/lib/python3/dist-packages/salt/loader.py", line 2283, in _run_as
    return _func_or_method(*args, **kwargs)
  File "/usr/lib/python3/dist-packages/salt/utils/network.py", line 1185, in calc_net
    return str(ipaddress.ip_network(ipaddr, strict=False))
  File "/usr/lib/python3/dist-packages/salt/ext/ipaddress.py", line 108, in ip_network
    address)
ValueError: 'multicast' does not appear to be an IPv4 or IPv6 network
Traceback (most recent call last):
  File "/usr/bin/salt-call", line 11, in <module>
    load_entry_point('salt==3003', 'console_scripts', 'salt-call')()
  File "/usr/lib/python3/dist-packages/salt/scripts.py", line 449, in salt_call
    client.run()
  File "/usr/lib/python3/dist-packages/salt/cli/call.py", line 58, in run
    caller.run()
  File "/usr/lib/python3/dist-packages/salt/cli/caller.py", line 112, in run
    ret = self.call()
  File "/usr/lib/python3/dist-packages/salt/cli/caller.py", line 220, in call
    self.opts, data, func, args, kwargs
  File "/usr/lib/python3/dist-packages/salt/loader.py", line 1235, in __call__
    return self.loader.run(run_func, *args, **kwargs)
  File "/usr/lib/python3/dist-packages/salt/loader.py", line 2268, in run
    return self._last_context.run(self._run_as, _func_or_method, *args, **kwargs)
  File "/usr/lib/python3/dist-packages/salt/loader.py", line 2283, in _run_as
    return _func_or_method(*args, **kwargs)
  File "/usr/lib/python3/dist-packages/salt/executors/direct_call.py", line 12, in execute
    return func(*args, **kwargs)
  File "/usr/lib/python3/dist-packages/salt/loader.py", line 1235, in __call__
    return self.loader.run(run_func, *args, **kwargs)
  File "/usr/lib/python3/dist-packages/salt/loader.py", line 2268, in run
    return self._last_context.run(self._run_as, _func_or_method, *args, **kwargs)
  File "/usr/lib/python3/dist-packages/salt/loader.py", line 2283, in _run_as
    return _func_or_method(*args, **kwargs)
  File "/usr/lib/python3/dist-packages/salt/modules/network.py", line 1764, in routes
    routes_ = _ip_route_linux()
  File "/usr/lib/python3/dist-packages/salt/modules/network.py", line 609, in _ip_route_linux
    address_mask = convert_cidr(comps[0])
  File "/usr/lib/python3/dist-packages/salt/modules/network.py", line 1232, in convert_cidr
    cidr = calc_net(cidr)
  File "/usr/lib/python3/dist-packages/salt/modules/network.py", line 1255, in calc_net
    return __utils__["network.calc_net"](ip_addr, netmask)
  File "/usr/lib/python3/dist-packages/salt/loader.py", line 1235, in __call__
    return self.loader.run(run_func, *args, **kwargs)
  File "/usr/lib/python3/dist-packages/salt/loader.py", line 2268, in run
    return self._last_context.run(self._run_as, _func_or_method, *args, **kwargs)
  File "/usr/lib/python3/dist-packages/salt/loader.py", line 2283, in _run_as
    return _func_or_method(*args, **kwargs)
  File "/usr/lib/python3/dist-packages/salt/utils/network.py", line 1185, in calc_net
    return str(ipaddress.ip_network(ipaddr, strict=False))
  File "/usr/lib/python3/dist-packages/salt/ext/ipaddress.py", line 108, in ip_network
    address)
ValueError: 'multicast' does not appear to be an IPv4 or IPv6 network

Due the nature of being network related here my network configuration. The IPv6 address has been altered due to safety reasons:

1: lo: <LOOPBACK,UP,LOWER_UP> mtu 65536 qdisc noqueue state UNKNOWN group default qlen 1000
    link/loopback 00:00:00:00:00:00 brd 00:00:00:00:00:00
    inet 127.0.0.1/8 scope host lo
       valid_lft forever preferred_lft forever
    inet6 ::1/128 scope host 
       valid_lft forever preferred_lft forever
2: eth0@if22: <BROADCAST,MULTICAST,UP,LOWER_UP> mtu 1500 qdisc noqueue state UP group default qlen 1000
    link/ether 76:47:e0:5e:02:ce brd ff:ff:ff:ff:ff:ff link-netnsid 0
    inet 10.30.1.47/24 brd 10.30.1.255 scope global eth0
       valid_lft forever preferred_lft forever
    inet6 2a02:2363:262:f504:7489:e0ff:fe5e:2ce/64 scope global dynamic mngtmpaddr 
       valid_lft 7105sec preferred_lft 3505sec
    inet6 fe80::7489:e0ff:fe5e:2ce/64 scope link 
       valid_lft forever preferred_lft forever
default via 10.30.1.1 dev eth0 onlink 
10.30.1.0/24 dev eth0 proto kernel scope link src 10.30.1.47 
::1 dev lo proto kernel metric 256 pref medium
2a02:2363:262:f504::/64 dev eth0 proto kernel metric 256 expires 7104sec pref medium
fe80::/64 dev eth0 proto kernel metric 256 pref medium
default via fe80::2e91:abff:fe91:87d9 dev eth0 proto ra metric 1024 expires 1704sec hoplimit 255 pref medium

If you need further informations please let me know and thank you for your help.

Describe the improvement you'd like
Developers are used to have automated tooling to support coding tasks.
Instead of explaining the coding rules to follow an automated process should be used that assures the rules are enforced.

Additional context
I've seen a great example for above in https://github.com/vercel/next.js/blob/canary/contributing/repository/linting.md

@votdev in case you see value in going this route, I'd be happy to port above outlined tooling to OMV.
If no value is perceive just close this issue

the best starting point for a single common text file seems to be openmediavault-docs/installation/index.rst but it requires clean-up (i.e. incorrect seems the statement "and several preconfigured images for ARM devices.")

different instructions exist on:

1. https://www.openmediavault.org/?page_id=77 => note: source of page seems to exist outside of github
2. https://openmediavault.readthedocs.io/en/5.x/new_user_guide/newuserguide.html#installing-on-single-board-computers-sbc-s
3. https://openmediavault.readthedocs.io/en/5.x/new_user_guide/newuserguide.html#installing-on-i386-32-bit-platforms
4. https://openmediavault.readthedocs.io/en/5.x/new_user_guide/newuserguide.html#amd64-64-bit-platforms
5. forum?

Note: the list is likely incomplete! Please add links here as you find them

Describe the improvement you'd like
Hi,

When going through the documentation I noticed that the New User guide section is present here:

But not here:

I was wondering is this by design or a bug?
I nearly missed the user guide entirely.

Regards

The great technical introduction "How it works" doc is only reachable via search machine because its NOT mentioned in Table-of-Content

content in openmediavault/openmediavault#1049

Is your feature request related to a problem? Please describe.
Today only very basic information is documented, the pointer to advanced topics is badly noticeable (see forum post)

Describe the solution you'd like
Make it obvious for readers where advanced topics are explained

related to openmediavault/openmediavault#887

Describe the improvement you'd like
Add a screenshot of "Services" page and a short description for plugin configuration
Additional context
New user was unable to find infos about "how to configure an installed plugin"
See this forum post for details

Describe the improvement you'd like
Update the System Drive size requirements in prerequisites.rst

Additional context
The prerequisites at prerequisites.rst state that the System Drive should be min. 4 GiB capacity. With this capacity, on a fresh install, when I run the first update, the system runs out of space while installing linux-image-6.1.0-0.deb11.13-amd64 6.1.55-1~bpo11+1:

Unpacking linux-image-6.1.0-0.deb11.13-amd64 (6.1.55-1~bpo11+1) ...
dpkg: error processing archive /var/cache/apt/archives/linux-image-6.1.0-0.deb11.13-amd64_6.1.55-1~bpo11+1_amd64.deb (--unpack):
 cannot copy extracted data for './lib/modules/6.1.0-0.deb11.13-amd64/kernel/net/smc/smc.ko' to '/lib/modules/6.1.0-0.deb11.13-amd64/kernel/net/smc/smc.ko.dpkg-new': failed to write (No space left on device)

As I reconfigured all my servers I have the need to fully reconfigure one of my omv servers. I could just reinstall OMV, but was looking for a function that just resets all paramters back to default (so no mounted devices, no user account, no smb shares, etc, just the plain installation).

Can I just delete some special files and reboot and the installation is fresh? Or do I have to go the USB-Stick way?

Hi! I installed OMV6, but I encountered a problem. When there is no network connection, the boot is very slow. How to turn off this boot detection network?

In the NFS docs the following is stated about the available options:

Client: Enter a single ip, host or network CIDR notation. Only one entry is allowed at the moment. You can leave it empty if you do not want network security.

However, on my omv install the field is marked as required. I did some more digging and found where it's defined as required (see here)

Describe the improvement you'd like

I was advised to put this topic here.

OMV uses systemd-networkd and removes dhcpcd during installation - any tutorial to set up AP (hostapd - link ) does not work without dhcpcd.
Reinstallation of dhcpd5 with "sudo apt install dhcpcd5" does not bring the solution
RaspAP also does not work either.
I was not able to manage systemd-networkd to handle without dhcpcd.

Option to install OMV with bypassing the networks configuration allows for proper operation as AP but it requires full system reinstallation.

Describe the solution you'd like
would be nice to have clear tutorial how to activate AP (bridged and NATed) on working OMV or how to revert network configuration to avoid system reinstallation.

Additional context
link to OMV forum