Reseller / White-Label Edition Guide

This guide is for purchasers of the Reseller / White-Label edition of Academy & Exam OS. If you only want to brand your own installation, see White-Label & Branding.

Important: Your rights are defined by RESELLER-LICENSE.html and LICENSE.html in your download. This page summarises the practical steps; it does not replace or extend those documents. Where they differ from this page, the licence documents govern.

What the edition contains #

• The web application as readable source, without any licence-key check or contact with a licence server. The purchase itself is the entitlement; there is no activation.
• The Flutter app source for Android and iOS.
• The documentation, plus three edition-only documents: RESELLER-LICENSE.html, WHITE-LABEL-GUIDE.html and BRANDING-GUIDE.html.

The installer is the same as in the other editions, without the licence phase. See Installing Academy & Exam OS.

Key licence conditions #

As stated in RESELLER-LICENSE.html, in summary:

• You may resell the software to your own customers under your own commercial terms, white-label it, rename it, modify and customise the source, and deploy it for your own business and your clients.
• Reseller rights are non-transferable. You may sell installations and usage rights of your edition to your customers, but you may not transfer, sublicense or resell the reseller right itself. Each new reseller must obtain their own Reseller / White-Label licence from OsDot Solutions.
• You are responsible for supporting your own customers. OsDot Solutions supports you under the support option you chose, not your customers.
• You must keep the third-party notices (THIRD-PARTY-LICENSES.html) with every copy you distribute.
• You may not present OsDot Solutions as the author or supporter of a modified edition, or use OsDot trademarks for your edition without written agreement.
• The software remains the intellectual property of OsDot Solutions. White-labelling changes what end users see; it does not transfer ownership.

Read the full terms in your download and the general OsDot License Agreement.

Two layers of identity #

1. Institute identity — what one installation shows its students: site name, logo, colours, contact details and legal pages. Each installation’s owner sets this in the staff area without code. See White-Label & Branding. Nothing here needs to change for white-labelling.
2. Product identity — the software’s own name, version and publisher, shown on the installer, the About-this-software page and the console. This is what you change to create your edition.

The Powered by OsDot™ attribution belongs to neither layer. In the public website footer it is a website setting (on by default) that each site owner can switch off; in the staff area footer it is part of the software and has no setting.

Change the product identity #

The product identity lives in one file: Web/config/product.php. The package label that the installer and the About page also show is set separately: see Change the package label below.

return [
    'name' => 'Your Edition Name',
    'slug' => 'your-edition-name',
    'description' => 'Coaching, Learning & Examination Platform',
    'version' => '1.0.2',
    'publisher' => 'Your Company',
    'website' => 'your-company.example',
    'website_url' => 'https://your-company.example',
];

Keep a MAJOR.MINOR.PATCH version, a non-empty name and publisher, and an https:// website address; the application checks the file when it starts. Every page, the installer and the console read the product identity from this file.

Choose a product name that does not use the OsDot Solutions or Academy & Exam OS names or marks, and use the same name in product.php, your documentation and your store listing.

Change the package label #

One line does not come from product.php: the package label. Our release tooling writes it into Web/config/package.php of your download:

return [
    'variant' => 'reseller',
    'label' => 'Academy & Exam OS - Reseller / White-Label package',
    'built_at' => '…',
    'build' => '…',
];

The label is display-only: it decides no behaviour. Until you change it, the original name appears on:

• every page of the browser installer (in the header) and the Package row of its Welcome step;
• Staff → About this software, the Package row (visible to owners, administrators and teachers);
• the output of the command-line installer.

Students, the public website and the mobile app never show it.

To rename it, change only the label value, for example to 'Your Edition Name - Reseller package':

• Keep variant as reseller and the label non-empty. The installer and the About page read this file and stop with an error if either is invalid.
• Keep built_at and build: they identify the OsDot package your edition is built from. Quote the original package name and build when you contact OsDot for support.
• Every OsDot package contains its own package.php. Repeat the change, together with your product.php changes, each time you build your edition from a newer package.

Changing the label and the product identity does not change OsDot’s attribution and notices:

• The Powered by OsDot™ line stays as described above. In the staff area footer it is part of the software and has no setting; in the public website footer it is a website setting that each site owner can switch off.
• Keep the third-party notices (THIRD-PARTY-LICENSES.html) with every copy you distribute, and the copyright notices inside third-party files.
• Do not remove or alter copyright notices in the Software. The Software remains the intellectual property of OsDot Solutions (LICENSE.html, RESELLER-LICENSE.html).
• Your label names your edition. It must not present OsDot as the author or supporter of a modified edition, or use OsDot trademarks without written agreement.

Other places to review #

When you change colours, keep sufficient contrast (WCAG AA: 4.5:1 for body text) and test on a phone and a desktop. The bundled fonts (Raleway and Inter, SIL Open Font Licence 1.1) and Bootstrap Icons (MIT) keep their own licence notices.

Replace screenshots in your documentation with captures of your own edition; do not reuse OsDot captures that show the original product name.

The mobile app #

The Flutter app has its own brand profile: the institute name, brand key, HTTPS API address and deployment ID of each customer’s website, plus the application ID and icons. See Flutter Mobile App — Setup & Configuration.

Package your edition #

1. Distribute the contents of Web/ — never a live installation. config/app_local.php, config/installed.php and storage/ belong to one installation only.
2. Include your own documentation and the third-party notices (THIRD-PARTY-LICENSES.html).
3. Remove this package’s Documentation/, manifest.json and checksums.txt if you produce your own, or regenerate the checksums for your edition.

What you must keep #

• the third-party licence notices;
• the copyright notices inside third-party files;
• the installer’s security checks (HTTPS, database privileges, setup token) — they protect your customers.

Support #

You support your customers. When you contact OsDot Solutions, reference the original package name and version (for example Academy & Exam OS 1.0.2, Reseller / White-Label edition), even if your edition carries another name. See Support Options.

Related documents #

• White-Label & Branding
• Installing Academy & Exam OS
• What reseller rights allow

Watch the Video Tutorial #

Academy & Exam OS Video Tutorial 13: Reseller / White-Label Edition Guide shows this topic step by step (5:51).

Watch on YouTube · All Academy & Exam OS video tutorials