Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
G
gitlab-ce
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
1
Merge Requests
1
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
nexedi
gitlab-ce
Commits
9f5491ea
Commit
9f5491ea
authored
Mar 16, 2021
by
Diego Louzán
Committed by
Amy Qualls
Mar 16, 2021
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Document how to use custom omniauth button icon
parent
0565b69f
Changes
2
Show whitespace changes
Inline
Side-by-side
Showing
2 changed files
with
34 additions
and
0 deletions
+34
-0
changelogs/unreleased/docs-omniauth-providers-icon.yml
changelogs/unreleased/docs-omniauth-providers-icon.yml
+5
-0
doc/integration/omniauth.md
doc/integration/omniauth.md
+29
-0
No files found.
changelogs/unreleased/docs-omniauth-providers-icon.yml
0 → 100644
View file @
9f5491ea
---
title
:
Document how to use custom omniauth button icon
merge_request
:
55388
author
:
Diego Louzán
type
:
other
doc/integration/omniauth.md
View file @
9f5491ea
...
...
@@ -356,3 +356,32 @@ You may also bypass the auto sign in feature by browsing to
The
[
Generated passwords for users created through integrated authentication
](
../security/passwords_for_integrated_authentication_methods.md
)
guide provides an overview about how GitLab generates and sets passwords for
users created with OmniAuth.
## Custom OmniAuth provider icon
Most supported providers include a built-in icon for the rendered sign-in button.
After you ensure your image is optimized for rendering at 64 x 64 pixels,
you can override this icon in one of two ways:
-
**Provide a custom image path**
:
1.
*If you are hosting the image outside of your GitLab server domain,*
ensure
your
[
content security policies
](
https://docs.gitlab.com/omnibus/settings/configuration.html#content-security-policy
)
are configured to allow access to the image file.
1.
Depending on your method of installing GitLab, add a custom
`icon`
parameter
to your GitLab configuration file. Read
[
OpenID Connect OmniAuth provider
](
../administration/auth/oidc.md
)
for an example for the OpenID Connect provider.
-
**Directly embed an image in a configuration file**
: This example creates a Base64-encoded
version of your image you can serve through a
[
Data URL
](
https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URIs
)
:
1.
Encode your image file with GNU
`base64`
command (such as
`base64 -w 0 <logo.png>`
)
which returns a single-line
`<base64-data>`
string.
1.
Add the Base64-encoded data to a custom
`icon`
parameter in your GitLab configuration file:
```yaml
omniauth:
providers:
- { name: '...'
icon: 'data:image/png;base64,<base64-data>'
...
}
```
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment