Skip to content
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

docs: refactor passport doc #5640

Merged
merged 1 commit into from
Jun 5, 2020
Merged

docs: refactor passport doc #5640

Show file tree
Hide file tree
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
5 changes: 2 additions & 3 deletions docs/site/Authentication-overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,5 @@ we've broken down the documentations into several parts:
authentication.
- [**How to create your own authentication strategy**](missing_link):
Particularly for extension developers.
- [Use [**Passport**](https://www.npmjs.com/package/passport)
strategies](missing link): The usage of passport adapter module
`@loopback/authentication-passport`.
- [Use [**Passport**](https://www.npmjs.com/package/passport) strategies](Authentication-passport.md):
The usage of passport adapter module `@loopback/authentication-passport`.
12 changes: 10 additions & 2 deletions extensions/authentication-passport/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,21 @@
# Passport Strategy Adapter

_Important: We strongly recommend that users learn LoopBack's
[authentication system](https://loopback.io/doc/en/lb4/Loopback-component-authentication.html)
[authentication system](https://loopback.io/doc/en/lb4/Authentication-overview.html)
before using this module._

This is an adapter module created for plugging in
LoopBack 4 authentication system is highly extensible and give users the
flexibility to provide custom strategies. To be compatible with over 500+
Express [`passport`](https://www.npmjs.com/package/passport) middleware, this
adapter module is created for plugging in
[`passport`](https://www.npmjs.com/package/passport) based strategies to the
authentication system in `@loopback/[email protected]`.

If you would like to try with an example,
[`@loopback/example-passport-login`](https://github.com/strongloop/loopback-next/tree/master/examples/passport-login)
uses this module to authenticate APIs with several OAuth 2.0 passport strategies
like Facebook, Google.

## Installation

```sh
Expand Down