https://github.com/aljawaid/applicationbranding

This plugin will rename your installation to 'My Workspace', and include matching device icons in the site metadata for a better user experience. A revamped login page, with a new Admin Dashboard showing global installation activity data with corrected page titles will give a more professional appeal across the site and when sharing links.
https://github.com/aljawaid/applicationbranding

admin-dashboard branding dashboard html-head kanboard kanboard-plugin logo meta-tags metadata plugin whitelabel

Last synced: 8 months ago
JSON representation

This plugin will rename your installation to 'My Workspace', and include matching device icons in the site metadata for a better user experience. A revamped login page, with a new Admin Dashboard showing global installation activity data with corrected page titles will give a more professional appeal across the site and when sharing links.

• Host: GitHub
• URL: https://github.com/aljawaid/applicationbranding
• Owner: aljawaid
• License: mit
• Created: 2023-01-22T02:56:11.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2024-04-29T08:52:40.000Z (about 2 years ago)
• Last Synced: 2025-06-19T05:05:14.705Z (about 1 year ago)
• Topics: admin-dashboard, branding, dashboard, html-head, kanboard, kanboard-plugin, logo, meta-tags, metadata, plugin, whitelabel
• Language: PHP
• Homepage:
• Size: 21.4 MB
• Stars: 11
• Watchers: 2
• Forks: 1
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Changelog: changelog.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

          
ApplicationBranding



    

        

    

    

        

    

    

        

    

    

        

    

    

        

    





    

        

    

    

        

    

    

        

    

    

        

    



This plugin will rename your installation to \'My Workspace\' and include matching device icons in the site metadata for a better user experience. A revamped login page, with a new Admin Dashboard showing global installation activity data with corrected page titles will give a more professional appeal across the site and when sharing links.

[↓ Bottom] [→ Next] [↑ Top]


## Features

**Rename Application**

- Rename your installation of Kanboard

  - Choose your own site name or use the default `My Workspace`

  - Browser bookmarks and browser tabs now include the site name (overriding the default Kanboard behaviour)

- [Customizer](https://github.com/creecros/Customizer) Compatibility:

  - Browser bookmarks and browser tabs now include the site name (overriding the default Kanboard behaviour)

**Application Metadata**

- Added both HTML and OpenGraph meta tags

- Added the `meta description` tag to show when sharing links on devices

- 30 Favicons included for all common devices (including Android, Apple, Microsoft, WhatsApp)

  - 26 more favicons than Kanboard!

- Include generic logo in the top left corner of the site (header)

- [Customizer](https://github.com/creecros/Customizer) Compatibility:

  - After installing this plugin, Customizer will also show all 30 favicons

  - Customizer will also use the `meta description`

  - Image must be minimum 300px x 300px for OpenGraph (Meta, WhatsApp) sharing to work correctly

**Site Logo**

- A new 'man on a workdesk' icon is used as the site logo, matching the favicons

- [Customizer](https://github.com/creecros/Customizer) Compatibility:

  - After installing this plugin, Customizer will override the 'man on a workdesk' logo according to the user settings

**Manual Edits**

- Added `domain.com/manual-edits` for easier bookmarks and direct links (if url rewriting is enabled)

- Show a comprehensive list of manual changes required for complete Kanboard rebranding

**New Login Page**

- Show User IP Address

- Show application name and copyright

- Include metadata and generic logo (for when sharing links)

- Show Unsplash random image as background or use plain white

- Faster login switching between users by hovering over the username and password fields

- [Customizer](https://github.com/creecros/Customizer) Compatibility:

  - After installing this plugin, Customizer shows the Custom Note feature retaining its hook (`'template:auth:login-form:newbox'`)

**New Reset Password Page**

- Show User IP Address

- Add user friendly page title

- Show application name and copyright

- Include application metadata and generic logo (for when sharing links)

- Show Unsplash random image as background or use plain white

- Move your mouse over the username and captcha fields to automatically save time selecting the field

- [Customizer](https://github.com/creecros/Customizer) Compatibility:

  - After installing this plugin, Customizer will use the meta tags and page title

**New 2FA Page**

- Show User IP Address

- Add user friendly page title

- Include application metadata and generic logo (for code structure and style consistency)

- A complete revamp of the two factor code check page which shows after login

- Added links to cancel the security check by returning to the login page, unlocking the default login-lock behaviour

- Added `domain.com/security-check` for easier bookmarks and direct links (if url rewriting is enabled)

- Move your mouse over the password field to automatically save time selecting the field

**Reset Password Email**

- Show application name and copyright

- [KanboardEmailHistory](https://github.com/aljawaid/KanboardEmailHistory) Compatibility:

  - The footer of the email shows the new application name and copyright year(s)

**Change Password Page**

- _To be completed_

**New About Page**

- New professional look and feel application dashboard for Admins

  - Add metrics for your Kanboard installation on a global level regardless of projects or tasks

  - Show different types of metrics

  - Show template counts from [TemplateManager](https://github.com/aljawaid/TemplateManager) _(if installed)_

- Add new hook

  - `'template:config:about'` is located before the configuration section

- Include relevant links to Kanboard channels in the revamped _Application Platform_ section

- [KanboardSupport](https://github.com/aljawaid/KanboardSupport) Compatibility:

  - Show button for direct link to detailed configuration

**Custom CSS**

- Add custom styles which load in addition to and after the default custom styles

- Head Stylesheet is loaded after all plugins' styles

[↓ Bottom] [← Previous] [→ Next] [↑ Top]


## Screenshots

**Login Page**  

![Login Page](../master/Screenshots/screenshot-login.png "A new user friendly login page")

**2FA Security Check Page**  

![TOTP  Page](../master/Screenshots/screenshot-otp.png "A new user friendly two-factor security check page")

**Reset Password Page**  

![Reset Password Page](../master/Screenshots/screenshot-reset.png "A new user friendly reset password page")

**Page Titles**  

![Page Titles](../master/Screenshots/screenshot-browser-tabs.png "Browser tabs and bookmarks contain the page title")

**Page Titles - _Reset Password_**  

![Reset Password](../master/Screenshots/screenshot-browser-tabs-reset-password.png "Reset password page now includes the page title")

**Settings**  

![Rename Application](../master/Screenshots/screenshot-settings.png "Settings")

**Settings - Metadata**  

![Metadata](../master/Screenshots/screenshot-metadata.png "Metadata")

**Settings - Manual Edits**  

![Manual Edits](../master/Screenshots/screenshot-manual-edits.png "Manual Edits Page")

**About - Admin Dashboard**  

![Admin Dashboard](../master/Screenshots/screenshot-admin-dashboard.png "Admin Dashboard")

**About - Admin Dashboard with TemplateManager**  

![Admin Dashboard with TemplateManager](../master/Screenshots/screenshot-admin-dashboard-icons.png "Admin Dashboard")

[↓ Bottom] [← Previous] [→ Next] [↑ Top]


## Usage

- The Admin Dashboard is shown in `Settings` ⥂ `About`

- Share the login page, reset password page or a public task. Note the icon and meta information.

- The generic My Workspace icon will show in the top header of the site

- Browser page titles and tabs will be more consistent

[↓ Bottom] [← Previous] [→ Next] [↑ Top]


## Installation & Compatibility



    

        

    

    

        

    

    

        

    

    

        

    



    Installation

- Install via the **[Kanboard](https://github.com/kanboard/kanboard "Kanboard - Kanban Project Management Software") Plugin Directory** or see [INSTALL.md](../master/INSTALL.md)

- Read the full [**Changelog**](../master/changelog.md "See changes") to see the latest updates

**Content Security Policy - CSP Server Configuration**

If icons or Unsplash images are not displaying you may need to set the CSP on your server. Add the line below in the `.htaccess` file found in the root directory of your Kanboard installation.

```apache

Header set Content-Security-Policy "default-src 'self' 'unsafe-inline'; script-src 'self' 'unsafe-inline' https; connect-src 'self'; img-src 'self' data:; style-src 'unsafe-inline' https *; base-uri 'self'; form-action 'self'; frame-src 'self' https; child-src 'self';"

```

    Compatibility

- Requires [Kanboard](https://github.com/kanboard/kanboard "Kanboard - Kanban Project Management Software") ≥`1.2.20`

- **Other Plugins & Action Plugins**

  - _No known issues_

  - Compatible with [KanboardEmailHistory](https://github.com/aljawaid/KanboardEmailHistory), [AutomaticActionUX](https://github.com/aljawaid/AutomaticActionUX), [PluginManager](https://github.com/aljawaid/PluginManager), [TagManager](https://github.com/aljawaid/TagManager), [KanboardSupport](https://github.com/aljawaid/KanboardSupport), [Customizer](https://github.com/creecros/Customizer), [TemplateManager](https://github.com/aljawaid/TemplateManager)

- **Core Files & Templates**

  - `08` Template overrides

  - _No database changes_

    Translations

- English (UK)

- _Starter template available_

[↓ Bottom] [← Previous] [→ Next] [↑ Top]


## Authors & Contributors

- [@aljawaid](https://github.com/aljawaid) - Author

- _Contributors welcome_

[↓ Bottom] [← Previous] [↑ Top]


## License

- This project is distributed under the [MIT License](../master/LICENSE "Read The MIT license")

---



    

        

    

    

        

    

    

        

    

    

        

    

    

        

    

    

        

    

    

        

    





[↑ Top]