JRELEASER

• Joomla: 5.1+ (Recommended: 5.4+ or 6+)
• PHP: 8.1+ (Recommended: 8.4+)
• MySQL: 5.7+ or MariaDB 10.3+
• Web Server: Apache 2.4+ or Nginx 1.18+
• PHP Extensions: cURL, JSON, SimpleXML, MySQLi/PDO, OpenSSL, mbstring, fileinfo, ZipArchive
• SSL/HTTPS: Required for secure downloads

JReleaser consists of two extensions that install together as a single package:

• Component (com_jreleaser): Admin dashboard for products, releases, API keys, downloads tracking, and all configuration settings
• Content Plugin (plg_content_jreleaser): Shortcodes for download buttons, version display, and changelog rendering

Download the package file: pkg_jreleaser_v1.0.4.zip

JReleaser provides a complete release management workflow:

• Products: Define your extensions with element name, type, and access controls
• Releases: Upload ZIP files with automatic manifest parsing and hash generation
• Update Server: Generate Joomla-compatible update XML feeds
• API Keys: Master keys and child keys for protected downloads
• Downloads: Track all downloads with user, IP, and timestamp logging
• Shortcodes: Display download buttons, versions, and changelogs anywhere
• Multi-Framework: 6 CSS framework templates (UIKit3, Bootstrap5, Tailwind, etc.)

Before installing JReleaser:

• Verify Joomla 5.0+ is installed and running
• Confirm PHP 8.1+ with all required extensions enabled
• Backup your site and database
• Prepare your extension ZIP files for upload
• Optional: Host changelog XML files on GitHub or your server

Follow these steps for a fresh JReleaser installation:

• Login to back-end area of your Joomla CMS site using a super administrator account
• Navigate to System → Extensions → Install → Upload Package File
• Drag and drop the file or click the green button to browse. The file name will be: pkg_jreleaser_v1.0.4.zip
• After installation completes, you should see: "JReleaser Package has been successfully installed!"
• The package automatically installs the component and content plugin

After installation, verify everything is configured correctly:

• Go to System → Plugins and find "Content - JReleaser"
• Ensure the plugin is Enabled
• Go to Components → JReleaser to verify the component loads
• Check the Setup guide in the component for detailed configuration instructions

Release files are stored securely:

• Directory: /media/com_jreleaser/releases/
• Created automatically when uploading your first release
• Files are served through PHP for access control

The component handles file storage automatically - no manual directory creation needed.

To remove JReleaser completely:

• Navigate to System → Manage → Extensions → Manage
• Search for "JReleaser"
• Select the checkbox next to the JReleaser Package
• Click the dropdown in the Actions menu and choose Uninstall
• This will remove both extensions automatically

Warning: Uninstalling will delete all products, releases, API keys, and database tables. Ensure you have a backup if needed.

Access JReleaser settings:

• Path 1: Components → JReleaser → Options button (toolbar)
• Path 2: System → Global Configuration → JReleaser

The Setup guide in the component provides step-by-step instructions for your first release.

Products represent your Joomla extensions:

Title

Display name for your extension
Example: My Amazing Component

Element

Technical element name matching your manifest
Example: com_mycomponent, plg_system_myplugin

Type

Extension type: component, plugin, module, package, template, library, file
Default: component

Folder

For plugins only - the plugin group
Example: system, content, authentication

Client

Site or Administrator (for modules)
Default: site

Access

Joomla view access level (Public, Registered, Special, etc.)
Default: Public

Protected

Require API key for guest/remote downloads
Default: No

Use Quick Upload for the fastest way to add releases:

• Go to Components → JReleaser → Quick Upload
• Select the product from the dropdown
• Upload your extension ZIP file
• The system automatically extracts:
  • Version from manifest
  • Release date (creationDate)
  • File size
  • SHA256/SHA384/SHA512 checksums
• Optionally add changelog URL and info URL
• Save the release

JReleaser uses Joomla's standard access levels combined with optional protected product settings:

Joomla Access Levels:

• Public - Anyone can view and download (if guest downloads enabled)
• Registered - Only logged-in users can view and download
• Special - Only users with Author, Editor, or Publisher access
• Custom levels - Any custom access levels you've created

Protected Products:

Add the update server URL to your extension's manifest:

<updateservers>
    <server type="extension" name="Your Extension">
        https://yoursite.com/updates/your-extension?format=xml
    </server>
</updateservers>

The URL format is: /updates/{product-alias}?format=xml

For protected products, add the dlid tag:

<dlid prefix="dlid=" suffix=""/>

This allows Joomla to append the API key when checking for updates.

Create frontend menu items for your releases:

• Go to Menus → [Your Menu] → New
• Select JReleaser → Products for a product listing
• Or select JReleaser → Releases for a specific product's releases
• Configure the Style tab to choose your CSS framework:
  • HTML5 (minimal)
  • Bootstrap 5
  • UIKit 3
  • Foundation 6
  • Tailwind CSS 4
  • Pico CSS 2

Note: The Releases view inherits styling from the parent Products menu item automatically.

The JReleaser content plugin provides shortcodes for displaying download buttons and information:

Basic Usage:

 Download JReleaser Package v1.0.4

This displays a download button for the latest release of product ID 1.

Button Options:

button="large" or button="small"

Change button size

text="Custom Text"

Custom button text

version="hide"

Hide version from button text

metatext="on"

Show "one-time link" notice below button

link="raw"

Return just the download URL (for custom buttons)

Output Options (no button):

output="version"

Returns only the version number

output="created"

Returns the release creation date

output="releasedate"

Returns the manifest creationDate

output="maturity"

Returns maturity level (stable, rc, beta, alpha, dev)

Info with Button:

showversion="on"

Shows version below button

showcreated="on"

Shows release date below button

Display formatted changelogs from XML files:

Using Product ID (Recommended):

{jreleaser_changelog product_id="1"}

This reads the changelog URL from the latest release record.

Using Direct URL:

{jreleaser_changelog link="https://raw.githubusercontent.com/joshgilson/MD-Changelogs/main/md_jreleaser_changelog.xml"}

Options:

version="on"

Returns only "v1.2.3" (with prefix)

version="raw"

Returns only "1.2.3" (no prefix)

date="on"

Returns only the changelog date

latest="on"

Shows only the latest entry instead of full history

Display the logged-in user's API key:

{jreleaser logged-in-user="show" copy="show"}

This displays the user's master API key with a copy-to-clipboard button.

If the user doesn't have an API key yet, one is automatically created.

JReleaser provides two types of API keys:

Master Keys:

• One per user (auto-generated on first access)
• Used for personal downloads
• Displayed via the shortcode or frontend API Keys page

Child Keys:

• Created by users from their master key
• Can be associated with specific websites
• Separate download tracking per key
• Can be enabled/disabled individually

Manage keys at: Components → JReleaser → Keys

Track all downloads at: Components → JReleaser → Downloads

Tracked Information:

• Release and product details
• User ID (if logged in)
• API key used (if applicable)
• IP address
• User agent
• Website (for remote downloads)
• Local vs Remote flag
• Timestamp

Filtering Options:

• By product
• By release
• By date range
• Search by user or IP

Checklist:

• Verify Content plugin is enabled: System → Plugins → Content - JReleaser
• Check that product_id is correct and product is published
• Verify the product has at least one published release
• Check user has access level permission for the product
• Clear Joomla cache: System → Clear Cache

Check Access Levels:

• Verify the product's Access setting matches user permissions
• For Protected products, guests need an API key
• Logged-in users with correct access level can always download

Check Component Options:

• Guest Downloads setting: Components → JReleaser → Options
• If disabled, guests cannot download even Public products

Check Menu Item Configuration:

• Ensure you have a Products menu item with Style set
• Releases view inherits styling from parent Products menu
• If no style selected, defaults to HTML5 (minimal styling)

Available Frameworks:

• HTML5 - Clean, minimal markup
• Bootstrap 5 - Standard Joomla styling
• UIKit 3 - YOOtheme Pro compatible
• Foundation 6
• Tailwind CSS 4
• Pico CSS 2

Verify Update Server URL:

• URL format: https://yoursite.com/updates/{alias}?format=xml
• Test by visiting the URL directly in your browser
• Should display XML with your releases

Check Extension Manifest:

• Ensure <updateservers> section is in manifest
• For protected products, add <dlid prefix="dlid=" suffix=""/>
• Enter API key in: System → Update → Update Sites

Clear Update Cache:

• Go to System → Update → Update Sites
• Select your extension and click Rebuild

Check Changelog URL:

• Using product_id? Verify the release has a changelog_url set
• Using direct link? Test the URL in your browser
• Ensure the XML is valid and accessible

XML Format:

<changelogs>
    <changelog>
        <version>1.0.0</version>
        <date>2025-01-01</date>
        <addition><item>New feature</item></addition>
        <fix><item>Bug fix</item></fix>
    </changelog>
</changelogs>

Supported Tags: addition, change, fix, security, note, remove/removed/deleted