-
Notifications
You must be signed in to change notification settings - Fork 1
/
readme.txt
69 lines (45 loc) · 3.01 KB
/
readme.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
=== External Update Check ===
Contributors: clausc
Donate link: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=Q3FN9743D9Z5N
Tags: update, updates
Requires at least: 3.4
Tested up to: 3.5.1
Stable tag: 0.5
License: BSD 2-Clause
License URI: http://opensource.org/licenses/BSD-2-Clause
Provides a secret URL to check for updates to the WordPress core, plugins and themes, without requiring cookie-based authentication. Meant for use in external monitoring services.
== Installation ==
1. Upload `external-update-check` to the `/wp-content/plugins/` directory
2. Activate the plugin through the 'Plugins' menu in WordPress
3. Copy the private URL displayed and use it however you want to (e. g. in a cron script, Jenkins, monitoring system, manually in a browser, etc.)
== Frequently Asked Questions ==
= I forgot the private URL. =
Deactivate and reactivate the plugin, a new private URL will be displayed.
= The private URL has been compromised, how can I change it? =
Deactivate and reactivate the plugin, a new private URL will be displayed. The previous private URL will no longer work.
= I activated several plugins at the same time and the private URL wasn't displayed. =
This is a known bug at the moment. Please deactivate the plugin and activate it again by clicking the "Activate" link next to it on the Plugins page.
= The private URL only outputs "0". =
This can have two causes:
- Either the private URL is incorrect, or
- there simply aren't any updates to the WordPress core, installed plugins and themes for your site.
= How can I use the output from the private URL? =
If there are updates for your WordPress installation, the private URL returns a JSON object with up to three properties:
- "core": A JSON array of available updates for your WordPress core. There could be multiple core updates, e.g. if your site uses a localized version of WordPress.
- "plugins": A JSON array of available updates for your WordPress plugins.
- "themes": A JSON array of available updates for your WordPress themes.
A simple use case would be to fetch the private URL from a cron script or scheduled task and have the script notify you in some way, if the result is not "0".
A more complicated use case would be to parse the output with a JSON parser, download the updates automatically, apply them to a source code directory, commit them to a version control server and deploy them to a staging server.
= Why doesn't the plugin update stuff automatically? =
Other WordPress plugins exist which already can do that. This plugin was developed for users who prefer a more fine-grained control over which updates they want to install, who make use of version control, or test updates in a staging environment before deployment.
== Changelog ==
= 0.5 =
* Fixed a bug that would show a core update even though WordPress was up to date.
= 0.4 =
* Documentation improvements.
= 0.3 =
* Fixed opening php tag.
= 0.2 =
* Documentation improvements.
= 0.1 =
* First version.