From b36801104dd9e76bdc5a2a269d3e073cb88f2a5e Mon Sep 17 00:00:00 2001 From: j-ed Date: Sat, 2 Feb 2013 07:51:38 -0800 Subject: [PATCH 1/9] Create configuration_apps.rst added description of apps configuration settings. --- admin_manual/configuration_apps.rst | 40 +++++++++++++++++++++++++++++ 1 file changed, 40 insertions(+) create mode 100644 admin_manual/configuration_apps.rst diff --git a/admin_manual/configuration_apps.rst b/admin_manual/configuration_apps.rst new file mode 100644 index 000000000..d285d6950 --- /dev/null +++ b/admin_manual/configuration_apps.rst @@ -0,0 +1,40 @@ +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 the ownCloud app +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 app 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 app store. + (The server should understand OCS (Open Collaboration Services). + :: + "appstoreurl" => "http://api.apps.owncloud.com/v1", + + 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. + :: + "apps_paths" => array ( + 0 => array ( + "path" => "/var/www/htdocs/owncloud/apps", + "url" => "/apps", + "writable" => true, + ), + ), + + Finally you can enable checks for malicious code fragments of 3rd-party apps + by setting ``appcodechecker`` parameter. + :: + "appcodechecker" => false, From 881266292dd3d9f8570e3a34469ad5ab438dddc8 Mon Sep 17 00:00:00 2001 From: j-ed Date: Sat, 2 Feb 2013 17:05:05 +0100 Subject: [PATCH 2/9] Update admin_manual/configuration_apps.rst --- admin_manual/configuration_apps.rst | 54 +++++++++++++++-------------- 1 file changed, 28 insertions(+), 26 deletions(-) diff --git a/admin_manual/configuration_apps.rst b/admin_manual/configuration_apps.rst index d285d6950..244e7f119 100644 --- a/admin_manual/configuration_apps.rst +++ b/admin_manual/configuration_apps.rst @@ -3,38 +3,40 @@ 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 the ownCloud app -store (http://apps.owncloud.com/). There you will find a lot of ready-to-use +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 app store you have to - set ``appstoreenabled`` parameter, but this can only be done if at least one - of the configured apps paths is writeable. - :: +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 app store. - (The server should understand OCS (Open Collaboration Services). - :: - "appstoreurl" => "http://api.apps.owncloud.com/v1", +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", - 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. - :: - "apps_paths" => array ( - 0 => array ( - "path" => "/var/www/htdocs/owncloud/apps", - "url" => "/apps", - "writable" => true, - ), - ), +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. +:: + "apps_paths" => array ( + 0 => array ( + "path" => "/var/www/owncloud/apps", + "url" => "/apps", + "writable" => true, + ), + ), - Finally you can enable checks for malicious code fragments of 3rd-party apps - by setting ``appcodechecker`` parameter. - :: - "appcodechecker" => false, +Finally you can enable checks for malicious code fragments of 3rd-party apps +by setting the ``appcodechecker`` parameter. +:: + "appcodechecker" => false, From 11cd131697123e47133eea23489bb2d03314bf0c Mon Sep 17 00:00:00 2001 From: j-ed Date: Sun, 3 Feb 2013 11:13:03 +0100 Subject: [PATCH 3/9] Update admin_manual/configuration_apps.rst applied recommended changes how the apps path should be set. --- admin_manual/configuration_apps.rst | 17 +++++++++++------ 1 file changed, 11 insertions(+), 6 deletions(-) diff --git a/admin_manual/configuration_apps.rst b/admin_manual/configuration_apps.rst index 244e7f119..2b6c9da3e 100644 --- a/admin_manual/configuration_apps.rst +++ b/admin_manual/configuration_apps.rst @@ -29,12 +29,17 @@ web root. The key ``writable`` indicates if a user can install apps in that folder. :: "apps_paths" => array ( - 0 => array ( - "path" => "/var/www/owncloud/apps", - "url" => "/apps", - "writable" => true, - ), - ), + 0 => array ( + "path" => OC::$SERVERROOT."/apps", + "url" => "/apps", + "writable" => true, + ), + 1 => array ( + "path" => OC::$SERVERROOT."/apps2", + "url" => "/apps2", + "writable" => false, + ), + ), Finally you can enable checks for malicious code fragments of 3rd-party apps by setting the ``appcodechecker`` parameter. From ec73aa7deb347b914c2b2091d657633b6f30d778 Mon Sep 17 00:00:00 2001 From: j-ed Date: Sun, 3 Feb 2013 13:10:12 +0100 Subject: [PATCH 4/9] Update admin_manual/configuration_apps.rst changed writable status and added hint to separate shipped and downloaded apps. --- admin_manual/configuration_apps.rst | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/admin_manual/configuration_apps.rst b/admin_manual/configuration_apps.rst index 2b6c9da3e..1d7bffc30 100644 --- a/admin_manual/configuration_apps.rst +++ b/admin_manual/configuration_apps.rst @@ -27,17 +27,22 @@ for available apps and/or where user specific apps should be installed.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" => true, + "writable" => false, ), 1 => array ( "path" => OC::$SERVERROOT."/apps2", "url" => "/apps2", - "writable" => false, + "writable" => true, ), ), From fafdddd2d28e3577bcdbb3478c8bdfb10771632e Mon Sep 17 00:00:00 2001 From: j-ed Date: Sun, 3 Feb 2013 05:13:45 -0800 Subject: [PATCH 5/9] Create configuration_3rdparty.rst added a description of the 3rd-party settings. --- admin_manual/configuration_3rdparty.rst | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 admin_manual/configuration_3rdparty.rst diff --git a/admin_manual/configuration_3rdparty.rst b/admin_manual/configuration_3rdparty.rst new file mode 100644 index 000000000..abd41e281 --- /dev/null +++ b/admin_manual/configuration_3rdparty.rst @@ -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 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", From 8f886b2a22d4c426bd7e76cdb54e42cb61ff6436 Mon Sep 17 00:00:00 2001 From: j-ed Date: Sun, 3 Feb 2013 14:17:05 +0100 Subject: [PATCH 6/9] Update admin_manual/configuration_3rdparty.rst fixed a typo. --- admin_manual/configuration_3rdparty.rst | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/admin_manual/configuration_3rdparty.rst b/admin_manual/configuration_3rdparty.rst index abd41e281..98b3e1733 100644 --- a/admin_manual/configuration_3rdparty.rst +++ b/admin_manual/configuration_3rdparty.rst @@ -8,10 +8,10 @@ the ``/3rdparty`` folder. Parameters ---------- -If you want to change the 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. +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", + "3rdpartyroot" => OC::$SERVERROOT.'/3rdparty', + "3rdpartyurl" => "/3rdparty", From 1c9807a8836030d026fe799890d4dafa05b44d91 Mon Sep 17 00:00:00 2001 From: j-ed Date: Sun, 3 Feb 2013 14:17:50 +0100 Subject: [PATCH 7/9] Update admin_manual/configuration_3rdparty.rst changed quotes. --- admin_manual/configuration_3rdparty.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/admin_manual/configuration_3rdparty.rst b/admin_manual/configuration_3rdparty.rst index 98b3e1733..b5e4e38f1 100644 --- a/admin_manual/configuration_3rdparty.rst +++ b/admin_manual/configuration_3rdparty.rst @@ -13,5 +13,5 @@ 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', + "3rdpartyroot" => OC::$SERVERROOT."/3rdparty", "3rdpartyurl" => "/3rdparty", From df904e6aa94a1f1c27a2fca68a2637d521fe0974 Mon Sep 17 00:00:00 2001 From: j-ed Date: Sun, 3 Feb 2013 05:45:41 -0800 Subject: [PATCH 8/9] Create configuration_knowledgebase.rst added description of the knowledge base settings. --- admin_manual/configuration_knowledgebase.rst | 22 ++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 admin_manual/configuration_knowledgebase.rst diff --git a/admin_manual/configuration_knowledgebase.rst b/admin_manual/configuration_knowledgebase.rst new file mode 100644 index 000000000..91be78858 --- /dev/null +++ b/admin_manual/configuration_knowledgebase.rst @@ -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`` 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. +:: + "knowledgebaseenabled" => true, + "knowledgebaseurl" => "http://api.apps.owncloud.com/v1", From 3306bd9e51ca380b6d02f774512a4884ed5cc76a Mon Sep 17 00:00:00 2001 From: j-ed Date: Sun, 3 Feb 2013 14:48:03 +0100 Subject: [PATCH 9/9] Update admin_manual/configuration_knowledgebase.rst applied smaller fixes. --- admin_manual/configuration_knowledgebase.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/admin_manual/configuration_knowledgebase.rst b/admin_manual/configuration_knowledgebase.rst index 91be78858..5db266846 100644 --- a/admin_manual/configuration_knowledgebase.rst +++ b/admin_manual/configuration_knowledgebase.rst @@ -10,13 +10,13 @@ Parameters ---------- If you want to disable the ownCloud help menu item for some reason you can use -the ``knowledgebaseenabled`` parameter. The ``knowledgebaseurl`` is used to set -the http path to the ownCloud help page. (The server should understand OCS +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. +support request you have to answer in the future. :: "knowledgebaseenabled" => true, "knowledgebaseurl" => "http://api.apps.owncloud.com/v1",