EarthAsylum/eacsoftwareregistry-software-taxonomy

eacdoojigger eacsoftwareregistry software-development software-license-manager software-licensing software-registry wordpress wordpress-plugin

{eac}SoftwareRegistry Software Taxonomy

Plugin Header

Plugin URI: https://swregistry.earthasylum.com/software-taxonomy/
Author: EarthAsylum Consulting
Stable tag: 2.0.7
Last Updated: 25-Apr-2024
Requires at least: 5.5.0
Tested up to: 6.5
Requires PHP: 7.4
Contributors: kevinburkholder
License: GPLv3 or later
License URI: https://www.gnu.org/licenses/gpl.html
Tags: software registration, software registry, software license, software product, github hosting, {eac}SoftwareRegistry
WordPress URI: https://wordpress.org/plugins/eacsoftwareregistry-software-taxonomy
Github URI: https://github.com/EarthAsylum/eacsoftwareregistry-software-taxonomy

Software Product Taxonomy - Customize {eac}SoftwareRegistry with options, licensing, client messaging, and Github hosting for each software product.

Description

{eac}SoftwareRegistry Software Taxonomy is an extension plugin to {eac}SoftwareRegistry Software Registration Server.

Now with plugin hosting on Github to provide complete, automated plugin information and updates in WordPress.

{eac}SoftwareRegistry Software Taxonomy is a simple plugin extension that allows you to set and override {eac}SoftwareRegistry options for specific software products. It both defines the software product as well as the server parameters used when that product is registered via the software registration application program interface.

When an API request is received by the registry server, the registry_product is matched to the software taxonomy slug. When a match is found, the parameters entered in the software taxonomy meta data are used to override the registry server default parameters.

Options set on a per-product basis by this extension

Software Product
- Registry Title - The Software Product display name
- Registry Description - The Software Product Description
Registrar Contact (override existing global options in {eac}SoftwareRegistry)
- Registrar Name - Sending client email from this name
- Registrar Telephone - Include telephone in client notifications
- Registrar Support Email - Include support email address in client notifications
- Registrar Web Address - Include web address in client notifications
Registration Defaults (override existing global options in {eac}SoftwareRegistry)
- Default Status - The default status to assign to newly created registrations
- Default Initial Term - The initial term when creating a new registration (pending or trial)
- Default Full Term - The full term when activating a registration
- Default License - The default license level (L1-L5, LD) to assign to newly created registrations
Client Notification (Customize the email message and API response notifications sent to the client)
- Client Email Message - Message sent to client on creation, activation or update of registration.
- Client API Message - Short message included with all API responses.
- Client Success Notice - Success notification sent via API response.
- Client Error Notice - Error notification sent via API response.
License Limitations
- see below
GitHub Hosting
- WordPress Plugin Slug - The {directory}/{plugin.php} slug of the WordPress plugin.
- GitHub Repository - The {owner}/{repository} id of the github repository.
- Repository Source - Select which source to use from the repository (branch, release).
- Tag Name - (Optional) Specific release or branch tag name (or id).
- Path to readme.txt - Pathname within the repository to the readme.txt file. If blank, the json file will be generated from information available in the GitHub repository.
- GitHub Access Token - Your GitHub personal access token, Increases the github rate limit and is required for private repositories.
- Plugin URLs - Displays the URL(s) you will need for your plugin file and readme.txt file.

License Limitations

Based on the license level assigned to a registration, we can limit the optional values in the registration API (count, variations, options, domains & sites). This allows APIs (possibly from multiple sources) to register any/all values for these options while filtering on the registration server, providing an effective (albeit rudimentary) licensing validation.

For each license level ( L1=Lite, L2=Basic, L3=Standard, L4=Professional, L5=Enterprise, LD=Developer ) you may set a limit for count, variations, options, domains, and sites.

count - Number of licenses (users/seats/devices)
variations - List of custom name/value pairs
options - List of custom registry options
domains - List of valid/registered domains
sites - List of valid/registered sites/uris

For count, the value passed through the API is limited to a maximum value. For variations, options, domains, and sites, the arrays passed through the API are sliced to a maximum number of elements.

GitHub Hosting

* GitHub hosting requires installation of the {eac}Readme plugin in order to process readme.txt files.

Wether you're using software registration or not, you can use Github Hosting to manage your software releases and provide automated updates for your WordPress plugins.

New in version 2.0, these options allow for the "self-hosting" of WordPress plugins on GitHub in a way similar to and meeting the requirements of the WordPress plugin repository.

More details may be found in the included readme_github.md file.

Installation

{eac}SoftwareRegistry Software Taxonomy is an extension plugin to and requires installation and registration of {eac}SoftwareRegistry.

Automatic Plugin Installation

This plugin is available from the WordPress Plugin Repository and can be installed from the WordPress Dashboard » Plugins » Add New page. Search for 'EarthAsylum', click the plugin's [Install] button and, once installed, click [Activate].

See Managing Plugins -> Automatic Plugin Installation

Upload via WordPress Dashboard

Installation of this plugin can be managed from the WordPress Dashboard » Plugins » Add New page. Click the [Upload Plugin] button, then select the eacsoftwareregistry-software-taxonomy.zip file from your computer.

See Managing Plugins -> Upload via WordPress Admin

Manual Plugin Installation

You can install the plugin manually by extracting the eacsoftwareregistry-software-taxonomy.zip file and uploading the 'eacsoftwareregistry-software-taxonomy' folder to the 'wp-content/plugins' folder on your WordPress server.

See Managing Plugins -> Manual Plugin Installation