next-auth-example-knex is a modification of the next-auth-example sample project provided by NextAuth.js that uses the Knex library for database access.
In addition to using Knex, it has e-mail-based login enabled using Nodemailer. NextAuth.js requires a persistent database storage to be configured to enable e-mail-based authentication, so enabling database backend goes hand-in-hand with enabling e-mail authentication in NextAuth.js.
I have tested this sample project with SQLite 3 and e-mail and Google authentication methods enabled, and it appears to work, but it hasn't been extensively tested. I make this code publicly available in hope that it might save another person looking to make NextAuth.js work with Knex a bit of time.
The NextAuth.js adapter for Knex is implemented in knex-adapter/index.ts.
I do not intend to actively maintain this code.
Open Source. Full Stack. Own Your Data.
NextAuth.js is a complete open-source authentication solution.
This is an example application that shows how next-auth is applied to a basic Next.js app.
The deployed version can be found at next-auth-example.vercel.app
Go to next-auth.js.org for more information and documentation.
git clone https://github.com/nextauthjs/next-auth-example.git
cd next-auth-example
npm install
Copy the .env.local.example file in this directory to .env.local (which will be ignored by Git):
cp .env.local.example .env.local
Add details for one or more providers (e.g. Google, Twitter, GitHub, Email, etc).
A database is needed to persist user accounts and to support email sign in. However, you can still use NextAuth.js for authentication without a database by using OAuth for authentication. If you do not specify a database, JSON Web Tokens will be enabled by default.
You can skip configuring a database and come back to it later if you want.
For more information about setting up a database, please check out the following links:
-
Review and update options in
pages/api/auth/[...nextauth].jsas needed. -
When setting up OAuth, in the developer admin page for each of your OAuth services, you should configure the callback URL to use a callback path of
{server}/api/auth/callback/{provider}.
e.g. For Google OAuth you would use: http://localhost:3000/api/auth/callback/google
A list of configured providers and their callback URLs is available from the endpoint /api/auth/providers. You can find more information at https://next-auth.js.org/configuration/providers/oauth
- You can also choose to specify an SMTP server for passwordless sign in via email.
To run your site locally, use:
npm run dev
To run it in production mode, use:
npm run build
npm run start
Follow the Deployment documentation or deploy the example instantly using Vercel
Thanks to Vercel sponsoring this project by allowing it to be deployed for free for the entire Auth.js Team
