Add a site's software by pasting a lockfile or a list
Add the software a site runs to Software Watch by pasting a composer.lock, a package-lock.json, or a JSON list an assistant writes.
A site's Software list in Software Watch has Add from a file below the list. Paste one of these into the box and choose Add software:
- a
composer.lock, for the PHP packages a site uses; - a
package-lock.jsonof lockfile version 2 or 3, for its JavaScript packages; - a software list in the format below, such as one an assistant writes from what you know about your hosting.
Magpie tells which one it is from what it holds. Each package or piece of software becomes a row in the list, marked Added by hand, and is checked the same way as software the scan or the server check finds.
A lockfile's packages are checked at their exact versions. Development
packages (packages-dev in composer.lock, "dev": true in
package-lock.json) are left out, since a site does not run them. Paste the
same file again after an update and its packages change to the new versions;
a package the file no longer lists moves to No longer found.
A software list only adds and updates. To take something off the list, open it and choose Mark as not used on this site in More.
The whole document is checked before anything is saved. If any part of it does not fit, nothing is added and the problem is reported with the field that caused it. A site holds at most 5,000 pieces of software.
The software list
To have an assistant write it, choose Copy the prompt below the box, give the assistant what you know (your hosting panel's software page, your server's details, the apps you installed), and paste its answer.
{
"format": "magpie.software-list",
"version": 1,
"software": [
{ "name": "Plesk Obsidian", "version": "18.0.62", "kind": "program" },
{ "name": "Matomo", "version": "5.1.0", "kind": "cms" }
]
}
| Field | Type | Notes |
|---|---|---|
format |
string, required | Always magpie.software-list. |
version |
number, required | Always 1. |
software |
list, required | At least one entry, at most 5,000. |
Each entry
| Field | Type | Notes |
|---|---|---|
name |
string, required | The software's name, as its maker writes it. At most 255 characters. A name Magpie knows (such as WordPress, nginx or PHP) is checked against its vulnerability list; any other name is kept and listed as not checked. |
version |
string, optional | The version installed, such as 8.1.27. Without it, or with only part of it (8.1), the software is listed but vulnerabilities are not matched to it. |
kind |
string, optional | One of os, kernel, package, program, runtime, server, cms, plugin, theme, library, image, service, certificate or other. Ignored for a name Magpie knows, which has its own kind. |
If something you add is rejected for a reason you can't work out, Contact support.
Ask Magpie support
Send Magpie staff a question about anything this article does not answer.