Skip to content
This repository has been archived by the owner on Feb 20, 2019. It is now read-only.

Better document how to use custom app directories and how to move apps between directories #3643

Merged
merged 3 commits into from
Dec 20, 2017

Conversation

settermjd
Copy link
Contributor

This PR, as the description says, updates the custom app directories documentation. It's on hold, owing to a bug identified in owncloud/core#29917 and owncloud/core#29807.

References

#3261.

"writable" => true,
),
),
If you want to store apps in a custom directory, instead of ownCloud’s default (``/app``), you need to modify the ``apps_paths`` element in ``config/config.php``.
Copy link
Contributor

@mmattel mmattel Dec 20, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would add the reason why such an approach is a good idea, text as an example.

  1. You separate core apps from user/admin downloaded apps to ease distinguishing
  2. Core apps are downloaded by core preferrable to the apps folder
  3. Core may add new core related apps which are managed or downloaded during the installation process. Apps not used by core anymore may stay then as orphans in the apps folder when you upgrade
  4. When you upgrade the instance and extract the new code into an empty folder, copying/aliasing the data folder, the config.php file ect (for details see upgrading...) you will also need to copy all manually downloaded apps. Having those in an separate directory eases the process of doing so because you then just need to take care on that folder.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Well said.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mmattel, what do you mean by: "Core apps are downloaded by core preferrable to the apps folder"?

These are:

- ``path``: The absolute file system path to the custom app folder.
- ``url``: The request path to that folder relative to the ownCloud web root.
Copy link
Contributor

@mmattel mmattel Dec 20, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Text add:
Please use a mandatory / on front of the url

To do so, follow these steps:

#. Enable maintenance mode
#. Disable the apps that you want to move
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

#. Create a new directory and assign the same rights and owncership as the apps folder to it

Move the apps from the old to a new --> the new apps directory

@settermjd settermjd force-pushed the describe-moving-apps-to-different-app-folder branch from de000c3 to 72a64d3 Compare December 20, 2017 11:04
@settermjd
Copy link
Contributor Author

@mmattel, updates have been made to include your feedback. Can you review pls?

#. Move the apps from the old apps directory to the new apps directory.
#. Add a new app directory in ``config/config.php``.
#. Re-enable the apps.
#. Disable maintenance mode.

Manually Installing Apps
------------------------

To install an app manually (locally), instead of by using the Appstore, copy the app into the ownCloud app folder (``/path/to/owncloud/apps``).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Missed that one before 😃

...into the ownCloud app or custom app folder...
or appropriate app folder, something like that

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It seems fine to me as is, honestly.

The folder name of the app and the name of the app **must be identical**.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Where do you get the proper app name so you can create the right folder?
Please mention rights/permissions ect things...

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated in 29163fc.

@mmattel
Copy link
Contributor

mmattel commented Dec 20, 2017

Just added 2 improvement requests, then it is fine to me 👍

This commit replaces the Appstore reference with a link to the 
Marketplace, links to relevant sections of the documentation, and 
provides an XML snippet of an appinfo/info.xml file, to help the docs
be more meaningful.

Signed-off-by: Matthew Setter <matthew@matthewsetter.com>
Copy link
Contributor

@mmattel mmattel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

GREAT ! 😃

@settermjd
Copy link
Contributor Author

Thanks!

@settermjd settermjd merged commit 7723322 into master Dec 20, 2017
@settermjd settermjd deleted the describe-moving-apps-to-different-app-folder branch December 20, 2017 13:05
@mmattel
Copy link
Contributor

mmattel commented Dec 20, 2017

@settermjd Many thanks for writing this!

@settermjd
Copy link
Contributor Author

More than happy to. Thanks for all your help.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants