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 committed Jan 16, 2018
1 parent 45a3f03 commit 6f6e314
Show file tree
Hide file tree
Showing 7 changed files with 173 additions and 22 deletions.
24 changes: 12 additions & 12 deletions FAQ.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,34 +20,34 @@ 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. Your 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.

What is the file :file:`/etc/openmediavault/config.xml` for?
Is the database configuration store file for |omv|. When a change is performed in the webUI, the config value is stored and/or retrieve by rpc to/from this file. If this is a save change, then mkconf passes the value to the service configuration file and reloads the daemon in case is necessary.
Is the database configuration store file for |omv|. When a change is performed in the |webui|, the config value is stored and/or retrieve by rpc to/from this file. If this is a save change, then mkconf passes the value to the service configuration file and reloads the daemon in case is necessary.

Can I upgrade to Debian Testing/Unstable (Debian Testing/Sid) or use Ubuntu as a base distribution?
Yes you can. But you will end up most likely with a broken web interface and possibly broken system. |omv| releases are heavily tight to their Debian base distro.

I´ve lost the WebInterface password. How do I reset it?
Simply connect via ssh to your server or login locally on your machine and type in: omv-firstaid . There is an option to reset your password. More information about [[openmediavault:features:omv-firstaid|omv-firstaid]]
I´ve lost the |webui| password. How do I reset it?
Simply connect via ssh to your server or login locally on your machine and type in: ``omv-firstaid``. There is an option to reset your password.

Can I backup or restore and existing OpenMediaVaut configuration?
Can I backup or restore and existing |omv| configuration?
No. You can keep the file :file:`/etc/openmediavault/config.xml` for references purposes if you decide 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?
You can use it but is not supported. Eventually every |omv| package upgrade will activate NGINX again leaving you with a broken webUI. You can run a parallel Apache instance to Nginx just make sure the ports are different otherwise your OMV webUI will not work.
You can use it but is not supported. Eventually every |omv| package upgrade will activate NGINX again leaving you with a broken |webui|. You can run a parallel Apache instance to Nginx just make sure the ports are different otherwise your |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. You can place your website configurations at :file:`/etc/nginx/sites-available` and enable it with ``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.

How can I modify an internal value of some service |omv| has control of?
How can I modify an internal value of some service |omv| has control over?
Read :doc:`here <various/advancedsettings>` 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 webGUI or other options not present, you need to use :doc:`advanced settings <various/advancedsettings>`.
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>`.

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 maintaing the mount points. The old linux way (sda1, sdb1, etc) is not guaranteed that /sda1 is the same disk on next reboot. If you have trouble identiying them in terminal, you can always create a pool with symlinks to each file system with easy to remember names.
Expand All @@ -67,8 +67,8 @@ Can I install |omv| on top a running Debian system?
Which are the files that should not be edited by the user?
There are several services that |omv| takes control of, The recommended list is here.

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

Why are my filesystems mounted as noexec?
This is a security measure to avoid the placement of malicious scripts in the shared folders. This will prevent any script execution in those paths, including compiling packages and binaries.
Expand All @@ -79,10 +79,10 @@ I need to delete a shared folder, why the delete button is greyed/disabled?
Shared folder configurations can be used across different services. If you need to remove a shared folder configuration you need to unlink it from every service is attached to it 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 ``omv-mkconf`` command for?
``omv-mkconf`` 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 omv-mkconf accepts are related to the name of the service it configures. Type ``omv-mkconf`` in terminal, press TAB key, and the terminal will display all available arguments.
``omv-mkconf`` 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 ``omv-mkconf`` accepts are related to the name of the service it configures. Type ``omv-mkconf`` 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
As a true open source system you can do whatever you want with it. The recommendation is you don't do it in your home appliance server to avoid breaking the web interface. The best thing to do is to use a Virtual Machine. In `Sourceforge <http://sourceforge.net/projects/openmediavault/files/vm/VirtualBox%20images/>`_ you can find a preconfigured OpenMediaVault virtual disk ready to launch.
As a true open source system you can do whatever you want with it. The recommendation is you don't do it in your home appliance server to avoid breaking the web interface. The best thing to do is to use a Virtual Machine. In `Sourceforge <http://sourceforge.net/projects/openmediavault/files/vm/VirtualBox%20images/>`_ you can find a preconfigured |omv| virtual disk ready to launch.

What is the ``omv-update`` and ``omv-release-upgrade`` do?
Information about those commands are in the update/upgrade section.
1 change: 1 addition & 0 deletions conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,7 @@
rst_epilog = """
.. |omv| replace:: openmediavault
.. |copy| unicode:: 0xA9 .. copyright sign
.. |webui| replace:: WebGUI
"""

# The language for content autogenerated by Sphinx. Refer to documentation
Expand Down
110 changes: 110 additions & 0 deletions contributors.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,110 @@
Contributors
============

Founder and project manager
---------------------------
Volker Theile

Forum
-----
* area3o
* Cpoc
* davidh2k
* Dennis
* donh
* i814u2
* jensk
* jhmiller
* KM0201
* knumsi
* PhantomSens
* ryecoaaron
* SerErris
* Solo0815
* spyalelo
* subzeroin
* SVS
* tekkbebe
* WastlJ
* The Master

Documentation
-------------
* area3o
* Davidh2k
* GreenBean
* i814u2
* Reddy
* witopi

Testing
-------
* Falk Menzel

Translators
-----------
* Alexandr aka azlk (Russian)
* Andrey Chapalda (Ukrainian)
* Antonio Pelaez Redondo (Spanish)
* Babchuk Volodymyr Romanovych (Ukrainian)
* Balajti Ádám (Hungarian)
* Bocquet Stéphane (French)
* Cyryl Sochacki (Polish)
* Gábor Majoros (Hungarian)
* Harry Stoker (Dutch)
* Helge Philipp (German)
* Henrik Sandström (Swedish)
* Jacek Niedziółka (Polish)
* Jakub Górny (Polish)
* Jonathan Weber (German)
* José Manuel Caínzos Sánchez (Spanish)
* Kochin Chang (Chinese (Taiwan))
* Kostas Gounaris (Greek)
* Marcel Beck (German)
* Mario Varelli (Italian)
* Mathias Grünewald (German)
* Mauro Rulli (Italian)
* Miguel Anxo Bouzada (Galician)
* Milan Toet (Dutch)
* Ming Song (Chinese)
* Nahir Mohamed (French)
* Nelson Rosado (Portuguese)
* Paolo Velati (Italian)
* Raul Fernandez Garcia (Spanish)
* Rune Bystrøm (Norwegian)
* Seba Kerckhof (Dutch)
* Serhat SUT (Turkish)
* Stefan Thrane Overby (Danish)
* Stephan Steiner (German)
* Szanyi Szabolcs (Hungarian)
* Tim Debie (Dutch)
* Tobias Brechle (German)
* Toshihiro Kan (Japanese)
* Volker Theile (German)
* Wei Ding (Chinese)
* Александр Владимирович Савченко (Russian)
* артур Мудрых (Russian)
* Дмитрий Французенок (Russian)
* Maliar Benoit (French)
* Ji-Hyeon Gim (Korean)
* Sergio Rius Rodriguez (Spanish/Portuguese)
* Chang-Eon Byeon (Korean)
* Jan Štourač (Czech)
* Sungjin Kang (Korean)
* Pavel Borecki (Czech)
* Joaquim Farriol (Catalan)
* Plamen Vasilev (Bulgarian)
* Gábor Sári (Hungarian)
* Jonatan Nyberg (Swedish)
* Gyuris Gellért (Hungarian)
* Miha Bezjak (Slovenian)

Code
----
* Stefan Seidel
* Don Harpell
* Ralf Lindlein
* Tony Guepin
* Ian Grant

More code contributers can be found `here <https://github.com/openmediavault/openmediavault/graphs/contributors>`_.
3 changes: 2 additions & 1 deletion index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,13 +24,14 @@ plugins are available via the `OMV-Extras repository <http://omv-extras.org/>`_.
:maxdepth: 2
:caption: Contents:

copyright
prerequisites
installation/index
releases
plugins
support
FAQ
contributors
copyright



Expand Down
19 changes: 19 additions & 0 deletions plugins.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,25 @@
Plugins
=======

You can add more features & apps by simply selecting the software you need, we
call this plugins. Plugins are possible due to the modular design of |omv| and
are the prefered way to extend your NAS. Its still possible install regular
sofware or containerized software like Docker. Plugins only exist for your
convenience.

Benefits
--------

Compared to adding regular software, plugins offer the following benefits:

* Easier to install - You just click on what you want.
* Easier to configure - its often preconfigured so you don't have to.
* Automatic updates - ensure Stability & Security.
* A Webinterface - is added when needed for your ease of use.

Overview
--------

The following is the list of official plugins by |omv|.

* **ClamAV**: Provides antivirus scan for folders
Expand Down
29 changes: 24 additions & 5 deletions support.rst
Original file line number Diff line number Diff line change
@@ -1,16 +1,35 @@
Support
=======

At present there are two ways of getting support, both of them are done by the
At present there are many ways of getting support, many of them are done by the
community. The current support channels are:

|omv| `forums <http://forums.openmediavault.org/>`_.
Forum
-----
`<https://forum.openmediavault.org/>`_

There is also the official IRC channel more info :doc:`here <various/irc>`
Bugtracker
----------
`<http://bugtracker.openmediavault.org>`_

IRC
---
There is also the official IRC channel, more info :doc:`here <various/irc>`

Facebook
--------
`<https://www.facebook.com/openmediavault>`_

Twitter
-------
`<https://twitter.com/OpenMediaVault>`_

Discord
-------
Since last year there is also a discord group. You can get access by clicking
`here <https://discord.gg/ZjknBdg>`_.

Make sure you provide as much information as you can when posting in the forum
and describing your problem. If you have an error in the webUI make sure you
take screenshots of the backtrace, to identify properly what's failing.
or bugtracker and describing your problem. If you have an error in the |webui|
make sure you take screenshots of the backtrace, to identify properly what's
failing.
9 changes: 5 additions & 4 deletions various/irc.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
IRC Channel
========
IRC channel
===========

.. _irc:


We have a support IRC channel at freenode servers, just type :file:`/join #openmediavault` in your favourite IRC client, type your question and wait for someone available to help you.
We have a support IRC channel at freenode servers, just type ``/join #openmediavault``
in your favourite IRC client, type your question and wait for someone available
to help you.

0 comments on commit 6f6e314

Please sign in to comment.