Update the description for proper updating the instance #2046
Conversation
| @@ -175,3 +175,7 @@ and files: | |||
| * The :file:`data/.htaccess` file should be owned by ``root:[HTTP group]`` | |||
| * Both :file:`.htaccess` files are read-write file owner, read-only group and | |||
| world | |||
|
|
|||
| In case you want to update your installation via the GUI or the occ-command, | |||
There was a problem hiding this comment.
s/In case you/If you/
In English we don't often use sentences starting with "In case you..." - it tends to be used in relation to events that are unexpected or unlikely, "In case you are stuck in town you can stay at my house".
|
@phil-davis thanks a lot for your support, I really appreciate it ! 👍 |
| @@ -175,3 +175,7 @@ and files: | |||
| * The :file:`data/.htaccess` file should be owned by ``root:[HTTP group]`` | |||
| * Both :file:`.htaccess` files are read-write file owner, read-only group and | |||
| world | |||
|
|
|||
| If you want to update your installation via the GUI or the occ-command, | |||
| check **Setting Strong Directory Permissions** in the Update section. | |||
There was a problem hiding this comment.
check **Setting Strong Permissions** in the section of :doc:`../maintenance/update`.That would translate to
check <strong>Setting Strong Permissions</strong> in the section of <a class="reference internal" href="../maintenance/update.html"><em>Upgrading ownCloud with the Updater App</em></a>.Which helps a bit better I guess?
|
@carlaschroder an additional question: if I would like to add a clickable link in the installation_wizard.rst to update.rst (especially to the strong permissions section), how can I do that? |
|
@mmattel I posted the code for that ;) |
|
🙊 just have seen that (did not read the whole line).... I redo my question in a more generic way: how are document links principly made in .rst documents? |
|
@mmattel Instead of :doc: i would suggest using labels like in https://raw.githubusercontent.com/owncloud/documentation/master/admin_manual/issues/general_troubleshooting.rst Unfortunately i'm not using the updater app so can't give feedback to the changes itself. |
|
Done |
| * The :file:`data/` directory should be owned by ``[HTTP user]:[HTTP group]`` | ||
| * The :file:`[ocpath]/.htaccess` file should be owned by ``root:[HTTP group]`` | ||
| * The :file:`data/.htaccess` file should be owned by ``root:[HTTP group]`` | ||
| * Both :file:`.htaccess` files are read-write file owner, read-only group and | ||
| world | ||
|
|
||
| If you want to update your installation via the GUI or the occ-command, | ||
| check :ref:`setting_strong_permissions` in the Update section. |
There was a problem hiding this comment.
There isn't an Update section, so you should remove 'in the Update section'. The ref automatically prints the section title, 'Setting Strong Permissions'.
There was a problem hiding this comment.
We do have the following, please correct me if I am wrong:
Setting Strong Directory Permissions
in: admin_manual/installation/installation_wizard.rst
and
Setting Strong Permissions
in: admin_manual/maintenance/update.rst
I want to notify the reader of the installation_wizard.rst that he should consider reading the update document, the correspronding section for permissions, when updating/upgrading his instance.
BTW: I find it a bit confusing having twice more or less same title. But I do not know where/if the target refrence link is used elsewhere, so I refused to change its name to a better reading one...
I would suggest changing in the updater document the link_name
.. _setting_strong_permissions: to .. _setting_permissions_for_updating:
and the heading text
Setting Strong Permissions to Setting Permissions for Updating
and then reference accordingly.
Please advise
There was a problem hiding this comment.
Setting Strong Permissions in admin_manual/maintenance/update.rst is just a cross-reference to https://doc.owncloud.org/server/9.0/admin_manual/installation/installation_wizard.html#setting-strong-directory-permissions. The strong permissions are the same no matter what you're doing, whether it's a new installation or an upgrade.
|
Allrightythen, I didn't set up an update to test the scripts, but I did run the scripts and they appear to work. @mmattel See my inline comments. Also, wrap your comment lines shorter. Thanks for writing this up; it's a lot of work and it should help our users. |
| # If the script from the Installation Wizard section: | ||
| # "Setting Strong Directory Permissions" has been used, you do not need to reset | ||
| # the permissions on /apps, /config, /data and /themes | ||
| # as they already should be correct (${htuser}:${htgroup}) |
There was a problem hiding this comment.
Hmm, I thought I commented on this yesterday. This is unnecessarily complicated; just run the same strong permissions script. Don't make users jump through unnecessary hoops; it doesn't hurt anything to re-apply existing permissions.
There was a problem hiding this comment.
Yes, you commented, but you may got confused.
I try to give you an explanation:
- when you install you should set strong permissions for security reasons. Described in install_wizard.rst
- when you want to upgrade via the updater app, these strong permissions hinder the app from processing. Therefore you need to set the permissions to a different level (full write access to the webserver user). Note, some directories already have the correct permissions.
- when the upgrade has been finised, you need to reset the permissions back to strong
So what is to do now:
- before you update, call the script I added as described here in update.rst (Script preparing the instance for upgrading)
- do the upgrade via the updater app
- call the script from the installation wizard again to reset to strong permissions. This is also described in update.rst (Script preparing the instance after upgrading)
I hope that this description and my PR makes sense to you.
There was a problem hiding this comment.
In update.rst I don't see the reason for "Script preparing the instance for upgrading". chown -R <http-user>:<http-user> /path/to/owncloud/ takes care of that, and it's a lot faster & simpler. Then re-apply the Setting Strong Directory Permissions script after upgrading. Easy peasey.
Your additions to the Setting Strong Directory Permissions script in installation_wizard.rst
look fine.
There was a problem hiding this comment.
chown over all is really the easy going way, I know. My webserver directories are completely running on NFS that also includes the data directory, and I have also ++30k of thumbs for the gallery (per user) - which is also in the data directory. The reason I was using the script with find is, that this is much faster because it excludes data directory processing. Having in mind that I am not the only one doing this, I thought this is maybe of help having mentioned the quick chown variant AND the script as I described in the PR...
I have updated the PR, pls let me know if it is now fine to you.
Note: See owncloud/updater#202 (Updater should be able to execute external (own) sript). To be prepared, I have left the chown command for preparing the instance in a script.
There was a problem hiding this comment.
OK, thanks @mmattel, I understand now. Sometimes it takes me awhile. I'm merging this, and then I am going to make a few small tweaks. Nothing major, just smoothing out some wording. Thanks again, I appreciate your contributing.
Text fixes Adding reference, text updates Script update Remove unneeded " Text Update (Script preparing the instance after upgrading) Line breakes in the update preperation script Corrected :ref: link names for better identification Update
Update the description for proper updating the instance
Based on the experience I had with owncloud/core#21722
I reviewed the sections in the documentation and did some adoptions.
In a nutshell:
Setting Strong Permissionsin admin_manual/maintenance/update.rstThe second item eases the upgrade process because you just need to run script 1 to prepare the instance for the upgrade, do the upgrade and then run script 2 to reset strong permissions.
@RealRancor @nickvergessen