Skip to content

docs: clarify User model + AUTH_MODEL behaviour #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Ynitial wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: clarify User model + AUTH_MODEL behaviour #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 15 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,23 @@

Welcome on stage.

This is the template repository for installing new websites with [https://github.com/backstagephp/cms](Backstage).
This is the template repository for installing new websites with [Backstage](https://github.com/backstagephp/cms).

```
composer create-project backstage/stage
```

Or use the [backstage installer](https://github.com/backstagephp/installer).
Or use the [backstage installer](https://github.com/backstagephp/installer).

## Authentication

Backstage's `User` model is loaded by default — `config/auth.php` reads
the model from the `AUTH_MODEL` env var, which the installer sets to
`\Backstage\Models\User` automatically. You don't need to create
`app/Models/User.php` for typical projects.

If you do create your own User class to add project-specific fields
or behaviour, extend `\Backstage\Models\User` and **don't** add
`protected $guarded = [];` — the parent class declares an explicit
`$fillable` whitelist, and an empty `$guarded` overrides it and
reintroduces mass-assignment risk.