Fix several things

Signed-off-by: Volker Theile <[email protected]>

Author: votdev

conf.py

@@ -63,6 +63,7 @@
 .. |copy| unicode:: 0xA9 .. copyright sign
 .. |webui| replace:: web interface
 .. |sf| replace:: shared folder
+.. |deb_version| replace:: 13
 """
 
 # The language for content autogenerated by Sphinx. Refer to documentation

faq.rst

@@ -2,37 +2,37 @@ FAQ
 ####
 
 What is OMV?
-----
+------------
 	OMV is an abbreviation of |omv|.
 
 Is |omv| a fork of FreeNAS?
-----
+---------------------------
 	No
 
 When shall i use |omv|?
-----
+-----------------------
 	If you want to set up a NAS really fast and manage it easily, then
 	|omv| is the right solution for you. If you want to use a really
 	free software where you are not a beta tester for a commercial
 	variant, then |omv| is also a solution for you.
 
 Does |omv| have drivers for my hardware?
-----
+----------------------------------------
 	Please consult the Debian hardware compatibility list for more information.
 
 Can I use a usb flash drive (stick) for installing the system?
-----
+--------------------------------------------------------------
 	Yes, but the installation does not have any optimizations to reduce writes
 	into the OS disk. The usb media will most likely start failing within a
 	few weeks of usage. Most common symptom is basic command execution does
 	not work, denied login, etc. More information `here <https://forum.openmediavault.org/index.php/Thread/6438-Tutorial-Experimental-Third-party-Plugin-available-Reducing-OMV-s-disk-writes-al/>`_.
 
 What are the default credentials for the UI?
-----
+--------------------------------------------
 	Use the user 'admin' and the password 'openmediavault' for the first login.
 
 Can I give administrator privileges to non-privileged users to access the web control panel?
-----
+--------------------------------------------------------------------------------------------
 	Yes. By default non-privileged users can only access their account profile, they can change
 	password and their email address if the administrator has allowed changes on their account.
 	However the current |webui| framework is designed for developers to create plugins where
@@ -42,7 +42,7 @@ Can I give administrator privileges to non-privileged users to access the web co
 	A non-privileged user can become a |webui| administrator by adding them to the ``openmediavault-admin`` group.
 
 I cannot read out SMART data for my storage device?
-----
+---------------------------------------------------
 	For storage devices connected via USB, |omv| relies entirely on the auto-detection
 	functionality of the `smartmontools <https://www.smartmontools.org/>`_ applications.
 	To be always up to date |omv| automatically downloads the `smartctl/smartd database <https://raw.githubusercontent.com/mirror/smartmontools/master/drivedb.h>`_
@@ -57,59 +57,59 @@ I cannot read out SMART data for my storage device?
 	for more information.
 
 What is the file :file:`/etc/openmediavault/config.xml` for?
-----
+------------------------------------------------------------
 	It is the database configuration store file for |omv|. When a change is
 	performed in the |webui|, the config value is stored and/or retrieved by
 	RPC to/from this file.
 
 Can I upgrade to Debian Testing/Unstable (Debian Testing/Sid) or use Ubuntu as a base distribution?
-----
+---------------------------------------------------------------------------------------------------
 	Yes. But the end is most likely a broken |webui| and possibly broken
 	system. |omv| releases are heavily tight to their Debian base distribution.
 	Get more information :doc:`here </various/apt>`.
 
 I´ve lost the |webui| password. How do I reset it?
-----
+--------------------------------------------------
 	Simply connect via ssh into the server or login locally on the machine
 	and type in: :command:`omv-firstaid`. There is an option to reset the
 	|webui| password.
 
 Can I backup or restore an existing |omv| configuration?
-----
+--------------------------------------------------------
 	There is no regular backup/restore procedure, but yes, in some way:
 	keep the file :file:`/etc/openmediavault/config.xml` for references
 	purposes if the option is to go for a clean re-install.
 
 What is the default HTTP engine of |omv|?
-----
+-----------------------------------------
 	NGINX. The last version of |omv| with Apache was 0.5 Sardoukar.
 
 Can I use Apache as HTTP engine?
-----
+--------------------------------
 	Yes, but is not supported. Eventually every |omv| package upgrade will
 	activate NGINX again leaving the |webui| broken. A parallel Apache
 	instance next to Nginx is possible, just make sure the ports are different
 	otherwise the |omv| |webui| will not work.
 
 How can use the default HTTP engine to hold my own web page?
-----
+------------------------------------------------------------
 	Do not modify |omv| default NGINX files. Place the website configurations
 	in :file:`/etc/nginx/sites-available` and enable it with
 	:command:`nginx_ensite <SITE>`. Read more information in the
 	`NGINX documentation <http://nginx.org/en/docs/>`_.
 
 Why does the system rewrites a configuration file(s) that I have manually edited?
-----
+---------------------------------------------------------------------------------
 	OMV takes full control of some system services. This services include
 	monit, ntp, samba, network, proftpd, nginx, php5-fpm, etc. Read
 	:doc:`here </various/files>`.
 
 How can I modify an internal value of some service |omv| has control over?
-----
+--------------------------------------------------------------------------
 	Read :doc:`here <various/advset>` for advanced configurations.
 
 How can I modify or add a network configuration with some custom options the |webui| does not provide?
-----
+------------------------------------------------------------------------------------------------------
 	Starting with |omv| version 5 `systemd-networkd` is used to configure the network.
 	The interfaces file :file:`/etc/network/interfaces` is controlled by |omv| but
 	not used anymore.
@@ -118,7 +118,7 @@ How can I modify or add a network configuration with some custom options the |we
 	Alternatively write your own `systemd-networkd` configuration files.
 
 Why my disks mount paths have a long alphanumeric number?
-----
+---------------------------------------------------------
 	The long number is called UUID, it is used by fstab to mount disks. This
 	number is unique per filesystem (or at least unlikely possible that
 	another filesystem comes with an identical one). This helps maintaining the
@@ -131,7 +131,7 @@ Why my disks mount paths have a long alphanumeric number?
 	The default creation of mount paths is documented `here <https://github.com/openmediavault/openmediavault/blob/20ec529737e6eca2e1f98d0b3d1ade16a3c338e1/deb/openmediavault/usr/share/openmediavault/engined/rpc/filesystemmgmt.inc#L823-L833>`_.
 
 I don't have a data disk, and I want to use my OS disk for storing data?
-----
+------------------------------------------------------------------------
 	The default behaviour of |omv| is to act as NAS server, that means OS
 	files are separated from data disks.
 
@@ -145,36 +145,36 @@ I don't have a data disk, and I want to use my OS disk for storing data?
 	SystemRescueCd.
 
 Can I install |omv| on top a running Debian system?
-----
+---------------------------------------------------
 	Yes, but it is recommended that the current running OS not to have a desktop environment
 	installed.
 
 What is the permissions/ownership of folders in |omv| created by shared folders?
-----
+--------------------------------------------------------------------------------
 	The default is folders in ``2775`` mode, with ``root:users`` ownership.
 	This means all users created in the |webui| can read, write to folders
 	created by the system in the data drives using the default. The setgid allows
 	group inheritance, meaning new files/folders below will always have the group
 	users (GID=100) membership.
 
 I need to delete a shared folder, why the delete button is greyed/disabled?
-----
+---------------------------------------------------------------------------
 	Shared folder configurations can be used across different services. When
 	removing a shared folder configuration is necessary to unlink it from
 	every service is attached to, before the delete button becomes available.
 	At the moment there is no internal database backend that can display
 	information about which service is holding which shares.
 
 What is the :command:`omv-salt` command for?
-----
+--------------------------------------------
 	:command:`omv-salt` is a terminal console command that is used by the
 	backend of |omv| to pipe directives and values to service configuration
 	files. The arguments that :command:`omv-salt` accepts are related to the
 	name of the service it configures. Type :command:`omv-salt` in terminal,
 	press TAB key, and the terminal will display all available arguments.
 
-I want to experiment with |omv| or make changes to the code
-----
+I want to experiment with |omv| or make changes to the code.
+------------------------------------------------------------
 	As a true open source system everything is possible. The
 	recommendation is do not test with the production server to avoid
 	breaking the |webui|. The best thing to do is to use a Virtual Machine.
@@ -185,5 +185,5 @@ I want to experiment with |omv| or make changes to the code
 	machine.
 
 What is the :command:`omv-upgrade` and :command:`omv-release-upgrade` for?
-----
+--------------------------------------------------------------------------
 	Information about those commands are in the software :doc:`section </various/apt>`.

installation/on_debian.rst

@@ -1,7 +1,7 @@
-Installation on Debian
-######################
+Installation on Debian |deb_version|
+####################################
 
-You can install |omv| on an existing Debian installation as well.
+You can install |omv| on an existing Debian |deb_version| installation as well.
 
 .. note::
     The installation of |omv| will be denied if a graphical desktop

prerequisites.rst

@@ -101,7 +101,7 @@ Software requirements
 ======  =================  ==============  ================  =========================================
  Item    Software           Minimal         Best              Recommendation
 ======  =================  ==============  ================  =========================================
- OS      Debian Linux       13 (Trixie)     13 (Trixie)
+ OS      Debian Linux       |deb_version|   |deb_version|
  BOOT    BIOS,UBOOT,UEFI    BIOS,mbr        BIOS, GPT         Disable Secure boot, GPT table
  SDS     HDD,SSD,USB...     1, 4GiB         2, 120+500GiB     Disk drive with 120G root size, 8G swap size
  DDS     HDD,SSD,USB...     0 or any        HHD,1 per share   One disk or part per shared resource

troubleshooting.rst

@@ -2,47 +2,47 @@ Troubleshooting
 ===============
 
 The web interface has missing fields and/or items showing that have been uninstalled.
-----
+-------------------------------------------------------------------------------------
 	Clear your browser cache.
 
 The web interface keeps rejecting my credentials.
-----
+-------------------------------------------------
 	If the password is correct then this is most likely caused by the rootfs partition being full. This command can help track which folders are the biggest :command:`df -hx --max-depth=1 /`.
 
 I only see a few items in the web interface interface like the user section of Access Rights Management.
-----
+--------------------------------------------------------------------------------------------------------
 	You did not login as the admin user. This is the only user that can access everything.
 
 I get an error every time I post in the forum especially if it is a long post and/or has links to external pages.
-----
+-----------------------------------------------------------------------------------------------------------------
 	The error is deceiving. Please don't keep trying to post. The spam filter has flagged your post and it will need to be approved. Please be patient.
 
 I mounted the drive using the command line or GUI tool and I can't pick that drive in the shared folder device dropdown.
-----
+------------------------------------------------------------------------------------------------------------------------
 	Never mount a drive with anything other than the |omv| |webui|. This creates the necessary database entries to populate the device dropdown.
 
 Samba is slow.
-----
+--------------
 	Read these threads:
 
 	- `read/write performance for SMB shares hosted on RPi4 <https://forum.openmediavault.org/index.php?thread/37285-rpi4-read-write-performance-for-smb-shares/&postID=260232#post260232>`_
 	- `Tuning Samba for more speed <http://forum.openmediavault.org/index.php/Thread/12986-Tunning-Samba-for-more-speed/>`_ (note: written for OMV 2.x)
 	- `Tuning Samba for more speed 2 <http://forum.openmediavault.org/index.php/Thread/14615-Tuning-Samba-for-more-speed-2//>`_ (note: written for OMV 2.x)
 
 Samba share password is refused from Windows 10.
-----
+------------------------------------------------
 	To fix the problem you need to change the `Network Security LAN Manager authentication level <https://social.technet.microsoft.com/Forums/windows/en-US/8249ad4c-69aa-41ba-8863-8ecd7a7a4d27/samba-share-password-refused>`_.
 
-How to troubleshoot an error caused by an "Option" parameter passed to a plug-in
-----
+How to troubleshoot an error caused by an "Option" parameter passed to a plug-in?
+---------------------------------------------------------------------------------
 	To find the root cause, run the faulty systemd unit file yourself by executing::
 
 		systemd restart <plug-in-daemon>
 
 	If output of <plug-in> is now more verbose, then you will get a hint on STDOUT. If not, then you need to run ``journalctl -f`` in parallel to get the syslog output. Admittedly, not really novice friendly, but it's really not possible to do it any other way. OMV always tries to be as error/debug friendly as possible; by default.
 
 I am using JMicron drive enclosures and some of my drives are not appearing.
-----
+----------------------------------------------------------------------------
 	This is likely because JMicron controllers incorrectly report identical serial numbers and other data which confuses various systems.
 	|omv| provides an `UDEV rules database <https://github.com/openmediavault/openmediavault/pull/746>`_ which will fix that issue for several USB PATA/SATA bridge controllers.
 	If your hardware still does not work, then please provide the information mentioned in that pull request and open a new tracker issue.