silverstripe/login-forms

A collection of templates for the CMS login screens

5.3.0-rc1 2024-09-01 22:15 UTC

Requires

• php: ^8.1
• silverstripe/framework: ^5

Requires (Dev)

• phpstan/extension-installer: ^1.3
• phpunit/phpunit: ^9.6
• silverstripe/standards: ^1
• squizlabs/php_codesniffer: ^3.7

BSD-3-Clause

• template
• login
• silverstripe
• styling

README

Overview

The Silverstripe Login Forms module provides templates for the login screen.

Silverstripe CMS defaults to using the standard Page.ss template for login forms, and is usually customised through the Layout/Security.ss template. This module overrides any template or theme inheritance, and uses its own Security.ss template, in order to provide consistent styling and behaviour that's independent from the specifics in your project. This enables more sophisticated login styling, such as multi-factor authentication through silverstripe/mfa.

Installation

composer require silverstripe/login-forms

Usage

Customising your brand

Even though this template is generic, it's often a good idea to add your own logo in order to make your login forms more recognisable for your users. This can also help to prevent generic phishing attempts.

Define an app/templates/Includes/AppBrand.ss template and add your own logo. Example:

<img class="app-brand__logo" src="logo.png" alt="$SiteConfig.Title" />

Replacing templates

In the unlikely case that you want to re-introduce some customisations into this new template, you can give priority to your own project templates ($default), or your theme templates.

---
Before:
  - '#login-forms'
---
SilverStripe\LoginForms\EnablerExtension:
  login_themes:
    - '$default'
    - 'mytheme'

Caution: Replacing the Security.ss template is not recommended, since it might change in the future.

Dark mode

The login form includes a dark mode by default for users who prefer it. However, if your site is not designed for dark mode yet, you can disable this functionality by disabling it in your yaml configuration:

SilverStripe\Security\Security:
  enable_dark_mode: false

Contributing

Contributions are welcome! Create an issue, explaining a bug or propose development ideas. Find more information on contributing in the Silverstripe CMS developer documentation.

Reporting Issues

Please create an issue for any bugs you've found, or features you're missing.