mirror of
https://github.com/stack-auth/stack.git
synced 2026-06-04 21:04:37 +08:00
Update branding from Stack to Stack Auth in documentation (#504)
Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com> Co-authored-by: zai@stack-auth.com <zai@stack-auth.com>
This commit is contained in:
devin-ai-integration[bot]
GitHub
parent
18e68300a4
commit
7920440eb6
4
.github/SECURITY.md
vendored
4
.github/SECURITY.md
vendored
@ -2,9 +2,9 @@
|
||||
|
||||
## Supported Versions
|
||||
|
||||
Only the latest versions of Stack's server and client packages are supported. We do not provide security updates for older versions.
|
||||
Only the latest versions of Stack Auth's server and client packages are supported. We do not provide security updates for older versions.
|
||||
|
||||
If you would like to get security consulting regarding older versions of on-prem or self-hosted deployments of Stack, please [contact us](mailto:team@stack-auth.com).
|
||||
If you would like to get security consulting regarding older versions of on-prem or self-hosted deployments of Stack Auth, please [contact us](mailto:team@stack-auth.com).
|
||||
|
||||
## Reporting a Vulnerability
|
||||
|
||||
|
||||
36
README.md
36
README.md
@ -11,12 +11,12 @@
|
||||
|
||||
Stack Auth is a managed user authentication solution. It is developer-friendly and fully open-source (licensed under MIT and AGPL).
|
||||
|
||||
Stack gets you started in just five minutes, after which you'll be ready to use all of its features as you grow your project. Our managed service is completely optional and you can export your user data and self-host, for free, at any time.
|
||||
Stack Auth gets you started in just five minutes, after which you'll be ready to use all of its features as you grow your project. Our managed service is completely optional and you can export your user data and self-host, for free, at any time.
|
||||
|
||||
We support Next.js frontends, along with any backend that can use our [REST API](https://docs.stack-auth.com/rest-api/overview). Check out our [setup guide](https://docs.stack-auth.com/getting-started/setup) to get started.
|
||||
|
||||
<div align="center">
|
||||
<img alt="Stack Setup" src=".github/assets/create-project.gif" width="400" />
|
||||
<img alt="Stack Auth Setup" src=".github/assets/create-project.gif" width="400" />
|
||||
</div>
|
||||
|
||||
## Table of contents
|
||||
@ -27,7 +27,7 @@ We support Next.js frontends, along with any backend that can use our [REST API]
|
||||
- [How is this different from X?](#how-is-this-different-from-x)
|
||||
- [✨ Features](#-features)
|
||||
- [📦 Installation & Setup](#-installation--setup)
|
||||
- [🌱 Some community projects built with Stack](#-some-community-projects-built-with-stack)
|
||||
- [🌱 Some community projects built with Stack Auth](#-some-community-projects-built-with-stack-auth)
|
||||
- [Templates](#templates)
|
||||
- [Examples](#examples)
|
||||
- [🏗 Development & Contribution](#-development--contribution)
|
||||
@ -62,18 +62,18 @@ To get notified first when we add new features, please subscribe to [our newslet
|
||||
| <h3>Account settings</h3> Lets users update their profile, verify their e-mail, or change their password. No setup required. | <img alt="Account settings component" src=".github/assets/account-settings.png" width="300px"> |
|
||||
| <h3>Multi-tenancy & teams</h3> Manage B2B customers with an organization structure that makes sense and scales to millions. | <img alt="Selected team switcher component" src=".github/assets/team-switcher.png" width="400px"> |
|
||||
| <h3>Role-based access control</h3> Define an arbitrary permission graph and assign it to users. Organizations can create org-specific roles. | <img alt="RBAC" src=".github/assets/permissions.png" width="400px"> |
|
||||
| <h3>OAuth Connections</h3>Beyond login, Stack can also manage access tokens for third-party APIs, such as Outlook and Google Calendar. It handles refreshing tokens and controlling scope, making access tokens accessible via a single function call. | <img alt="OAuth tokens" src=".github/assets/connected-accounts.png" width="250px"> |
|
||||
| <h3>OAuth Connections</h3>Beyond login, Stack Auth can also manage access tokens for third-party APIs, such as Outlook and Google Calendar. It handles refreshing tokens and controlling scope, making access tokens accessible via a single function call. | <img alt="OAuth tokens" src=".github/assets/connected-accounts.png" width="250px"> |
|
||||
| <h3>Passkeys</h3> Support for passwordless authentication using passkeys, allowing users to sign in securely with biometrics or security keys across all their devices. | <img alt="OAuth tokens" src=".github/assets/passkeys.png" width="400px"> |
|
||||
| <h3>Impersonation</h3> Impersonate users for debugging and support, logging into their account as if you were them. | <img alt="Webhooks" src=".github/assets/impersonate.png" width="350px"> |
|
||||
| <h3>Webhooks</h3> Get notified when users use your product, built on Svix. | <img alt="Webhooks" src=".github/assets/stack-webhooks.png" width="300px"> |
|
||||
| <h3>Automatic emails</h3> Send customizable emails on triggers such as sign-up, password reset, and email verification, editable with a WYSIWYG editor. | <img alt="Email templates" src=".github/assets/email-editor.png" width="400px"> |
|
||||
| <h3>User session & JWT handling</h3> Stack manages refresh and access tokens, JWTs, and cookies, resulting in the best performance at no implementation cost. | <img alt="User button" src=".github/assets/user-button.png" width="400px"> |
|
||||
| <h3>User session & JWT handling</h3> Stack Auth manages refresh and access tokens, JWTs, and cookies, resulting in the best performance at no implementation cost. | <img alt="User button" src=".github/assets/user-button.png" width="400px"> |
|
||||
| <h3>M2M authentication</h3> Use short-lived access tokens to authenticate your machines to other machines. | <img src=".github/assets/m2m-auth.png" alt="M2M authentication" width="400px"> |
|
||||
|
||||
|
||||
## 📦 Installation & Setup
|
||||
|
||||
1. Run Stack’s installation wizard with the following command:
|
||||
1. Run Stack Auth's installation wizard with the following command:
|
||||
```bash
|
||||
npx @stackframe/init-stack@latest
|
||||
```
|
||||
@ -87,23 +87,23 @@ To get notified first when we add new features, please subscribe to [our newslet
|
||||
|
||||
Check out the [documentation](https://docs.stack-auth.com/getting-started/setup) for a more detailed guide.
|
||||
|
||||
## 🌱 Some community projects built with Stack
|
||||
## 🌱 Some community projects built with Stack Auth
|
||||
|
||||
Have your own? Happy to feature it if you create a PR or message us on [Discord](https://discord.stack-auth.com).
|
||||
|
||||
### Templates
|
||||
- [Stack Template by Stack Team](https://github.com/stack-auth/stack-auth-template)
|
||||
- [Stack Auth Template by Stack Auth Team](https://github.com/stack-auth/stack-auth-template)
|
||||
- [Next SaaSkit by wolfgunblood](https://github.com/wolfgunblood/nextjs-saaskit)
|
||||
- [SaaS Boilerplate by Robin Faraj](https://github.com/robinfaraj/saas-boilerplate)
|
||||
|
||||
### Examples
|
||||
- [Stack Example by career-tokens](https://github.com/career-tokens/StackYCAuth)
|
||||
- [Stack Demo by the Stack team](https://github.com/stack-auth/stack-auth/tree/dev/examples/demo)
|
||||
- [Stack E-Commerce Example by the Stack team](https://github.com/stack-auth/stack-auth/tree/dev/examples/e-commerce)
|
||||
- [Stack Auth Example by career-tokens](https://github.com/career-tokens/StackYCAuth)
|
||||
- [Stack Auth Demo by the Stack Auth team](https://github.com/stack-auth/stack-auth/tree/dev/examples/demo)
|
||||
- [Stack Auth E-Commerce Example by the Stack Auth team](https://github.com/stack-auth/stack-auth/tree/dev/examples/e-commerce)
|
||||
|
||||
## 🏗 Development & Contribution
|
||||
|
||||
This is for you if you want to contribute to the Stack project or run the Stack dashboard locally.
|
||||
This is for you if you want to contribute to the Stack Auth project or run the Stack Auth dashboard locally.
|
||||
|
||||
**Important**: Please read the [contribution guidelines](CONTRIBUTING.md) carefully and join [our Discord](https://discord.stack-auth.com) if you'd like to help.
|
||||
|
||||
@ -161,7 +161,7 @@ pnpm run prisma migrate dev
|
||||
|
||||
### Chat with the codebase
|
||||
|
||||
Storia trained an [AI on our codebase](https://sage.storia.ai/stack-auth) that can answer questions about using and contributing to Stack.
|
||||
Storia trained an [AI on our codebase](https://sage.storia.ai/stack-auth) that can answer questions about using and contributing to Stack Auth.
|
||||
|
||||
### Architecture overview
|
||||
|
||||
@ -171,16 +171,16 @@ Storia trained an [AI on our codebase](https://sage.storia.ai/stack-auth) that c
|
||||
User((User))
|
||||
Admin((Admin))
|
||||
subgraph "Stack Auth System"
|
||||
Dashboard[Stack Dashboard<br/>/apps/dashboard]
|
||||
Backend[Stack API Backend<br/>/apps/backend]
|
||||
Dashboard[Stack Auth Dashboard<br/>/apps/dashboard]
|
||||
Backend[Stack Auth API Backend<br/>/apps/backend]
|
||||
Database[(PostgreSQL Database)]
|
||||
EmailService[Email Service<br/>Inbucket]
|
||||
WebhookService[Webhook Service<br/>Svix]
|
||||
StackSDK[Client SDK<br/>/packages/stack]
|
||||
subgraph Shared
|
||||
StackUI[Stack UI<br/>/packages/stack-ui]
|
||||
StackShared[Stack Shared<br/>/packages/stack-shared]
|
||||
StackEmails[Stack Emails<br/>/packages/stack-emails]
|
||||
StackUI[Stack Auth UI<br/>/packages/stack-ui]
|
||||
StackShared[Stack Auth Shared<br/>/packages/stack-shared]
|
||||
StackEmails[Stack Auth Emails<br/>/packages/stack-emails]
|
||||
end
|
||||
end
|
||||
Admin --> Dashboard
|
||||
|
||||
@ -4,13 +4,13 @@
|
||||
|
||||
Stack Auth is a managed user authentication solution. It is developer-friendly and fully open-source (licensed under MIT and AGPL).
|
||||
|
||||
Stack gets you started in just five minutes, after which you'll be ready to use all of its features as you grow your project. Our managed service is completely optional and you can export your user data and self-host, for free, at any time.
|
||||
Stack Auth gets you started in just five minutes, after which you'll be ready to use all of its features as you grow your project. Our managed service is completely optional and you can export your user data and self-host, for free, at any time.
|
||||
|
||||
We support Next.js frontends, along with any backend that can use our [REST API](https://docs.stack-auth.com/rest-api/overview). Check out our [setup guide](https://docs.stack-auth.com/getting-started/setup) to get started.
|
||||
|
||||
## 📦 Installation & Setup
|
||||
|
||||
1. Run Stack’s installation wizard with the following command:
|
||||
1. Run Stack Auth's installation wizard with the following command:
|
||||
```bash
|
||||
npx @stackframe/init-stack@latest
|
||||
```
|
||||
|
||||
Loading…
Reference in New Issue
Block a user