Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mtchavez/ueberauth_gitlab
Gitlab OAuth2 Strategy fo Überauth
https://github.com/mtchavez/ueberauth_gitlab
elixir elixir-oauth gitlab gitlab-oauth ueberauth ueberauth-gitlab ueberauth-strategies
Last synced: 14 days ago
JSON representation
Gitlab OAuth2 Strategy fo Überauth
- Host: GitHub
- URL: https://github.com/mtchavez/ueberauth_gitlab
- Owner: mtchavez
- License: other
- Created: 2017-11-06T01:02:57.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2022-01-10T19:45:53.000Z (almost 3 years ago)
- Last Synced: 2024-11-19T18:09:00.813Z (about 1 month ago)
- Topics: elixir, elixir-oauth, gitlab, gitlab-oauth, ueberauth, ueberauth-gitlab, ueberauth-strategies
- Language: Elixir
- Homepage:
- Size: 146 KB
- Stars: 7
- Watchers: 2
- Forks: 7
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Überauth Gitlab
[](https://hex.pm/packages/ueberauth_gitlab_strategy)
[](https://travis-ci.org/mtchavez/ueberauth_gitlab)
[](https://coveralls.io/github/mtchavez/ueberauth_gitlab?branch=master)
[](https://hexdocs.pm/ueberauth_gitlab_strategy/)
> Gitlab OAuth2 strategy for Überauth.
## Installation
1. Setup your application in Gitlab under your profile [applications menu][gitlab-apps]
1. Add `:ueberauth_gitlab_strategy` to your list of dependencies in `mix.exs`:
```elixir
def deps do
[{:ueberauth_gitlab_strategy, "~> 0.4"}]
end
```
1. Add the strategy to your applications:
```elixir
def application do
[applications: [:ueberauth_gitlab_strategy]]
end
```
1. Add Gitlab to your Überauth configuration:
```elixir
config :ueberauth, Ueberauth,
providers: [
identity: { Ueberauth.Strategy.Identity, [
callback_methods: ["POST"],
uid_field: :email,
nickname_field: :username,
] },
gitlab: {Ueberauth.Strategy.Gitlab, [default_scope: "read_user"]},
]
```
1. Update your provider configuration:
```elixir
config :ueberauth, Ueberauth.Strategy.Gitlab.OAuth,
client_id: System.get_env("GITLAB_CLIENT_ID"),
client_secret: System.get_env("GITLAB_CLIENT_SECRET"),
redirect_uri: System.get_env("GITLAB_REDIRECT_URI")
```
1. Include the Überauth plug in your controller:
```elixir
defmodule MyApp.AuthController do
use MyApp.Web, :controller
pipeline :browser do
plug Ueberauth
...
end
end
```
1. Create the request and callback routes if you haven't already:
```elixir
scope "/auth", MyApp do
pipe_through :browser
get "/:provider", AuthController, :request
get "/:provider/callback", AuthController, :callback
end
```
1. Your controller needs to implement callbacks to deal with `Ueberauth.Auth`
and `Ueberauth.Failure` responses.
For an example implementation see the [Überauth Example][example-app] application
on how to integrate other strategies. Adding Gitlab should be similar to Github.
## Calling
Depending on the configured url you can initial the request through:
```text
/auth/gitlab
```
Or with options:
```text
/auth/gitlab?scope=api read_user
```
Configuration for adding Gitlab as Üeberauth Strategy
```elixir
config :ueberauth, Ueberauth,
providers: [
identity: { Ueberauth.Strategy.Identity, [
callback_methods: ["POST"],
uid_field: :email,
nickname_field: :username,
] },
gitlab: {Ueberauth.Strategy.Gitlab, [default_scope: "read_user"]},
]
```
It is also possible to disable the sending of the `redirect_uri` to Gitlab. This
is particularly useful when your production application sits behind a proxy that
handles SSL connections. In this case, the `redirect_uri` sent by `Ueberauth`
will start with `http` instead of `https`, and if you configured your Gitlb OAuth
application's callback URL to use HTTPS, Gitlab will throw an `uri_missmatch` error.
In addition if the `redirect_uri` on the the authorize request **must match**
the `redirect_uri` on the token request.
## Documentation
The docs can be found at [ueberauth_gitlab][package-docs] on [Hex Docs][hex-docs].
[example-app]: https://github.com/ueberauth/ueberauth_example
[gitlab-apps]: https://gitlab.com/profile/applications
[hex-docs]: https://hexdocs.pm
[package-docs]: https://hexdocs.pm/ueberauth_gitlab_strategy