Skip to content

Commit

Permalink
Continue to add content.
Browse files Browse the repository at this point in the history 
Signed-off-by: Volker Theile <volker.theile@openmediavault.org>
  • Loading branch information
@votdev
votdev committed Jan 16, 2018
1 parent 66cbb8a commit 20efadb
Show file tree
Hide file tree
Showing 5 changed files with 102 additions and 50 deletions.
2 changes: 1 addition & 1 deletion FAQ.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ 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.

How can I modify an internal value of some service |omv| has control over?
Read :doc:`here <various/advancedsettings>` for advanced configurations.
Read :doc:`here <various/advset>` for advanced configurations.

How can I modify or add a network configuration of :file:`/etc/network/interfaces` with some custom options the |webui| does not provide?
The interfaces file is controlled by |omv|. To add network interfaces that are not configurable through the |webui| or other options not present, you need to use :doc:`advanced settings <various/advancedsettings>`.
Expand Down
58 changes: 40 additions & 18 deletions various/advset.rst
View file
Original file line number Diff line number Diff line change
@@ -1,46 +1,63 @@
Advanced Configuration
======================

OpenMediaVault is not a replacement for webmin, where you can configure all options in the web interface. Options are already preconfigured to make it easier for the average user to install and start using the NAS server.
|omv| is not a replacement for webmin, where you can configure all options in
the web interface. Options are already preconfigured to make it easier for the
average user to install and start using the NAS server.

As mentioned before in the FAQ OpenMediaVault takes full control of some services, making difficult to intervene configuration files. Changes manually added to configuration files will eventually rewritten at some stage by the system. The list of common files not to intervene is listed :doc:`here </various/conffiles>`
As mentioned before in the :doc:`FAQ </FAQ>` |omv| takes full control of some
services, making difficult to intervene configuration files. Changes manually
added to configuration files will eventually rewritten at some stage by the
system. The list of common files not to intervene is listed :doc:`here </various/conffiles>`.

To overcome this there are some options available to modify some of the default OpenMediaVault configuration options and values, like the use of environmental variables
To overcome this there are some options available to modify some of the default
|omv| configuration options and values, like the use of environmental variables.

Environmental Variables
-----------------------
The web does not provide access to ALL the configuration aspects of a complex system like |omv|. However, the system allows to change some advanced settings through the use of environment variables. To set or change these variables, login to you |omv| system using SSH and edit the file:

The web does not provide access to ALL the configuration aspects of a complex
system like |omv|. However, the system allows to change some advanced settings
through the use of environment variables. To set or change these variables,
login to you |omv| system using SSH and edit the file:

:file:`/etc/default/openmediavault`

Put the variable you want to change at the end of the file with the new value. Ensure the value is declared with double quotes
Put the variable you want to change at the end of the file with the new value.
Ensure the value is declared with double quotes.

For example we are going to change the default sftp server for SSH service.

:code:`OMV_SSHD_SUBSYSTEM_SFTP=“/usr/lib/openssh/sftp-server”`

Make your changes, save, restart engined service openmediavault-engined restart and run omv-mkconf ssh, finally reload the SSH service via webUI or systemd

The list of all available environment variables can be found here

The list of environmental variables used for ``/etc/fstab`` filesystem with the defaults options and how to use them is described here
Make your changes, save, restart engined service openmediavault-engined restart
and run omv-mkconf ssh, finally reload the SSH service via |webui| or systemd.

The mkconf folder
-----------------

The other advanced configuration is the use of :code:`mkconf/{service}.d/` folder type
The other advanced configuration is the use of :code:`mkconf/{service}.d/`
folder type.

The mkconf scripts bundled in openmediavault core and plugins are in :code:`/usr/share/openmediavault/mkconf/{service}.d/` folder. Those scripts are executed by run-parts in alphabetical order when a change is done in the webUI so the configuration is piped to the corresponding .conf file on their respective service.
The mkconf scripts bundled in |omv| core and plugins are in :code:`/usr/share/openmediavault/mkconf/{service}.d/` folder. Those scripts are executed by run-parts in alphabetical order when a change is done in the webUI so the configuration is piped to the corresponding .conf file on their respective service.

These scripts are useful for placing extra configurations for services in a way that server will not overwrite the files every time you change something in the webUI.
These scripts are useful for placing extra configurations for services in a way
that server will not overwrite the files every time you change something in the
|webui|.


Examples using mkconf folders
----_
-----------------------------

Network interfaces file
The file ``/etc/network/interfaces`` will be (re-)generated by OMV on demand. Thus custom changes that are done by the user will get lost. To prevent this, the config generation supports custom scripts to add additional configuration to the '/etc/network/interfaces' file when OMV is generating it. Using this new feature it is no problem to add bridge or VLAN configurations.
To do that a script must be located at /usr/share/openmediavault/mkconf/interfaces.d/. and has to be executable. The script should look like the following::
The file ``/etc/network/interfaces`` will be (re-)generated by |omv| on
demand. Thus custom changes that are done by the user will get lost. To
prevent this, the config generation supports custom scripts to add
additional configuration to the '/etc/network/interfaces' file when |omv|
is generating it. Using this new feature it is no problem to add bridge or
VLAN configurations.
To do that a script must be located at /usr/share/openmediavault/mkconf/interfaces.d/.
and has to be executable. The script should look like the following::

#!/bin/sh
#
Expand Down Expand Up @@ -77,7 +94,12 @@ Network interfaces file
iface lo inet6 loopback
EOF

reference: http://forums.openmediavault.org/index.php/Thread/7355-Customize-etc-network-interfaces-the-OMV-way-1-11/
Reference: http://forums.openmediavault.org/index.php/Thread/7355-Customize-etc-network-interfaces-the-OMV-way-1-11/

Samba
Another example was this script published in the forum as a `guide <http://forums.openmediavault.org/index.php/Thread/11607-Samba-access-based-share-enum-workaround-for-workgroups-Hide-shares-that-users-d/>`_ for samba. The intention of the user was to hide samba shares (not browsable) to users who did not have privileges to login into that shared folder. So basically the script will read the valid users list and will attempt to create as many files as valid users, appending the username variable to the end.
Another example was this script published in the forum as a `guide <http://forums.openmediavault.org/index.php/Thread/11607-Samba-access-based-share-enum-workaround-for-workgroups-Hide-shares-that-users-d/>`_
for samba. The intention of the user was to hide samba shares (not
browsable) to users who did not have privileges to login into that shared
folder. So basically the script will read the valid users list and will
attempt to create as many files as valid users, appending the username
variable to the end.
74 changes: 52 additions & 22 deletions various/apt.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,76 +4,106 @@ Software
Overview
----

Openmediavault is under a Debian distribution. It uses apt to install packages. All standard Debian packages are upgraded using the official Debian mirrors. Openmediavault packages are upgraded using the http://packages.openmediavault.org repository.
|omv| is under a Debian distribution. It uses apt to install packages. All
standard Debian packages are upgraded using the official Debian mirrors. |omv|
packages are upgraded using the http://packages.openmediavault.org repository.

Update Manager
----

The update manager displays all available packages for upgrade. You can select them if you want to do individual or mass upgrade. The server uses cron-apt to perform a daily apt-get update and fetch upgrade packages automatically. If you have notifications enabled you receive an email every time packages are ready for install.
The update manager displays all available packages for upgrade. You can select
them if you want to do individual or mass upgrade. The server uses cron-apt to
perform a daily apt-get update and fetch upgrade packages automatically. If you
have notifications enabled you receive an email every time packages are ready
for install.

Using CLI
----

**apt-get**
If you want to update/upgrade in the console you can use apt-get update then apt-get upgrade

If you want to update/upgrade in the console you can use ``apt-get update`` then
``apt-get upgrade``.

**omv-update**
This is wrapper script that basically executes :code:`apt-get update && apt-get upgrade`.

The full command is:
This is wrapper script that basically executes::

$ apt-get update && apt-get upgrade

:file:`apt-get update && apt-get –yes –force-yes –fix-missing –auto-remove –allow-unauthenticated –show-upgraded –option DPkg::Options::=“–force-confold” dist-upgrade`
The full command is::

$ apt-get update && apt-get –yes –force-yes –fix-missing –auto-remove –allow-unauthenticated –show-upgraded –option DPkg::Options::=“–force-confold” dist-upgrade

**omv-release-upgrade**
This is a script included only in the last versions of OpenMediaVault before moving to next major release version. For example: 0.5.60 to 1.x or 1.19 to 2.x. The command performs several tasks and modifications depending if the upgrade includes moving to a new base distribution. For example: Debian Squeeze to Wheezy or Wheezy to Jessie,

This is a script included only in the last versions of |omv| before moving to
next major release version. For example: 0.5.60 to 1.x or 1.19 to 2.x. The
command performs several tasks and modifications depending if the upgrade
includes moving to a new base distribution. For example: Debian Squeeze to
Wheezy or Wheezy to Jessie,

Installing plugins
----
The plugins can installed either by repository selecting from the available list or uploading the deb package. If the plugin requires some extra software it will fetch all remaining packages from either Debian mirrors or another repo the plugin specifies.

The plugins can installed either by repository selecting from the available
list or uploading the deb package. If the plugin requires some extra software
it will fetch all remaining packages from either Debian mirrors or another
repo the plugin specifies.

Installing Software
----

You have to your availability all Debian software repository to install in your server
You have to your availability all Debian software repository to install in
your server

**Install**::

$ apt-get install <packagename>

**Remove**::

Install :code:`apt-get install <packagename>`
$ apt-get remove <packagename>

Remove :code:`apt-get remove <packagename>`
**Purge (remove package and configuration files)**::

Purge (remove package and configuration files): :code:`apt-get purge <packagename>`
$ apt-get purge <packagename>

Repositories
----

**Debian**
The OS repositories are in this file ``/etc/apt/sources.list`` The default contents are:

The OS repositories are in this file ``/etc/apt/sources.list``. The default
contents are:

|omv| 2.0 (Wheezy)::

deb http://ftp.us.debian.org/debian wheezy main contrib non-free

deb http://ftp.debian.org/debian/ wheezy-updates main contrib non-free

deb http://security.debian.org/ wheezy/updates main contrib non-free


|omv| 3.0 (Jessie)::

deb http://ftp.us.debian.org/debian jessie main contrib non-free

deb http://ftp.debian.org/debian/ jessie-updates main contrib non-free

deb http://security.debian.org/ jessie/updates main contrib non-free

|omv| 4.0 (Stretch)::

deb http://ftp.us.debian.org/debian stretch main contrib non-free

deb http://ftp.debian.org/debian/ stretch-updates main contrib non-free

deb http://security.debian.org/ stretch/updates main contrib non-free

You should not include any external repositories in this file. If you have problem with the standard repo or a different mirror you selected during install, you can use netselect-apt 1). This software can give you the fastest ten mirrors closest to your location. The you can change the first two lines with the new mirror servers. Security repo does automatic mirroring so don't change it.
You should not include any external repositories in this file. If you have
problem with the standard repo or a different mirror you selected during
install, you can use netselect-apt 1). This software can give you the fastest
ten mirrors closest to your location. The you can change the first two lines
with the new mirror servers. Security repo does automatic mirroring so don't
change it.

**External**

External
Debian provides the :file:`/etc/apt/sources.d/` folder for adding external repositories.
Debian provides the :file:`/etc/apt/sources.d/` folder for adding external
repositories.
6 changes: 3 additions & 3 deletions various/conffiles.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@ Configuration files
=====


The following is the list of file you should not edit by hand. Openmediavault has complete control over these files and any changes will be overwrriten on demand.
The following is the list of file you should not edit by hand. |omv| has complete control over these files and any changes will be overwrriten on demand.

**Filesystem:** :file:`/etc/fstab` This file contains all mount entries, physical and network ones. Openmediavault identifies them by using the «openmediavault» tags, in between those you should not delete entries or change options. Any new mount drive or network entry will rewrite fstab in between those lines, reverting any changes you have done. Please refer here for advanced editing options of fstab.
**Filesystem:** :file:`/etc/fstab` This file contains all mount entries, physical and network ones. |omv| identifies them by using the «openmediavault» tags, in between those you should not delete entries or change options. Any new mount drive or network entry will rewrite fstab in between those lines, reverting any changes you have done. Please refer here for advanced editing options of fstab.

**Network:** :file:`/etc/network/interfaces` The explanation is already in the :doc:`FAQ </FAQ>`

Expand All @@ -22,6 +22,6 @@ The following is the list of file you should not edit by hand. Openmediavault ha

**NFS:** :file:`/etc/exports` Use environmental variables if you want to change the pseudo root filesystem options for NFSv4.

**APT**
**APT**
- :file:`/etc/apt/sources.list` This is default debian repository server file. Read more information here.
- :file:`/etc/apt/sources.list.d/openmediavault.list` This is the server package repository for OMV.
12 changes: 6 additions & 6 deletions various/media.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@ Press releases, reviews and external references
=====

- Dec 2008, FreeNAS: BSD Line and Linux Fork `Linux magazine <http://www.linux-magazine.com/Online/News/FreeNAS-BSD-Line-and-Linux-Fork>`_
- October 2011 "First version of the NAS distribution openmediavault" `pro-linux.de <http://www.pro-linux.de/news/1/17630/erste-version-der-nas-distribution-openmediavault.html|pro-linux.de>`_ (German)
- September 2014, “Community Choice” Project of the Month – OpenMediaVault `Sourceforge <http://sourceforge.net/blog/september-2014-community-choice-project-of-the-month-openmediavault/>`_
- April 2015, Interview OpenMediaVault developer Volker Theile `Canox <http://www.canox.net/2015/04/interview-with-openmediavault-developer-volker-theile/>`_
- October 2011 "First version of the NAS distribution |omv|" `pro-linux.de <http://www.pro-linux.de/news/1/17630/erste-version-der-nas-distribution-openmediavault.html|pro-linux.de>`_ (German)
- September 2014, “Community Choice” Project of the Month – |omv| `Sourceforge <http://sourceforge.net/blog/september-2014-community-choice-project-of-the-month-openmediavault/>`_
- April 2015, Interview |omv| developer Volker Theile `Canox <http://www.canox.net/2015/04/interview-with-openmediavault-developer-volker-theile/>`_
- August 2015 LinuxVoice Magazine issue #9, Distrohopper `LinuxVoice Magazine <https://www.linuxvoice.com/issues/009/distros.pdf>`_
- November 2014, OpenMediaVault Open source network attached storage for Debian/GNU Linux `ODROID Magazine <http://magazine.odroid.com/wp-content/uploads/ODROID-Magazine-201411.pdf#page=30>`_
- November 2014, |omv| Open source network attached storage for Debian/GNU Linux `ODROID Magazine <http://magazine.odroid.com/wp-content/uploads/ODROID-Magazine-201411.pdf#page=30>`_
- January 2014 "How to build your own NAS box" `APC Magazine Australia <http://apcmag.com/how-to-build-your-own-nas-box.htm/>`_
- August 2015 "The open-source NAs distro for media lovers" :download:`ACP Magazine Australia </_static/images/apcmag.jpg>`
- Distribution Release: OpenMediaVault 2.1 `Distrowatch <http://distrowatch.com/?newsid=08998>`_
- September 2014, OpenMediaVault 1.0 review `Linuxbsdos.com <http://linuxbsdos.com/2014/09/17/openmediavault-1-0-review/>`_
- Distribution Release: |omv| 2.1 `Distrowatch <http://distrowatch.com/?newsid=08998>`_
- September 2014, |omv| 1.0 review `Linuxbsdos.com <http://linuxbsdos.com/2014/09/17/openmediavault-1-0-review/>`_

0 comments on commit 20efadb

Please sign in to comment.