Skip to content

Commit 21ec39e

Browse files
authored
chore: update readme (logto-io#7107)
1 parent d1c4620 commit 21ec39e

5 files changed

+77
-56
lines changed

README.md

+77-56
Original file line numberDiff line numberDiff line change
@@ -18,91 +18,112 @@
1818

1919
# Logto
2020

21-
Logto[^info] is an open-source identity and access management infrastructure for modern apps and SaaS products, supporting OIDC, OAuth 2.0 and SAML open standards for authentication and authorization.
21+
Logto is the open-source auth alternative to Auth0, Cognito, and Firebase. It offers a complete identity solution with pre-built UI, modern protocols for authentication and authorization (OIDC/OAuth 2.0/SAML), and enterprise-grade security. Perfect for multi-device apps, SaaS products, and API services.
2222

23-
## Key features
23+
<p align="center">
24+
<a href="https://logto.io/">Website</a> |
25+
<a href="https://cloud.logto.io/">Live demo</a> |
26+
<a href="https://docs.logto.io">Documentation</a> |
27+
<a href="https://openapi.logto.io/">API</a> |
28+
<a href="https://blog.logto.io/">Blog</a> |
29+
<a href="https://auth-wiki.logto.io/">Auth Wiki</a> |
30+
<a href="https://logto.io/subscribe">Newsletter</a>
31+
</p>
2432

25-
### 🧑‍💻 Comprehensive frontend-to-backend identity solutions
33+
![Logto features](./assets/logto-features.jpg)
2634

27-
- Enables OpenID Connect (OIDC) based authentication and authorization with Logto SDKs.
28-
- Supports passwordless sign-in, along with various options like email, phone number, username, Google, Facebook, and other social sign-in methods.
29-
- Offers beautiful prebuilt UI with customizable options to suit your business needs.
35+
## Why Logto?
3036

31-
### 📦 Out-of-the-box infrastructure
37+
Logto provides frontend-to-backend identity solutions for developers and enterprise with:
3238

33-
- Includes a ready-to-use [Management API](https://openapi.logto.io/) that allows you to build customized functionality on top of Logto.
34-
- Provides various [official SDKs and guides](https://docs.logto.io/quick-starts) that help you integrate your apps with Logto across multiple platforms and languages.
35-
- Offers flexible [social and message connectors](https://docs.logto.io/integrations) that can be used for one-click social sign-ins and customized with SAML, OAuth, and OIDC protocols.
39+
- **Logto Console**: A web-based interface for configuring and manage resources, offering a quick setup for sign-in experience and easy identity-management.
40+
- **End-user experience**: Beautiful, out-of-the-box, complete authentication flows with full customization.
41+
- **Logto APIs**: Logto’s backend offers a suit of APIs to facilitate various AuthN and AuthZ functionalities.
42+
- **SDKs**: SDKs for 30+ frameworks, Machine-to-machine and CLI tools.
43+
- **Enterprise-grade security**: MFA, SSO, RBAC, multi-tenancy isolation, and audit logs.
3644

37-
### 💻 Enterprise-ready solutions
45+
## Key features
3846

39-
- Implements [role-based access control (RBAC)](https://docs.logto.io/authorization/role-based-access-control) for scalable authorization.
40-
- [Organizations](https://docs.logto.io/organizations/understand-how-organizations-work) is the way to build [multi-tenancy](https://blog.logto.io/tenancy-models) apps with ease.
41-
- Enables user management with [audit logs](https://docs.logto.io/developers/audit-logs) to track identity-related activities and maintain security.
42-
- Provides [single sign-on (SSO)](https://docs.logto.io/end-user-flows/enterprise-sso) and [multi-factor authentication (MFA)](https://docs.logto.io/end-user-flows/mfa) without coding.
47+
| **Authentication** | **Authorization** | **Identity management** |
48+
| --- | --- | --- |
49+
| Email/SMS passwordless | API protection | Identity federation (Omni sign-in for multiple apps) |
50+
| Social sign-in (OIDC/OAuth 2.0) | User role-based access control | Multi-tenancy management (Invitation/JIT/Org-level MFA) |
51+
| Enterprise SSO (SAML/OIDC) | M2M role-based access control | User management (Profile/Invitation/Migration) |
52+
| MFA (TOTP/Passkey/Backup) | Organization templates | User Impersonation |
53+
| Personal access token | JWT / Opaque toke validation | Audit Logs |
54+
| OAuth consent screen | Custom token claims | Webhooks |
4355

44-
## Get started
56+
**UI toolkit:** Prebuilt auth flows • Custom UI • Dark mode • i18n • Custom domain
4557

46-
### Logto Cloud
58+
[🗺️ View all features→](https://logto.io/pricing#compare-features)
4759

48-
Try [Logto Cloud](https://cloud.logto.io/?sign_up=true&utm_source=github&utm_medium=repo_logto) to start the Logto journey with zero deployment overhead.
60+
## Get started in 60s
4961

50-
### GitPod
62+
Start building with Logto in minutes:
5163

52-
You can launch Logto [via GitPod](https://gitpod.io/#https://github.com/logto-io/demo). Please wait for the message `App is running at https://3002-...gitpod.io` to appear in the terminal, press Command on macOS or Ctrl on Windows, then click the URL starting with `https://3002-` to continue your Logto journey.
64+
- **GitPod:** [Launch Logto on GitPod](https://gitpod.io/#https://github.com/logto-io/demo). Wait for the message `App is running at https://3002-...gitpod.io` , then click the URL starting with `https://3002-` to continue.
65+
- **Local development:**
66+
```bash
67+
# Using Docker Compose(requires Docker Desktop)
68+
curl -fsSL https://raw.githubusercontent.com/logto-io/logto/HEAD/docker-compose.yml | \
69+
docker compose -p logto -f - up
70+
71+
# Using Node.js (requires PostgreSQL)
72+
npm init @logto
73+
```
74+
75+
- **Logto Cloud:** No deployment required! Get started with [Logto Cloud](https://cloud.logto.io/?sign_up=true&utm_source=github&utm_medium=repo_logto).
5376

54-
### Docker Compose
77+
[📚 Full installation guide →](https://docs.logto.io/logto-oss/get-started-with-oss)
5578

56-
Docker Compose CLI usually comes with [Docker Desktop](https://www.docker.com/products/docker-desktop).
79+
## Integration ecosystem
5780

58-
```bash
59-
curl -fsSL https://raw.githubusercontent.com/logto-io/logto/HEAD/docker-compose.yml | \
60-
docker compose -p logto -f - up
61-
```
81+
Powered by industry-standard protocols (OIDC, OAuth, SAML), Logto empowers secure integration across your services, third-party platforms, and identity providers.
6282

63-
### npm-init
83+
**Unlimited application integration:**
6484

65-
Requires [Node.js](https://nodejs.org/) `^20.9.0` + [PostgreSQL](https://postgresql.org/) `^14.0`.
85+
- **SDKs and guides**: Android, Angular, React, Next.js, Flutter, Go, Python, Vue, and 30+ more.
86+
- **Custom integration**: Traditional web, SPAs, Native apps, M2M apps, OAuth third-party apps, and SAML apps.
6687

67-
```bash
68-
npm init @logto
69-
```
88+
[📚 Explore quick starts →](https://docs.logto.io/quick-starts)
7089

71-
## Language support
90+
**Universal identity provider (IdP) connection:**
7291

73-
```ts
74-
const languages = ['Deutsch', 'English', 'Español', 'Français', 'Italiano', '日本語', '한국어', 'Polski', 'Português', 'Русский', 'Türkçe', '简体中文', '繁體中文'];
75-
```
92+
- **Social sign-in**: Google, Facebook, Apple, Microsoft, GitHub, Line, and more. Fully customizable via OIDC/OAuth 2.0.
93+
- **Enterprise Single Sign-On**: Azure AD, Google Workspace, Okta, and more. Fully customizable via OIDC/SAML.
7694

77-
## Web compatibility
95+
[📚 Explore all connectors →](https://docs.logto.io/integrations)
7896

79-
Logto uses the [default browserslist config](https://github.com/browserslist/browserslist#full-list) to compile frontend projects, which is:
97+
## Showcase
8098

81-
```
82-
> 0.5%, last 2 versions, Firefox ESR, not dead
83-
```
99+
**Developer-friendly SDKs**: Install in minutes with step-by-step guides.
84100

85-
## Bug report, feature request, feedback
101+
![Logto auth SDK showcase](./assets/showcase-logto-auth-sdks.gif)
86102

87-
- Our team takes security seriously, especially when it relates to identity. If you find any existing or potential security issues, please do not hesitate to email 🔒 [[email protected]](mailto:[email protected]).
88-
- About other bug reports, feature requests, and feedback, you can:
89-
- Directly 🙋 [open an issue](https://github.com/logto-io/logto/issues/new) on GitHub if you find a bug.
90-
- 💬 [Join our Discord server](https://discord.gg/vRvwuwgpVX) to have a live chat.
91-
- 📧 [Subscribe to our newsletter](https://logto.io/subscribe) to stay tuned on our latest articles and updates.
103+
**User-friendly auth flows**: Sign-up, sign-in, Social sign-in, Google one-tap, SSO, MFA, etc.
92104

93-
## Licensing
105+
![Logto sign-in experience showcase](./assets/showcase-logto-sign-in-exeperience.gif)
94106

95-
[MPL-2.0](LICENSE).
107+
**Multi-tenancy architecture**: organization RBAC, member invitations, just-in-time provision, etc.
96108

97-
## Contributing
109+
![Logto multi-tenancy showcase](./assets/showcase-logto-multi-tenancy.gif)
98110

99-
We have a [contributing guideline](https://github.com/logto-io/logto/blob/master/.github/CONTRIBUTING.md) available. Feel free to reach out to us before coding.
111+
## Support Logto
100112

101-
## Resources
113+
If you find Logto helpful, here's how you can support us:
102114

103-
- [📚 Logto docs](https://docs.logto.io/?utm_source=github&utm_medium=repo_logto) for
104-
- [📝 Logto blog](https://blog.logto.io/?utm_source=github&utm_medium=repo_logto) for in-depth articles, tutorials, and updates.
105-
- [🔗 Logto API](https://openapi.logto.io/?utm_source=github&utm_medium=repo_logto)
106-
- Check out our [awesome list](./AWESOME.md) of community-contributed resources.
115+
-**Star this repo** to show your support!
116+
- 💬 [Join our Discord](https://discord.gg/vRvwuwgpVX) for live discussions.
117+
- 📢 Share Logto on [Twitter](https://twitter.com/intent/tweet?text=Hey%20devs%21%20Need%20a%20better%20auth%20solution%3F%20Check%20out%20%40logto_io%20%E2%80%94%20it%E2%80%99s%20like%20Auth0%2FCognito%2FFirebase%20but%20open-source%2C%20modern%2C%20and%20way%20easier%20to%20use%21%20Supports%20OIDC%2C%20OAuth%202.0%2C%20SAML%2C%20and%20also%20works%20perfectly%20for%20SaaS%20apps.%20%E2%9C%A8%20https%3A%2F%2Flogto.io%20%23Auth%20%23Identity%20%23OpenSource%20%23DevTools), [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Flogto.io), [Reddit](https://reddit.com/submit?url=https%3A%2F%2Flogto.io&title=Tired%20of%20Auth0%2FCognito%2FFirebase%3F%20Logto%20is%20the%20open-source%20auth%20alternative%20you%E2%80%99ve%20been%20missing%21%20Supports%20OIDC%2C%20OAuth%202.0%2C%20SAML%2C%20and%20works%20like%20magic%20for%20modern%20apps%20and%20SaaS%20products.), [Telegram](https://t.me/share/url?url=https%3A%2F%2Flogto.io&text=Check%20out%20Logto%20%E2%80%94%20the%20better%20auth%20and%20identity%20infrastructure%21%20Open-source%2FCloud%20alternative%20to%20Auth0%2C%20Cognito%2C%20and%20Firebase.%20Supports%20all%20the%20standards%20%28OIDC%2C%20OAuth%2C%20SAML%29%20and%20is%20perfect%20for%20modern%20apps%20or%20SaaS%20products.%20https%3A%2F%2Flogto.io), [WhatsApp](https://api.whatsapp.com/send?text=Hey%21%20%F0%9F%91%8B%20Found%20this%20awesome%20auth%20tool%20called%20%2ALogto%2A%20%E2%80%94%20it%E2%80%99s%20open-source%2C%20way%20simpler%20than%20Auth0%2FCognito%2FFirebase%2C%20and%20supports%20OIDC%2FOAuth%2FSAML.%20Perfect%20for%20building%20CIAM%20system%20without%20the%20hassle.%20You%20gotta%20try%20it%3A%20https%3A%2F%2Flogto.io).
118+
- 🏆 Write a review or tutorial on [Dev.to](https://dev.to/logto), [Medium](https://medium.com/@logto), [G2](https://www.g2.com/products/logto/reviewer_verification) or your blog.
119+
- 💬 [Share your use case](mailto:[email protected]?subject=[Share%20Logto%20User%20Story]) with us and get featured on the [Logto website](https://logto.io/).
120+
- 🙋 [Open an issue](https://github.com/logto-io/logto/issues/new) to report bugs or suggest features.
121+
- 💻 [Contribute to Logto](https://github.com/logto-io/logto/blob/master/.github/CONTRIBUTING.md) - we'd love your help! Check out [Logto awesome](https://github.com/logto-io/logto/blob/master/AWESOME.md) of community-contributed resources.
107122

108-
[^info]: Designed by Silverhand Inc.
123+
## Licensing
124+
125+
[MPL-2.0](LICENSE).
126+
127+
<p align="right">
128+
⬆️ <a href="#logto">Back to top</a>
129+
</p>

assets/logto-features.jpg

122 KB
Loading

assets/showcase-logto-auth-sdks.gif

9 MB
Loading
7.24 MB
Loading
11.4 MB
Loading

0 commit comments

Comments
 (0)