Merge pull request #45 from j-ed/master

added description of the apps specific configuration settings.
This commit is contained in:
Lukas Reschke
2013-02-05 08:42:24 -08:00
3 changed files with 91 additions and 0 deletions

View File

@@ -0,0 +1,17 @@
3rd-Party Configuration
=======================
ownCloud resorts to some 3rd-party PHP components to provide its functionality.
These components are part of the software package and are usually shipped in
the ``/3rdparty`` folder.
Parameters
----------
If you want to change the default location of the 3rd-party folder for some
reason you can use the ``3rdpartyroot`` parameter to define the absolute file
system path to the folder. The ``3rdpartyurl`` parameter is used to define the
http web path to that folder, starting at the ownCloud web root.
::
"3rdpartyroot" => OC::$SERVERROOT."/3rdparty",
"3rdpartyurl" => "/3rdparty",

View File

@@ -0,0 +1,52 @@
Apps Configuration
==================
After you have installed ownCloud you might realise that it would be nice to
provide this or that function on top of the core functionality in your own cloud.
The first stop to look for the desired enhancement is to check out the ownCloud
apps store (http://apps.owncloud.com/). There you will find a lot of ready-to-use
apps provided by the ownCloud community.
Parameters
----------
If you want to allow the installation of apps from the apps store you have to
set ``appstoreenabled`` parameter, but this can only be done if at least one
of the configured apps paths is writeable.
::
"appstoreenabled" => true,
The ``appstoreurl`` is used to set the http path to the ownCloud apps store.
(The server should understand OCS (Open Collaboration Services).
::
"appstoreurl" => "http://api.apps.owncloud.com/v1",
Use the ``apps_paths`` array to set the apps folders which should be scanned
for available apps and/or where user specific apps should be installed.The key
``path`` defines the absolute file system path to the app folder. The key
``url`` defines the http web path to that folder, starting at the ownCloud
web root. The key ``writable`` indicates if a user can install apps in that
folder.
**Hint:**
If you want to make sure that the default ``/apps`` folder only contains apps
shipped with ownCloud, you should follow the example and set-up a ``/apps2``
folder which will be used to store all apps downloaded by users.
::
"apps_paths" => array (
0 => array (
"path" => OC::$SERVERROOT."/apps",
"url" => "/apps",
"writable" => false,
),
1 => array (
"path" => OC::$SERVERROOT."/apps2",
"url" => "/apps2",
"writable" => true,
),
),
Finally you can enable checks for malicious code fragments of 3rd-party apps
by setting the ``appcodechecker`` parameter.
::
"appcodechecker" => false,

View File

@@ -0,0 +1,22 @@
Knowledge Base Configuration
============================
The usage of ownCloud is more or less self explaining but nevertheless a user
might run into a problem where he needs to consult the documentation or knowledge
base. To ease access to the ownCloud documentation and knowledge base, a help menu
item is shown in the settings menu by default.
Parameters
----------
If you want to disable the ownCloud help menu item for some reason you can use
the ``knowledgebaseenabled`` parameter. The ``knowledgebaseurl`` parameter is used
to set the http path to the ownCloud help page. (The server should understand OCS
(Open Collaboration Services).
**Hint:**
Keep in mind that disabling the help menu item might increase the number of
support request you have to answer in the future.
::
"knowledgebaseenabled" => true,
"knowledgebaseurl" => "http://api.apps.owncloud.com/v1",