[Pkg-owncloud-commits] [owncloud-doc] 19/56: many updates to upgrading docs
David Prévot
taffit at moszumanska.debian.org
Sun Nov 15 22:37:46 UTC 2015
This is an automated email from the git hooks/post-receive script.
taffit pushed a commit to branch stable8
in repository owncloud-doc.
commit 28e32fe0c8e00e538515e285063f56ea12651854
Author: Carla Schroder <carla at owncloud.com>
Date: Thu Oct 29 10:23:27 2015 -0700
many updates to upgrading docs
---
.../configuration_files/external_storage/local.rst | 4 +-
admin_manual/configuration_server/occ_command.rst | 4 +-
.../enterprise_installation/linux_installation.rst | 29 +--
admin_manual/images/upgrade-1.png | Bin 33175 -> 0 bytes
.../installation/command_line_installation.rst | 2 +-
admin_manual/installation/images/upgrade-1.png | Bin 0 -> 26477 bytes
admin_manual/installation/images/upgrade-2.png | Bin 0 -> 47237 bytes
admin_manual/installation/installation_wizard.rst | 21 +-
admin_manual/installation/source_installation.rst | 3 +-
admin_manual/maintenance/images/upgrade-1.png | Bin 0 -> 26477 bytes
admin_manual/maintenance/images/upgrade-2.png | Bin 0 -> 47237 bytes
admin_manual/maintenance/upgrade.rst | 233 ++++++++++-----------
admin_manual/release_notes.rst | 3 +
admin_manual/whats_new_admin.rst | 2 +
14 files changed, 144 insertions(+), 157 deletions(-)
diff --git a/admin_manual/configuration_files/external_storage/local.rst b/admin_manual/configuration_files/external_storage/local.rst
index 064fa82..9a91d09 100644
--- a/admin_manual/configuration_files/external_storage/local.rst
+++ b/admin_manual/configuration_files/external_storage/local.rst
@@ -15,8 +15,8 @@ are on Ubuntu Linux::
sudo -u www-data chown -R www-data:www-data /localdir
sudo -u www-data chmod -R 0750 /localdir
-See :ref:`label-setting-strong-perms` for information on correct file permissions,
-and find your HTTP user :ref:`label-phpinfo`.
+See :ref:`strong-perms-label` for information on correct file permissions, and
+find your HTTP user :ref:`label-phpinfo`.
In the **Folder name** field enter the folder name that you want to appear on
your ownCloud Files page.
diff --git a/admin_manual/configuration_server/occ_command.rst b/admin_manual/configuration_server/occ_command.rst
index 9ecaf08..0eb0ba1 100644
--- a/admin_manual/configuration_server/occ_command.rst
+++ b/admin_manual/configuration_server/occ_command.rst
@@ -34,7 +34,7 @@ Run occ As Your HTTP User
-------------------------
The HTTP user is different on the various Linux distributions. See
-:ref:`strong_perms` to learn how to find your HTTP user.
+:ref:`strong-perms-label` to learn how to find your HTTP user.
* The HTTP user and group in Debian/Ubuntu is www-data.
* The HTTP user and group in Fedora/CentOS is apache.
@@ -662,7 +662,7 @@ after installing ownCloud packages (See
place of running the graphical Installation Wizard.
Apply correct permissions to your ownCloud directories; see
-:ref:`strong_perms`. Then choose your ``occ`` options. This lists your
+:ref:`strong-perms-label`. Then choose your ``occ`` options. This lists your
available options::
$ sudo -u www-data php /var/www/owncloud/occ
diff --git a/admin_manual/enterprise_installation/linux_installation.rst b/admin_manual/enterprise_installation/linux_installation.rst
index b0ec39e..91ae930 100644
--- a/admin_manual/enterprise_installation/linux_installation.rst
+++ b/admin_manual/enterprise_installation/linux_installation.rst
@@ -1,18 +1,22 @@
-====================================================
-Installing ownCloud Enterprise Subscription on Linux
-====================================================
+=======================================================
+Installing & Upgrading ownCloud Enterprise Subscription
+=======================================================
The recommended method for installing and maintaining your ownCloud Enterprise
-Subscription is with your Linux package manager. Configure your package manager to
-use the ownCloud Enterprise Subscription repository, import the signing key, and then
-install and update ownCloud like any other software package. Please refer to
-the ``README - ownCloud Package Installation.txt`` document in your account at
-`Customer.owncloud.com <https://customer.owncloud.com/owncloud/>`_ account for
-instructions on setting up your Linux package manager.
+Subscription is with your Linux package manager. Configure your package manager
+to use the ownCloud Enterprise Subscription repository, import the signing key,
+and then install and update ownCloud packages like any other software package.
+Please refer to the ``README - ownCloud Package Installation.txt`` document in
+your account at `Customer.owncloud.com
+<https://customer.owncloud.com/owncloud/>`_ account for instructions on setting
+up your Linux package manager.
After you have completed your initial installation of ownCloud as detailed in
-the README, follow the instructions in :doc:`../installation/installation_wizard` to finish
-setting up ownCloud.
+the README, follow the instructions in
+:doc:`../installation/installation_wizard` to finish setting up ownCloud.
+
+To upgrade your Enterprise Subscription, refer to
+:doc:`../maintenance/upgrade`.
SELinux
-------
@@ -20,6 +24,3 @@ SELinux
Linux distributions that use SELinux need to take some extra steps so that
ownCloud will operate correctly under SELinux. Please see
:doc:`../installation/selinux_configuration` for some recommended configurations.
-
-
-
diff --git a/admin_manual/images/upgrade-1.png b/admin_manual/images/upgrade-1.png
deleted file mode 100644
index 1b574fa..0000000
Binary files a/admin_manual/images/upgrade-1.png and /dev/null differ
diff --git a/admin_manual/installation/command_line_installation.rst b/admin_manual/installation/command_line_installation.rst
index 7fdffbb..931585a 100644
--- a/admin_manual/installation/command_line_installation.rst
+++ b/admin_manual/installation/command_line_installation.rst
@@ -12,7 +12,7 @@ and unpack the tarball in the appropriate directories. (See
:doc:`linux_installation` and :doc:`source_installation`.)
2. Apply the correction permissions to your ownCloud files and directories (see
-:ref:`strong_perms`.)
+:ref:`strong-perms-label`.)
3. Use the ``occ`` command to complete your installation. This takes the place
of running the graphical Installation Wizard.
diff --git a/admin_manual/installation/images/upgrade-1.png b/admin_manual/installation/images/upgrade-1.png
new file mode 100644
index 0000000..80d2e6b
Binary files /dev/null and b/admin_manual/installation/images/upgrade-1.png differ
diff --git a/admin_manual/installation/images/upgrade-2.png b/admin_manual/installation/images/upgrade-2.png
new file mode 100644
index 0000000..17cab4d
Binary files /dev/null and b/admin_manual/installation/images/upgrade-2.png differ
diff --git a/admin_manual/installation/installation_wizard.rst b/admin_manual/installation/installation_wizard.rst
index e748fae..2e2e83e 100644
--- a/admin_manual/installation/installation_wizard.rst
+++ b/admin_manual/installation/installation_wizard.rst
@@ -20,18 +20,16 @@ This is just three steps:
You're finished and can start using your new ownCloud server.
-Of course, there is much more that you can do to set up your ownCloud server
-for
-best performance and security. In the following sections we will cover
-important
+Of course, there is much more that you can do to set up your ownCloud server for
+best performance and security. In the following sections we will cover important
installation and post-installation steps. Note that you must follow the
-instructions in :ref:`Setting Strong Permissions <label-setting-strong-perms>`
-in order to use the :doc:`occ Command <../configuration_server/occ_command>`.
+instructions in :ref:`Setting Strong Permissions <strong-perms-label>` in order
+to use the :doc:`occ Command <../configuration_server/occ_command>`.
* :ref:`Data Directory Location <label-data-directory-location>`
* :ref:`Database Choice <label-database-choice>`
* :ref:`Trusted Domains <label-trusted-domains>`
-* :ref:`Setting Strong Permissions <label-setting-strong-perms>`
+* :ref:`Setting Strong Permissions <strong-perms-label>`
.. _label-data-directory-location:
@@ -51,7 +49,8 @@ ownCloud data in a different location for other reasons (e.g. on a storage
server). It is best to configure your data directory location at installation,
as it is difficult to move after installation. You may put it anywhere; in this
example is it located in ``/var/oc_data``. This directory must already exist,
-and must be owned by your HTTP user (see :ref:`label-setting-strong-perms`).
+and must be owned by your HTTP user (see
+:ref:`strong-perms-label`).
.. _label-database-choice:
@@ -108,10 +107,8 @@ is not whitelisted the following error appears:
:alt: screenshot of error message when URL is not whitelisted in
trusted_domains
-.. _label-setting-strong-perms:
-
-.. _strong_perms:
-
+.. _strong-perms-label:
+
Setting Strong Directory Permissions
------------------------------------
diff --git a/admin_manual/installation/source_installation.rst b/admin_manual/installation/source_installation.rst
index 82d786f..26c5ea9 100644
--- a/admin_manual/installation/source_installation.rst
+++ b/admin_manual/installation/source_installation.rst
@@ -252,7 +252,8 @@ Setting Strong Directory Permissions
------------------------------------
We recommend setting the directory permissions in your ownCloud installation as
-strictly as possible for stronger security. Please refer to :ref:`strong_perms`.
+strictly as possible for stronger security. Please refer to
+:ref:`strong-perms-label`.
SELinux
-------
diff --git a/admin_manual/maintenance/images/upgrade-1.png b/admin_manual/maintenance/images/upgrade-1.png
new file mode 100644
index 0000000..80d2e6b
Binary files /dev/null and b/admin_manual/maintenance/images/upgrade-1.png differ
diff --git a/admin_manual/maintenance/images/upgrade-2.png b/admin_manual/maintenance/images/upgrade-2.png
new file mode 100644
index 0000000..17cab4d
Binary files /dev/null and b/admin_manual/maintenance/images/upgrade-2.png differ
diff --git a/admin_manual/maintenance/upgrade.rst b/admin_manual/maintenance/upgrade.rst
index 8229190..93a30ab 100644
--- a/admin_manual/maintenance/upgrade.rst
+++ b/admin_manual/maintenance/upgrade.rst
@@ -2,80 +2,79 @@
Upgrading Your ownCloud Server
==============================
+For ownCloud 8.2 the Linux package repositories have changed, and **you must
+configure your system to use these new repos**. The new repos are at our `Open
+Build Service`_. Just follow the instructions for your Linux distribution, and
+then install new ownCloud packages in the usual way with your package manager.
+
It is best to keep your ownCloud server upgraded regularly, and to install all
point releases and major releases without skipping any of them, as skipping
-releases increases the risk of errors. Major releases are 6.0, 7.0, and 8.0, and
-point releases are intermediate releases for each major release. For example,
-8.0.1 and 8.0.2 are point releases.
-
-.. note:: **Downgrading** is not supported and risks corrupting your data! If
- you want to revert to an older ownCloud version, install it from scratch
- and then restore your data from backup. Before doing this, file a support
- ticket (if you have paid support) or ask for help in the ownCloud forums to
- see if your issue can be resolved without downgrading.
-
-Version numbering changed with ownCloud 8.0. Major releases are now indicated
-by the second number, so 8.0. 8.1, and 8.2 are major releases. The third number
-indicates an intermediate release, e.g. 8.0.5.
-
-.. note:: If you are using the Encryption app and upgrading from older
- versions of ownCloud to ownCloud 8.0, you must manually migrate your
- encryption keys with the *occ* command after the upgrade is complete, like
- this example for CentOS:
- *sudo -u apache php occ encryption:migrate*
- You must run *occ* as your HTTP user. See
- :doc:`../configuration_server/occ_command` to learn more about *occ*
-
-There are multiple ways to keep your ownCloud server upgraded: with the Updater
-App (Server Edition only), with your Linux package manager, and by manually
-upgrading. In this chapter you will learn how to keep your ownCloud installation
-current with your Linux package manager, and by manually upgrading.
-
-(See :doc:`update` to learn about the Updater App.)
-
-.. note:: Before upgrading to a new major release, always first review any
- third-party apps you have installed for compatibility with
- the new ownCloud release. Any apps that are not developed by ownCloud show a
- 3rd party designation. Install unsupported apps at your own risk. Then,
- before the upgrade, they must all be disabled. After the upgrade is
- complete and you are sure they are compatible with the new ownCloud
- release you may re-enable them.
-
-Preferred Upgrade Method
-------------------------
+releases increases the risk of errors. Major releases are 8.0, 8.1, and
+8.2. Point releases are intermediate releases for each major release. For
+example, 8.0.9 and 8.1.3 are point releases.
-The best method for keeping ownCloud on Linux servers current is by
-configuring your system to use our `Open Build Service
-<https://download.owncloud.org/download/repositories/8.2/owncloud/>`_ (see
-:doc:`../installation/linux_installation`); just
-follow the instructions on oBS for setting up your package manager. Then
-stay current by using your Linux package manager to upgrade.
+There are multiple ways to keep your ownCloud server upgraded: with the
+:doc:`Updater App <update>` (Server Edition only), with your Linux package
+manager, and by manually upgrading. In this chapter you will learn how to keep
+your ownCloud installation current with your Linux package manager, and by
+manually upgrading.
.. note:: Enterprise Subscription customers will use their Enterprise software
- repositories to install and update their ownCloud installations, rather
- than the openSUSE Build Service. Please see
+ repositories to install ownCloud packages, rather
+ than the Open Build Service. Then follow the instructions on this page
+ for completing upgrades. Please see
:doc:`../enterprise_installation/linux_installation` for more information.
-You should always maintain regular backups (see :doc:`../maintenance/backup`),
-and make a backup before every upgrade.
+When you are upgrading to a major release, evaluate any third-party apps for
+compatibility with the upgrade, and then disable them before upgrading. You may
+re-enable them after the upgrade is completed.
-When a new ownCloud release is available you will see a yellow banner in your
-ownCloud Web interface.
+.. note:: **Downgrading** is not supported and risks corrupting your data! If
+ you want to revert to an older ownCloud version, make a new, fresh
+ installation and then restore your data from backup. Before doing this,
+ file a support ticket (if you have paid support) or ask for help in the
+ ownCloud forums to see if your issue can be resolved without downgrading.
+
+Upgrade Quickstart
+------------------
+
+The best method for keeping ownCloud on Linux servers current is by configuring
+your system to use ownCloud's `Open Build Service`_ repository. Then stay
+current by using your Linux package manager to install fresh ownCloud packages.
+After installing upgraded packages you must run a few more steps to complete
+the upgrade. These are the basic steps to upgrading ownCloud:
+
+* Disable all third-party apps.
+* Make a fresh backup (see :doc:`../maintenance/backup`).
+* Install new packages from the ownCloud `Open Build Service`_.
+* Take your ownCloud server out of maintenance mode.
+* Run the upgrade wizard.
+* Log in and apply strong permissions to your ownCloud directories apps.
+* Re-enable third-party apps.
+
+Prerequisites
+-------------
-.. figure:: ../images/updater-1.png
+You should always maintain regular backups and make a fresh backup before every
+upgrade.
-**Upgrading is disruptive**. When you upgrade ownCloud with your Linux package
-manager, that is just the first step to applying the upgrade. After
-downloading the new ownCloud packages your session will be interrupted, and you
-must run the upgrade wizard to complete the upgrade, which is discussed in the
-next section.
+Then review any third-party apps you have installed for compatibility with the
+new ownCloud release. Any apps that are not developed by ownCloud show a 3rd
+party designation. **Install unsupported apps at your own risk**. Then, before
+the upgrade, they must all be disabled. After the upgrade is complete and you
+are sure they are compatible with the new ownCloud release you may re-enable
+them.
+
+**Upgrading is disruptive**. Your ownCloud server will be automatically put
+into maintenance mode, so your users will be locked out until the upgrade is
+completed. Large installations may take several hours to complete the upgrade.
Upgrading With Your Linux Package Manager
-----------------------------------------
-When an ownCloud upgrade is available from the openSUSE Build Service
-repository, you can apply it just like any normal Linux upgrade. For example,
-on Debian or Ubuntu Linux this is the standard system upgrade command::
+When an ownCloud upgrade is available from ownCloud's `Open Build Service`_
+repository, apply it just like any normal Linux upgrade. For example, on Debian
+or Ubuntu Linux this is the standard system upgrade command::
$ sudo apt-get update && sudo apt-get upgrade
@@ -95,82 +94,69 @@ Or update only ownCloud::
$ sudo yum update owncloud
-Your Linux package manager only downloads the current ownCloud packages. There
-is one more step, and that is to run the upgrade wizard to perform the final
-steps of updating the database and turning off maintenance mode. After using
-your package manager to install the current ownCloud release, you will see two
-screens. On the first screen, click the Start Upgrade button, or optionally run
-the ``occ upgrade`` command instead of clicking the button.
+Your Linux package manager only downloads the current ownCloud packages. Then
+your ownCloud server is automatically put into maintenance mode.
-.. figure:: ../images/updater-8.png
+.. figure:: images/upgrade-1.png
-``occ upgrade``
-is more reliable, especially on installations with large datasets and large
-numbers of users because it avoids the risk of PHP timeouts.
+Next, take your server out of maintenance mode. You can do this by changing
+``'maintenance' => true, to 'maintenance' => false,`` in ``config.php``, or use
+the :doc:`../configuration_server/occ_command`, like this example on Ubuntu::
-.. note:: The ``occ`` command does not download ownCloud updates. You must first download
- the updated code, and then ``occ`` performs the final upgrade steps.
+ $ sudo -u www-data php occ maintenance:mode --off
-The ``occ`` command
-is in your ``owncloud/`` directory. You must run it as your HTTP user. This
-example is for Debian/Ubuntu::
+The final step is to run the upgrade wizard to perform the final steps of
+updating your apps and database. You will see a screen with a summary of apps
+that will be updated, and a **Start Update** button. If you have shell access is
+it better to **not** click the Start Update button, but rather to use ``occ
+upgrade``, like this example on CentOS::
- $ sudo -u www-data php occ upgrade
-
-Before completing the upgrade, ownCloud first runs a simulation by copying all
-database tables to a temporary directory and then performing the upgrade on
-them, to ensure that the upgrade will complete correctly. This takes twice as
-much time, which on large installations can be many hours, so you can omit this
-step with the ``--skip-migration-test`` option::
+ $ sudo -u apache php occ upgrade
- $ sudo -u www-data php occ upgrade --skip-migration-test
-
-This example is for Fedora, CentOS, and Red Hat Linux::
+.. figure:: images/upgrade-2.png
- $ sudo -u apache php occ upgrade
-
-Or::
+``occ upgrade`` is more reliable, especially on installations with large
+datasets and large numbers of users because it avoids the risk of PHP timeouts.
- $ sudo -u apache php occ upgrade -skip-migration-test
+Migration Test
+^^^^^^^^^^^^^^
-* The HTTP user and group in Debian/Ubuntu is ``www-data``.
-* The HTTP user and group in Fedora/CentOS/RHEL is ``apache``.
-* The HTTP user and group in Arch Linux is ``http``.
-* The HTTP user in openSUSE is ``wwwrun``, and the HTTP group is ``www``.
+Before completing the upgrade, ownCloud first runs a simulation by copying all
+database tables to a temporary directory and then performing the upgrade on
+them, to ensure that the upgrade will complete correctly. This can delay large
+installations by several hours, so you can omit this step with the
+``--skip-migration-test`` option, like this example on CentOS::
-See :doc:`../configuration_server/occ_command` to learn more about using the
-``occ`` command, and see the **Setting Strong Directory Permissions** section
-of :doc:`../installation/installation_wizard` to learn how to find your
-HTTP user.
+ $ sudo -u apache php occ upgrade --skip-migration-test
-When the upgrade is successful you will see the following screen:
+When the upgrade is successful you will be returned to the login screen.
-.. figure:: ../images/updater-7.png
+Setting Strong Permissions
+^^^^^^^^^^^^^^^^^^^^^^^^^^
-After upgrading, verify that your ownCloud
-directory permissions are set according to the **Setting Strong Directory Permissions**
-section of :doc:`../installation/installation_wizard`.
+After upgrading, verify that your ownCloud directory permissions are set
+according to :ref:`strong-perms-label`.
If the upgrade fails, then you must try a manual upgrade.
Manual Upgrade Procedure
------------------------
-If you are upgrading to a major release, for example from 7.0.5 to
-8.0, you must review all third party applications (not core apps), for
+Always start by making a fresh backup.
+
+If you are upgrading to a major release, for example from 8.1.3 to
+8.2, you must review all third party applications (not core apps) for
compatibility with your new ownCloud version. Then disable all of them
before starting the upgrade.
-Next put your server in maintenance mode. This prevents new logins,
-locks the sessions of logged-in users, and displays a status screen so users
-know what is happening. There are two ways to do this, and the preferred method
-is to use the ``occ`` command, which you must run as your HTTP user. This example
-is for Ubuntu Linux::
+Next put your server in maintenance mode. This prevents new logins, locks the
+sessions of logged-in users, and displays a status screen so users know what is
+happening. There are two ways to do this, and the preferred method is to use the
+:doc:`occ command <../configuration_server/occ_command>`, which you must run as
+your HTTP user. This example is for Ubuntu Linux::
$ sudo -u www-data php occ maintenance:mode --on
-Please see :doc:`../configuration_server/occ_command` to learn more about ``occ``.
-
The other way is by entering your ``config.php`` file and changing
``'maintenance' => false,`` to ``'maintenance' => true,``.
@@ -182,10 +168,11 @@ The other way is by entering your ``config.php`` file and changing
of your current installation. For example, if your current ownCloud is
installed in ``/var/www/owncloud/`` you could create a new directory called
``/var/www/owncloud2/``
-3. Stop your web server.
+3. Stop your Web server.
-Apache 2 is the recommended server for ownCloud (see :doc:`../release_notes`
-for recommended setups and supported platforms.)
+Apache 2 is the recommended server for ownCloud (see
+:doc:`../installation/system_requirements` for recommended setups and supported
+platforms.)
+-----------------------+-----------------------------------------+
| Operating System | Command (as root) |
@@ -265,18 +252,11 @@ for recommended setups and supported platforms.)
Assuming your upgrade succeeded, take a look at the bottom of your Admin page to
verify the version number. Check your other settings to make sure they're
correct. Go to the Apps page and review the core apps to make sure the right
-ones are enabled. Finally, re-enable your third-party apps.
+ones are enabled. Re-enable your third-party apps. Then apply strong
+permissions to your ownCloud directories (:ref:`strong-perms-label`).
-Setting Strong Permissions
---------------------------
-
-For hardened security we highly recommend setting the permissions on your
-ownCloud directory as strictly as possible. After upgrading, verify that your ownCloud
-directory permissions are set according to the **Setting Strong Directory Permissions**
-section of :doc:`../installation/installation_wizard`.
-
-Restore From Backup
--------------------
+Reverse Upgrade
+---------------
If you need to reverse your upgrade, see :doc:`restore`.
@@ -325,3 +305,6 @@ And start the manual process::
If this does not work properly, try the repair function::
$ sudo -u www-data php occ maintenance:repair
+
+.. _Open Build Service:
+ https://download.owncloud.org/download/repositories/8.2/owncloud/
\ No newline at end of file
diff --git a/admin_manual/release_notes.rst b/admin_manual/release_notes.rst
index ea8bcc8..25e1b1c 100644
--- a/admin_manual/release_notes.rst
+++ b/admin_manual/release_notes.rst
@@ -5,6 +5,9 @@ ownCloud |version| Release Notes
Changes in 8.2
--------------
+New location for Linux package repositories; ownCloud admins must manually
+change to the new repos. See :doc:`maintenance/upgrade`
+
PHP 5.6.11+ breaks the LDAP wizard with a 'Could not connect to LDAP' error. See https://github.com/owncloud/core/issues/20020.
``filesystem_check_changes`` in ``config.php`` is set to 0 by default. This
diff --git a/admin_manual/whats_new_admin.rst b/admin_manual/whats_new_admin.rst
index c03a206..aa828fe 100644
--- a/admin_manual/whats_new_admin.rst
+++ b/admin_manual/whats_new_admin.rst
@@ -8,6 +8,8 @@ on Github for a comprehensive list of new features and updates.
Some of the improvements of interest to ownCloud admins are:
+* New ownCloud package repositories (admins must manually change to these, see
+ :doc:`maintenance/upgrade`)
* Configurable temporary directory
* Many new occ commands for logging, encryption, and apps
* Unavailable external storages are not rechecked every request; rather, their
--
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-owncloud/owncloud-doc.git
More information about the Pkg-owncloud-commits
mailing list