Skip to content

Commit

Permalink
docs(README.md): update README with new configuration variables and r…
Browse files Browse the repository at this point in the history
…emove unused ones

fix(auth.ts): remove unused parameters from signIn callback function
  • Loading branch information
masterkain committed May 20, 2023
1 parent f38ab0c commit a6210ca
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 11 deletions.
14 changes: 4 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,11 +25,11 @@ Warning: alpha software, use at your own risk.
- :robot: Ask AI about issues
- :clipboard: Provide cURL command to reproduce HTTP exceptions
- :arrow_forward: Replay HTTP exceptions
- :key: Authentication with differenrt OAuth providers

## Roadmap

- :pencil2: Logo
- :key: Potential integration of OAuth authentication
- :bar_chart: Charting of error frequency over time
- :recycle: Autodeletion of old errors
- :bell: Implementation of notifications via webhooks
Expand Down Expand Up @@ -187,6 +187,8 @@ spec:
### Setup
Please view all the available configuration variables in the [`.env.dist`](https://github.com/icoretech/airbroke/blob/main/.env.dist) file.

Airbroke requires some environment variables set at runtime, `DATABASE_URL` and `DIRECT_URL` are mandatory, some examples:

```sh
Expand Down Expand Up @@ -224,14 +226,6 @@ After deployment, you should be able to access your ingress (preferably secured
This process will generate an API key that you can use with your Airbrake-compatible clients.
This key, along with other essential information, will be provided to you.

Other options include:

```sh
CORS_ORIGINS="https://airbroke.mydomain.com" # comma separated list of origins, if missing '*' is used
OPENAI_API_KEY="sk-xxxx" # OpenAI API Key
OPENAI_ORGANIZATION="" # OpenAI Organization
```

### About pgBouncer

To optimize your experience with Airbroke, as well as with Postgres overall, we advise integrating pgBouncer into your tech stack in transaction mode. Don't forget to correctly set the connection flags in your DATABASE_URL. This ensures that the connection pooler will be utilized (for example, `?pgbouncer=true&connection_limit=10`) and that the necessary `DEALLOCATE` commands will be executed by Prisma. For more comprehensive information, we recommend reviewing [Prisma's Connection Management documentation](https://www.prisma.io/docs/guides/performance-and-optimization/connection-management#external-connection-poolers), which provides insights on external connection poolers.
Expand All @@ -242,7 +236,7 @@ The DIRECT_URL should be configured to establish a direct connection to the data

### Vercel

[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Ficoretech%2Fairbroke%2Ftree%2Fmain&env=DATABASE_URL,DIRECT_URL&project-name=airbroke&repository-name=airbroke)
[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Ficoretech%2Fairbroke%2Ftree%2Fmain&env=DATABASE_URL,DIRECT_URL,NEXTAUTH_SECRET,NEXTAUTH_URL&project-name=airbroke&repository-name=airbroke)

While [testing on Vercel](https://nextjs.org/learn/basics/deploying-nextjs-app/platform-details) has not been conducted, Airbroke should be fully compatible.

Expand Down
2 changes: 1 addition & 1 deletion lib/auth.ts
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ export const authOptions: NextAuthOptions = {
debug: process.env.NEXTAUTH_DEBUG === "true",
providers: getProviders(),
callbacks: {
async signIn({ user, account, profile, email, credentials }) {
async signIn({ account, profile }) {
const extendedProfile = profile as ExtendedProfile;

if (account?.provider === "google" && process.env.GOOGLE_DOMAINS) {
Expand Down

0 comments on commit a6210ca

Please sign in to comment.