tweaked example dates and versions, adjusted line wrapping

This commit is contained in:
Carla Schroder
2016-01-25 13:56:21 -08:00
parent 4c573ec6d1
commit 554bc97848

View File

@@ -22,14 +22,18 @@ Prerequisites
#. 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
https://mycloud.example.com/install/mycloud-2.1.1.240-setup.exe
- Mac OS X examples:
https://mycloud.example.com/install/mycloud-2.1.1.787.pkg
https://mycloud.example.com/install/mycloud-2.1.1.787.pkg.tbz
https://mycloud.example.com/install/mycloud-2.1.1.787.pkg.tbz.sig
- You need a human-readable Website with links to your client
files. This could be https://mycloud.example.com/install/ with
``Options +Indexes``
``Options +Indexes`` in your ownCloud ``.htaccess`` file.
Install client-updater-server
-----------------------------
@@ -39,8 +43,8 @@ Install client-updater-server
#. 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
#. Copy your ownCloud ``config/default.php`` file, and name it according
your **Application short name** as configured in ownBrander.
- Example:
``config/mycloud.php``
@@ -48,32 +52,33 @@ Install client-updater-server
Configure client-updater-server
-------------------------------
All configuration is done in your ``config/mycloud.php``:
::
All configuration is done in your ``config/mycloud.php``::
<?php
$updateInfo = [
'win32' => [
'currentVersion' => '2.0.2.240',
'currentVersionString' => 'MyCloud Client 2.0.2 (build 240)',
'currentVersion' => '2.1.1.240',
'currentVersionString' => 'MyCloud Client 2.1.1 (build 240)',
'updateUrl' => 'https://mycloud.example.com/install/',
'downloadUrl' => 'https://mycloud.example.com/install/mycloud-2.0.2.240-setup.exe',
'downloadUrl' =>
'https://mycloud.example.com/install/mycloud-2.1.2.240-setup.exe',
],
'linux' => array(
'currentVersion' => '2.0.2',
'currentVersionString' => 'MyCloud Client 2.0.2',
'currentVersion' => '2.1.1',
'currentVersionString' => 'MyCloud Client 2.1.1',
'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==',
'currentVersion' => '2.1.1.787',
'currentVersionString' => 'MyCloud Client 2.1.1 (build 787)',
'downloadUrl' =>
'https://mycloud.example.com/install/mycloud-2.1.1.787.pkg.tbz',
'pubDate' => '2016-02-23',
'signature' =>
'MCwCFFedScUKeRXYMS6vKVLw821B+/+lAhRFNXHSvB9GNHOuI5cw==',
'minimumSystemVersion' => '10.7.0',
),
@@ -96,8 +101,9 @@ Linux
^^^^^
If you host a branded download repository for your users, then you dont
need to notify your users about new releases. Just configure a older
version then you deployed to your users to never trigger a notification.
need to notify your users about new releases. Just configure an older
version than the version you deployed to your users to never trigger a
notification.
- ``'currentVersion'``
Exact version of the new client, including the build nr
@@ -121,7 +127,7 @@ Mac OS X
- ``'pubDate'``
Currently not used
- ``'signature'``
Content of ``mycloud-2.0.2.787.pkg.tbz.sig``, adds some extra
Content of ``mycloud-2.1.1.787.pkg.tbz.sig``, adds some extra
security to the Mac OS X updater
- ``'minimumSystemVersion'``
Minimum required Mac OS X version according to
@@ -133,54 +139,61 @@ 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=
This a example URL of a 2.1.1 client for Mac OS X:
https://mycloud.example.com/updates/?version=2.1.1.140&platform=win32&oem=
mycloud
You should see something like the following in your Web server logs:
You should see something like the following in your Web server logs::
::
[19/Feb/2016:14:33:35 +0100] "GET
/updates/?version=2.1.1.140&platform=win32&oem=mycloud HTTP/1.1" 200 185 "-"
"Mozilla/5.0 (Windows) mirall/2.1.1 (mycloud)" microsecs:530450
response_size:185 bytes_received:255 bytes_sent:316
[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::
The output should look like this if you call the URL manually:
::
<?xml version="1.0"?>
<owncloudclient>
<version>2.0.1.140</version>
<versionstring>MyCloud Client 2.0.1 (build 140)</versionstring>
<web>https://mycloud.example.com/install/</web>
<downloadurl>https://mycloud.example.com/install/mycloud-2.0.2.240-setup.exe</downloadurl>
</owncloudclient>
<?xml version="1.0"?>
<owncloudclient>
<version>2.1.1.140</version>
<versionstring>MyCloud Client 2.1.1 (build 140)</versionstring>
<web>https://mycloud.example.com/install/</web>
<downloadurl>https://mycloud.example.com/install/
mycloud-2.1.1.140-setup.exe</downloadurl>
</owncloudclient>
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
This a example URL of a 2.1.1 client for Mac OS X::
You should see something like the following in your Web server logs:
https://mycloud.example.com/updates/?version=2.1.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
[19/Feb/2016:14:00:17 +0100] "GET
/updates/?version=2.1.1.687&platform=macos&oem=mycloud&sparkle=
true HTTP/1.1" 200 185 "-" "Mozilla/5.0 (Macintosh) mirall/2.1.1 (mycloud)"
microsecs:1071 response_size:2070 bytes_received:306 bytes_sent:2402
The output should look like this if you call the URL manually:
The output should look like this if you call the URL manually::
::
<?xml version="1.0" encoding="utf-8"?>
<rss version="2.0" xmlns:sparkle="http://www.andymatuschak.org/xml-namespaces/sparkle" xmlns:dc="http://purl.org/dc/elements/1.1/">
<channel>
<title>Download Channel</title>
<description>Most recent changes with links to updates.</description>
<language>en</language><item>
<title>MyCloud Client 2.0.2 (build 787)</title>
<pubDate>Mon, 23 Nov 15 00:00:00 -0500</pubDate>
<enclosure url="https://mycloud.example.com/install/mycloud-2.0.2.787.pkg.tbz" sparkle:version="2.0.2.787" type="application/octet-stream" sparkle:dsaSignature="MCwCFFedScUKeRXYMS6vKVLw821B+/+lAhRbiCxHNzVVZFNXHSvB9GNHOuI5cw=="/>
<sparkle:minimumSystemVersion>10.7.0</sparkle:minimumSystemVersion>
</item></channel>
</rss>
<?xml version="1.0" encoding="utf-8"?>
<rss version="2.0"
xmlns:sparkle="http://www.andymatuschak.org/xml-namespaces/sparkle"
xmlns:dc="http://purl.org/dc/elements/1.1/">
<channel>
<title>Download Channel</title>
<description>Most recent changes with links to updates.</description>
<language>en</language><item>
<title>MyCloud Client 2.1.1 (build 787)</title>
<pubDate>Mon, 23 Feb 16 00:00:00 -0500</pubDate>
<enclosure url="https://mycloud.example.com/install/
mycloud-2.1.1.787.pkg.tbz" sparkle:version="2.1.1.787"
type="application/octet-stream"
sparkle:dsaSignature="MCwCFFedScUKeRXYMS6vKVLw821B+/+
lAhRbiCxHNzVVZFNXHSvB9GNHOuI5cw=="/>
<sparkle:minimumSystemVersion>10.7.0</sparkle:minimumSystemVersion>
</item>
</channel>
</rss>