diff --git a/admin_manual/enterprise_clients/index.rst b/admin_manual/enterprise_clients/index.rst index 80a010d37..75777319c 100644 --- a/admin_manual/enterprise_clients/index.rst +++ b/admin_manual/enterprise_clients/index.rst @@ -7,6 +7,7 @@ Creating Branded ownCloud Clients (ES only) creating_branded_apps custom_client_repos + update_branded_desktop_clients publishing_android_app ../enterprise_ios_app/index \ No newline at end of file diff --git a/admin_manual/enterprise_clients/update_branded_desktop_clients.rst b/admin_manual/enterprise_clients/update_branded_desktop_clients.rst new file mode 100644 index 000000000..8e023cb79 --- /dev/null +++ b/admin_manual/enterprise_clients/update_branded_desktop_clients.rst @@ -0,0 +1,186 @@ +======================================================= +Updating Your Branded Desktop Clients (Enterprise Only) +======================================================= + +The Client Updater Server provides a Web service that will tell an ownCloud +desktop sync client whether or not an update is available. If an update is +available, it will also provide metadata for the update, such as the Download +URL, signatures or a fallback URL that the client can resort to in case the +update goes wrong. + +Prerequisites +------------- + +#. Configure “Update URL” in the “Desktop” section of your ownBrander + account (available for “advanced” users only) + + - Example: + https://mycloud.example.com/updates/ + (note the forward slash at the end.) + +#. Generate branded clients +#. Upload branded clients to your webserver + + - Windows example: + https://mycloud.example.com/install/mycloud-2.0.2.240-setup.exe + - Mac OS X example: + https://mycloud.example.com/install/mycloud-2.0.2.787.pkg + https://mycloud.example.com/install/mycloud-2.0.2.787.pkg.tbz + https://mycloud.example.com/install/mycloud-2.0.2.787.pkg.tbz.sig + - You need also a human-readable Website with links to your client + files. This could be https://mycloud.example.com/install/ with + ``Options +Indexes`` + +Install client-updater-server +----------------------------- + +#. Download ``client-updater-server-0.3.tar.xz`` from + https://customer.owncloud.com/ +#. Extract ``client-updater-server-0.3.tar.xz`` to your Web server. The + ``index.php`` must be accessible at + ``https://mycloud.example.com/updates/index.php`` +#. Duplicate the ``config/default.php`` and name according your + **Application short name** configured in ownBrander + + - Example: + ``config/mycloud.php`` + +Configure client-updater-server +------------------------------- + +All configuration is done in your ``config/mycloud.php``: + +:: + + [ + 'currentVersion' => '2.0.2.240', + 'currentVersionString' => 'MyCloud Client 2.0.2 (build 240)', + 'updateUrl' => 'https://mycloud.example.com/install/', + 'downloadUrl' => 'https://mycloud.example.com/install/mycloud-2.0.2.240-setup.exe', + ], + + 'linux' => array( + 'currentVersion' => '2.0.2', + 'currentVersionString' => 'MyCloud Client 2.0.2', + 'updateUrl' => 'https://mycloud.example.com/install/', + ), + + 'macos' => array( + 'currentVersion' => '2.0.2.787', + 'currentVersionString' => 'MyCloud Client 2.0.2 (build 787)', + 'downloadUrl' => 'https://mycloud.example.com/install/mycloud-2.0.2.787.pkg.tbz', + 'pubDate' => '2015-11-23', + 'signature' => 'MCwCFFedScUKeRXYMS6vKVLw821B+/+lAhRbiCxHNzVVZFNXHSvB9GNHOuI5cw==', + 'minimumSystemVersion' => '10.7.0', + ), + + ]; + +Windows +^^^^^^^ + +- ``'currentVersion'`` + Exact version of the new client, including the build nr +- ``'currentVersionString'`` + Name of the new client, same as “Application name” configured in + ownBrander +- ``'updateUrl'`` + Human-readable website with links to your new client files +- ``'downloadUrl'`` + Full URL to download the \*.exe file. http\ **s** needed + +Linux +^^^^^ + +If you host a branded download repository for your users, then you don’t +need to notify your users about new releases. Just configure a older +version then you deployed to your users to never trigger a notification. + +- ``'currentVersion'`` + Exact version of the new client, including the build nr +- ``'currentVersionString'`` + Name of the new client, same as “Application name” configured in + ownBrander +- ``'updateUrl'`` + Human-readable Website with links to your new client files to + manually install new client versions + +Mac OS X +^^^^^^^^ + +- ``currentVersion'`` + Exact version of the new client, including the build nr +- ``'currentVersionString'`` + Name of the new client, same as “Application name” configured in + ownBrander +- ``'downloadUrl'`` + Full URL to download the \*.pkg\ **.tbz** file. http\ **s** needed +- ``'pubDate'`` + Currently not used +- ``'signature'`` + Content of ``mycloud-2.0.2.787.pkg.tbz.sig``, adds some extra + security to the Mac OS X updater +- ``'minimumSystemVersion'`` + Minimum required Mac OS X version according to + https://owncloud.org/install/#install-clients + +Debugging client-updater-server +------------------------------- + +Windows +^^^^^^^ + +This a example URL of a 2.0.1 client for Mac OS X: +https://mycloud.example.com/updates/?version=2.0.1.140&platform=win32&oem= +mycloud + +You should see something like the following in your Web server logs: + +:: + + [19/Nov/2015:14:33:35 +0100] "GET /updates/?version=2.0.1.140&platform=win32&oem=mycloud HTTP/1.1" 200 185 "-" "Mozilla/5.0 (Windows) mirall/2.0.1 (mycloud)" microsecs:530450 response_size:185 bytes_received:255 bytes_sent:316 + +The output should look like this if you call the URL manually: + +:: + + + + 2.0.1.140 + MyCloud Client 2.0.1 (build 140) + https://mycloud.example.com/install/ + https://mycloud.example.com/install/mycloud-2.0.2.240-setup.exe + + +Mac OS X +^^^^^^^^ + +This a example URL of a 2.0.1 client for Mac OS X: +https://mycloud.example.com/updates/?version=2.0.1.687&platform=macos&oem= +mycloud&sparkle=true + +You should see something like the following in your Web server logs: + +:: + + [19/Nov/2015:14:00:17 +0100] "GET /updates/?version=2.0.1.687&platform=macos&oem=mycloud&sparkle=true HTTP/1.1" 200 185 "-" "Mozilla/5.0 (Macintosh) mirall/2.0.2 (mycloud)" microsecs:1071 response_size:2070 bytes_received:306 bytes_sent:2402 + +The output should look like this if you call the URL manually: + +:: + + + + + Download Channel + Most recent changes with links to updates. + en + MyCloud Client 2.0.2 (build 787) + Mon, 23 Nov 15 00:00:00 -0500 + + 10.7.0 + +