Improving app management: script for moving apps to an alternative location #4276

voroyam · 2018-07-12T11:26:44Z

added a script for moving apps in a apps2 directory to keep owncloud installation clean.

admin_manual/installation/apps_management_installation.rst

voroyam · 2018-07-12T12:23:21Z

Great, thanks @tboerger

tboerger

Code looks good to me

mmattel · 2018-07-12T13:39:02Z

I have a lot of improvements, I will do a commit which is easier...

mmattel · 2018-07-12T14:20:47Z

@voroyam @tboerger pls have a look

admin_manual/installation/apps_management_installation.rst

mmattel · 2018-07-13T09:50:11Z

@tboerger
I did a check if all apps are identified properly, pls see the result. To test, I did this on my instance where I strictly differenciate between apps and apps-external and a fresh extract of the owncloud tar file of 10.0.8 into a newly created folder. The content of the apps/ folder is in both cases identical =ok. (ll = unix list)

The physical content of the /apps and /apps-external folder and the listing of the occ command for (non)shipped apps does not match
This means that the script is doing its work but the result is not that what we want because occ does not give the correct response !

These are the apps how they are currently identified as of 10.0.8

ll apps/	occ app:list --shipped=true	ll apps-external/	occ app:list --shipped=false
		activity	activity
comments			comments
configreport	configreport
dav	dav
encryption	encryption
external			external
federatedfilesharing	federatedfilesharing
federation	federation
files	files
files_external	files_external
files_sharing	files_sharing
files_trashbin	files_trashbin
files_versions	files_versions
files_videoplayer			files_videoplayer
firstrunwizard			firstrunwizard
market			market
notifications			notifications
provisioning_api	provisioning_api
systemtags			systemtags
theme-example			theme-example
updatenotification	updatenotification
user_external			user_external
		files_clipboard	files_clipboard
		files_external_dropbox	files_external_dropbox
		files_external_ftp	files_external_ftp
		files_pdfviewer	files_pdfviewer
		files_texteditor	files_texteditor
		gallery	gallery
		guests	guests
		music	music
		templateeditor	templateeditor

For the record, my present but disabled app are:

external
theme-example
user_external
encryption

No pattern match to the table above.

Before this PR gets merged, more work needs to be done

@PVince81 this might interest you too...

mmattel · 2018-07-13T13:32:07Z

lib/private/App/AppManager.php#L401

private function loadShippedJson() {
		if ($this->shippedApps === null) {
			$shippedJson = \OC::$SERVERROOT . '/core/shipped.json';

core/shipped.json

{
  "shippedApps": [
    "configreport",
    "dav",
    "federation",
    "federatedfilesharing",
    "files",
    "files_external",
    "files_sharing",
    "files_trashbin",
    "files_versions",
    "provisioning_api",
    "updatenotification"
  ],
  "alwaysEnabled": [
    "files",
    "files_external",
    "dav",
    "federatedfilesharing"
  ]
}

This leads to the point that some apps are delivered by the tar file but not marked as shipped...
For me, either those apps have to be marked as shipped or a process has to be setup when you install the system to check if the apps in question are already present (like in an upgrade) or a suggestion should be made to download them via the marketplace.

Anyway - not a good situation 👎

PVince81 · 2018-07-18T13:16:17Z

Should this rather be an occ command ? occ apps:move, especially considering that OC is already aware of all app repos, versions, etc so more error checking can be put in there

mmattel · 2018-07-18T13:42:45Z

@PVince81

👍 I LIKE IT 👍

At the end of the day, you will suffer on the same things as described here and in the referenced core issue. This has to be fixed first.
Nontheless having an occ command for this is the way to go !

occ maintenance:mode --on
occ apps:move
occ maintenance:mode --off

settermjd · 2018-07-30T11:39:34Z

admin_manual/installation/apps_management_installation.rst

@@ -71,17 +71,60 @@ The configuration example below shows how to add a second directory, called ``ap
   :emphasize-lines: 9-13

 After you add a new directory configuration, you can then move apps from the original app directory to the new one. 
-To do so, follow these steps:
+If you want to identify as an example all non core / non shipped apps, use the following command:


I suggest the following to aid in clarity of intent:

If you want to identify, as an example, all non-core or non-shipped apps, use the following command:

settermjd · 2018-07-30T11:43:34Z

admin_manual/installation/apps_management_installation.rst

+
+::
+
+  sudo -uwww-data ./occ app:list --shipped=false


The standard documentation convention is sudo -u www-data php occ.

settermjd · 2018-07-30T11:44:22Z

admin_manual/installation/apps_management_installation.rst


 #. :ref:`Enable maintenance mode <maintenance_commands_label>`.
 #. :ref:`Disable the apps <apps_commands_label>` that you want to move.
-#. Create a new apps directory and assign it the same user and group, and ownership permissions as the core apps directory.
+#. Create a new apps directory like ``apps-external`` and assign it the same user, group and ownership permissions as the core apps directory.


s/Create a new apps directory like apps-external and/Create a new apps directory, like apps-external, and/g

settermjd · 2018-07-30T11:46:37Z

admin_manual/installation/apps_management_installation.rst

 #. Move the apps from the old apps directory to the new apps directory.
-#. Add a new app directory in ``config/config.php``.
+#. Add the key for the new app directory in ``config/config.php``.
+#. If you're using a cache, such as `Redis <../configuration/server/caching_configuration.html#clearing-the-redis-cache>`_ or `Memcached <../configuration/server/caching_configuration.html#clearing-the-memcached-cache>`_, ensure that you clear the cache.


The docs convention is to store page links at the bottom of the page, as it makes editing easier. For example:

#. If you're using a cache, such as `Redis`_ or `Memcached`_, ensure that you clear the cache. ... rest of the document... .. Links .. _Redis: ../configuration/server/caching_configuration.html#clearing-the-redis-cache .. _Memcached: ../configuration/server/caching_configuration.html#clearing-the-memcached-cache

settermjd · 2018-07-30T11:48:08Z

admin_manual/installation/apps_management_installation.rst

+Script for moving non core apps in custom app directories
+---------------------------------------------------------
+
+In the same way as you can manually move eg non core / non shipped apps to a custom directory, a script


I suggest the following, for increased clarity:

In the same way as you can manually move apps, e.g., non-core or non-shipped, to a custom directory, a script

settermjd · 2018-07-30T11:49:34Z

admin_manual/installation/apps_management_installation.rst

 #. If you're using a cache, such as `Redis <../configuration/server/caching_configuration.html#clearing-the-redis-cache>`_ or `Memcached <../configuration/server/caching_configuration.html#clearing-the-memcached-cache>`_, ensure that you clear the cache.
 #. Re-enable the apps.
 #. Disable maintenance mode.

+As preparation, please install the ``jq`` library. 


s/As preparation/In preparation/g

Secondly, please link jq instead of marking it up as code.

Don't know how to link jq.

I doubt that this is my work here.

settermjd · 2018-07-30T11:51:35Z

admin_manual/installation/apps_management_installation.rst

 #. If you're using a cache, such as `Redis <../configuration/server/caching_configuration.html#clearing-the-redis-cache>`_ or `Memcached <../configuration/server/caching_configuration.html#clearing-the-memcached-cache>`_, ensure that you clear the cache.
 #. Re-enable the apps.
 #. Disable maintenance mode.

+As preparation, please install the ``jq`` library. 
+``jq`` is like sed for JSON data - you can use it to slice, filter, map and transform structured data.


s/jq is like/jq is like/g. As jq's already been introduced, there's no need to draw special attention to it.

settermjd

Just a few changes. Otherwise, thanks for creating the PR. Much appreciated.

suggestions implementation

#29807 documents that moving apps from the core to a non-core apps folder manually can cause issues. Given that and the discussion in owncloud-archive/documentation#4276, I decided to start writing an app:move command, to make moving apps from the core apps directory, to a custom non-core apps directory simpler and less messy. When finished, the command will be able to: - List apps that can be moved - List any non-core app directories - Check that non-core app directories exist - Move one or more apps from the core apps directory to a non-core apps directory The other reason for doing this is to better familiarise myself with ownCloud's internals — something that, for quite some time, I've felt I've been lacking, and that has been hindering me from doing my work better.

voroyam · 2018-09-13T09:26:58Z

Is there any update on this?

mmattel · 2018-09-13T12:40:19Z

No, there is no update, not because of coding the script, but because there is a situation where it is currently not 100% identifyable what are admin downloaded apps and which belong to owncloud.
See my comment #4276 (comment) and the following one.

This change ports owncloud-archive/documentation#4276 to the docs repository.

settermjd · 2019-02-05T20:05:09Z

Closing as it's been ported to the new docs.

This change ports owncloud-archive/documentation#4276 to the docs repository.

script for moving scripts

dc856ef

added a script for moving apps in a apps2 directory to keep owncloud installation clean.

voroyam requested review from tboerger, settermjd and mmattel July 12, 2018 11:28

tboerger reviewed Jul 12, 2018

View reviewed changes

admin_manual/installation/apps_management_installation.rst Outdated Show resolved Hide resolved

include disabled apps

a12f440

tboerger previously approved these changes Jul 12, 2018

View reviewed changes

Updated content

ae80607

mmattel dismissed tboerger’s stale review via ae80607 July 12, 2018 14:18

voroyam commented Jul 12, 2018

View reviewed changes

admin_manual/installation/apps_management_installation.rst Outdated Show resolved Hide resolved

mmattel changed the title ~~script for moving scripts~~ Improving app management: script for moving apps to an alternative location Jul 13, 2018

mmattel mentioned this pull request Jul 13, 2018

Apps: shipped - nonshipped identification mismatch owncloud/core#32048

Open

settermjd reviewed Jul 30, 2018

View reviewed changes

settermjd suggested changes Jul 30, 2018

View reviewed changes

settermjd added the WIP label Jul 30, 2018

voroyam added 2 commits August 16, 2018 12:00

fixes

c4c1036

suggestions implementation

jq rst link

ec288fd

settermjd mentioned this pull request Aug 17, 2018

Create an app:move command owncloud/core#32368

Closed

10 tasks

settermjd added a commit to owncloud/docs that referenced this pull request Feb 5, 2019

Port documentation #4276 to the docs repository

13fa031

This change ports owncloud-archive/documentation#4276 to the docs repository.

settermjd mentioned this pull request Feb 5, 2019

Port documentation #4276 to the docs repository owncloud/docs#582

Closed

settermjd closed this Feb 5, 2019

settermjd deleted the apps-move-script branch February 5, 2019 20:05

settermjd added a commit to owncloud/docs that referenced this pull request Feb 5, 2019

Port documentation #4276 to the docs repository

9819e63

This change ports owncloud-archive/documentation#4276 to the docs repository.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Improving app management: script for moving apps to an alternative location #4276

Improving app management: script for moving apps to an alternative location #4276

voroyam commented Jul 12, 2018

voroyam commented Jul 12, 2018

tboerger left a comment

mmattel commented Jul 12, 2018 •

edited

Loading

mmattel commented Jul 12, 2018

mmattel commented Jul 13, 2018

mmattel commented Jul 13, 2018

PVince81 commented Jul 18, 2018

mmattel commented Jul 18, 2018 •

edited

Loading

settermjd Jul 30, 2018 •

edited

Loading

settermjd Jul 30, 2018

settermjd Jul 30, 2018

settermjd Jul 30, 2018 •

edited

Loading

settermjd Jul 30, 2018

settermjd Jul 30, 2018

voroyam Aug 16, 2018

settermjd Jul 30, 2018

settermjd left a comment

voroyam commented Sep 13, 2018

mmattel commented Sep 13, 2018

settermjd commented Feb 5, 2019

Improving app management: script for moving apps to an alternative location #4276

Improving app management: script for moving apps to an alternative location #4276

Conversation

voroyam commented Jul 12, 2018

voroyam commented Jul 12, 2018

tboerger left a comment

Choose a reason for hiding this comment

mmattel commented Jul 12, 2018 • edited Loading

mmattel commented Jul 12, 2018

mmattel commented Jul 13, 2018

mmattel commented Jul 13, 2018

PVince81 commented Jul 18, 2018

mmattel commented Jul 18, 2018 • edited Loading

settermjd Jul 30, 2018 • edited Loading

Choose a reason for hiding this comment

settermjd Jul 30, 2018

Choose a reason for hiding this comment

settermjd Jul 30, 2018

Choose a reason for hiding this comment

settermjd Jul 30, 2018 • edited Loading

Choose a reason for hiding this comment

settermjd Jul 30, 2018

Choose a reason for hiding this comment

settermjd Jul 30, 2018

Choose a reason for hiding this comment

voroyam Aug 16, 2018

Choose a reason for hiding this comment

settermjd Jul 30, 2018

Choose a reason for hiding this comment

settermjd left a comment

Choose a reason for hiding this comment

voroyam commented Sep 13, 2018

mmattel commented Sep 13, 2018

settermjd commented Feb 5, 2019

mmattel commented Jul 12, 2018 •

edited

Loading

mmattel commented Jul 18, 2018 •

edited

Loading

settermjd Jul 30, 2018 •

edited

Loading

settermjd Jul 30, 2018 •

edited

Loading