@doncicuto/remix-auth-gitlab
TypeScript icon, indicating that this package has built-in type declarations

1.0.0 • Public • Published

GitlabStrategy

The Gitlab strategy for remix-auth is used to authenticate users against a Gitlab account. It extends the OAuth2Strategy.

Supported runtimes

Runtime Has Support
Node.js
Cloudflare

Usage

Create an OAuth application

Follow the steps on the Gitlab documentation to create a new application and get a client ID and secret.

Create the strategy instance

import { GitlabStrategy } from "remix-auth-gitlab";

let gitlabStrategy = new GitlabStrategy(
  {
    clientID: "YOUR_CLIENT_ID",
    clientSecret: "YOUR_CLIENT_SECRET",
    callbackURL: "https://example.com/auth/gitlab/callback",
  },
  async ({ accessToken, extraParams, profile }) => {
    // Get the user data from your DB or API using the tokens and profile
    return User.findOrCreate({ email: profile.emails[0].value });
  }
);

authenticator.use(gitlabStrategy);

Setup your routes

// app/routes/login.tsx
export default function Login() {
  return (
    <Form action="/auth/gitlab" method="post">
      <button>Login with Gitlab</button>
    </Form>
  );
}
// app/routes/auth/gitlab.tsx
import { ActionFunction, LoaderFunction, redirect } from "remix";
import { authenticator } from "~/auth.server";

export let loader: LoaderFunction = () => redirect("/login");

export let action: ActionFunction = ({ request }) => {
  return authenticator.authenticate("gitlab", request);
};
// app/routes/auth/gitlab/callback.tsx
import { LoaderFunction } from "remix";
import { authenticator } from "~/auth.server";

export let loader: LoaderFunction = ({ request }) => {
  return authenticator.authenticate("gitlab", request, {
    successRedirect: "/dashboard",
    failureRedirect: "/login",
  });
};

Aknowledgements

@sergiodxa: for remix-auth, remix-auth-strategy-template and for so many repositories and blog posts that make Remix easier to use and learn.

Package Sidebar

Install

npm i @doncicuto/remix-auth-gitlab

Weekly Downloads

12

Version

1.0.0

License

MIT

Unpacked Size

10.5 kB

Total Files

5

Last publish

Collaborators

  • mcabrerizo