Staff Wiki / Knowledgebase Documentation

Back up your WHMCS files and database before installing or upgrading.

• Extract the download and upload its contents into your WHMCS root, preserving the directory structure. The package contains modules/addons/staff_wiki and includes/whmcsnowcore.php.
• Open System Settings > Addon Modules (Setup > Addon Modules on older installations), activate Staff Wiki and allow access to the required administrator roles.
• Open Addons > Staff Wiki and activate your licence.

For an upgrade, upload the new files over the existing installation. Keep the existing database tables and private upload storage. Existing articles, permissions and settings are preserved; retired editor files are moved to private storage when the upgrade runs. TinyMCE selections switch to Jodit. Do not remove the existing addon or its data to upgrade.

Use the PHP version supported by your WHMCS installation, with a compatible ionCube Loader. Formatted articles require PHP DOM; backups and Office attachments require PHP ZIP. Private file storage must be writable by the account running WHMCS.

Use the green plus icon to create an article or category. Categories can contain subcategories; an article can belong to more than one category.

Open an article and choose Edit. Enter its title, select an editor and save your changes. Staff Wiki includes Jodit, Summernote Lite, Trumbowyg and ContentTools. You can switch editors while editing; review the formatting before saving.

Use the category icon to choose an article's categories. Use the Tags icon to add or remove tags. The icon shows the number of tags.

Search opens from the round search icon. Filters lets you narrow results by author, tags or status. All includes active, archived and trashed articles that you are allowed to access.

History shows earlier saved versions and any available unsaved draft. Restore a saved revision to return to earlier content. A changed article is saved as a new revision; saving without changes does not add another revision.

Draft recovery depends on the browser and device where you were editing. It is a convenience, not a replacement for saving or backups.

Archive removes an article from the normal active list. Move to trash retains it for recovery. Use Filters > Show to find archived or trashed articles, open one and use its Restore action. If another administrator changes an article while you edit it, reload and review the saved version before replacing it.

WHMCS addon access controls which administrator roles can enter Staff Wiki. Wiki permissions then control access to categories and articles.

Use the lock icon to set Read/Write, Read only or No access for administrator roles or individual users. The preview shows the effective result. Child categories and articles can inherit permissions; an explicit article or user rule can override an inherited rule. Check the preview after making a change.

Wiki settings, backups and permission management are restricted to Wiki managers. The Full Administrator role is a manager by default. Read-only users cannot change articles or upload files. Search and file downloads respect article and category access.

While editing, use the paperclip icon to add an image or file. Images can also be inserted using the selected editor's image controls. Wait for uploads to finish before saving.

Settings controls the allowed image and attachment extensions and maximum size per file. The hosting server's PHP upload limits can impose a lower limit. Unsupported or mismatched files are rejected.

Uploads are kept in private whmcsnow-staffwiki-files storage alongside the WHMCS web root, rather than as public attachment links. Access is checked through Staff Wiki. Keep this private directory in your hosting backups.

For older installations, Settings > Maintenance can copy existing images into private storage. Do not delete old uploads or change their paths manually during migration.

Settings lets Wiki managers choose the default editor, interface language, category columns, article ordering, upload extensions and maximum upload size.

The interface supports English, French, German, Spanish and Arabic. Choose Use administrator language to follow the administrator's WHMCS language, with English as the fallback. Arabic uses a right-to-left interface. Changing the interface language does not translate article content.

Backup & Restore remains Beta. Keep an independent hosting/database backup before relying on a restore.

Download backup creates a ZIP containing Wiki articles, categories, permissions, supported settings and uploaded files. It also contains an HTML export of each article for reference. These HTML exports are not a complete standalone website; protected file links still depend on WHMCS. Licence keys are not included.

To restore a current-format Staff Wiki backup, choose Restore backup, select its ZIP and type RESTORE. Restoration replaces Wiki articles, categories, permissions and supported settings. A safety backup is kept privately on the server before changes are applied. Check the restored articles, access rules and attachments afterwards.

The upload limit is 128 MB and server limits may be lower. Old SQL-only backups are not accepted by this restore dialog; ask your hosting administrator to restore those separately. Do not upload an unrelated WHMCS database backup or a ZIP of addon code.