自分で構築したGitLabの外観を変える方法

この記事はGitLab Advent Calendar 2022の16日目に参加しています。

はじめに

こんにちは。2022年も、もうすぐ終わりですね。今年はどんな年でしたか？私はGitLabに出会った年でした
勉強のためにGitLabのOmnibusパッケージを自分の環境にインストール。多くのトラブルを乗り越え、無事動作できるようにりましたが、使い続けているうちにデザインを変えたくなりました。
たかが見た目ですが、結構重要だと思います！パッと見て「あ、違う」とわかると、例えばgitlab.comにもアカウントがあったり、会社など別のインスタンスも使っている場合に間違いが起こりにくいメリットがあるのではないでしょうか。
そこでGitLabの外観を変える方法をまとめてみました！

この記事はGitLab15.5.6-ce Omnibusパッケージ版の動作を元にして記述しています。今後のバージョンアップ等でご紹介している機能に変更が加えられる場合があります。
公式ドキュメントへのリンクもありますので、自分の使用しているGitLabにその機能があるかはそちらでご確認下さい。

GitLab全体の外観を変えるには

公式ドキュメント解説：GitLab Appearance

Admin権限を持つアカウントでログインして、まずはこちらから設定画面へ。
メニューのAdmin Areaから、Setting > Appearanceで、変更画面が表示されます。
(表示が日本語の場合：管理者エリアから設定 > 外観)

GitLabのロゴ（左上のTanukiの画像）を変更するには

公式ドキュメント解説：Top bar

まずは、いちばん目立っている、左上のオレンジのTanukiのロゴ。header logoといいます。これを好きな画像に変更することができます。

header logoに使用する画像について

• 使用できる画像のサイズは1MB以内
• 高さ24pxにリサイズして表示される

Appearance（外観）画面のNavigation barの項目で変更します。
「ファイルを選択」ボタンをクリックし、画像を選択します。

その後、Appearance（外観）画面を一番下までスクロールしてUpdate appearance settingsボタンを押すことで変更が有効となります。

変更できました！

Header logoに設定できる画像は正方形だけではなく、このように横長の画像も可能です。高さは24pxに縮小されます。
とはいえ、画像の幅の分、検索バーやメニューが右へ移動してしまうので、ご注意下さい。

設定したheader logoを削除してデフォルトに戻すには、赤いボタンRemove header logoをクリックします。（Update appearance settingsを押さなくても変更されます）

Favicon（ブラウザのタブに表示される小さなアイコン）を変更するには

公式ドキュメント解説：Favicon

ブラウザのタブに表示されるfavicon。こちらもデフォルトのTanukiから好きな画像に変更することができます。

faviconに使用する画像について

• 使用できる画像のサイズは1MB以内、32x32px
• ファイル形式はPNG、ICOのみ

Appearance（外観）画面のFaviconの項目で変更します。

「ファイルを選択」ボタンをクリックし、画像を選択します。適切なサイズとファイル形式で画像を用意しましょう。

画像選択後、Appearance（外観）画面を一番下までスクロールしてUpdate appearance settingsボタンを押すことで変更が有効となります。

変更できました！

デフォルトに戻すには、header logoの場合と同様、赤いボタンRemove faviconをクリックします。

GitLabのすべての画面でヘッダーとフッターにメッセージを表示するには

公式ドキュメント解説：System header and footer

ロゴとfaviconを変えただけでもだいぶ雰囲気が変わりました。
さて、ヘッダとフッタにテキスト表示する機能を発見！
試してみましょう。

Appearance（外観）画面のSystem header and footerの項目で変更します。

表示するテキストにはMarkdownの一部が使えます。絵文字もOKです！

下にある小さな文字、Customize colorsのリンクをクリックすると、表示する帯状エリアの背景色と、文字色を選ぶことができます。
スポイトも使えるほか、このようにRGB、HSL、HEXでの指定も可能です。
設定後は「Update appearance settings」ボタンで反映させるのを忘れずに。

こんな風に表示できました！上と下に表示された文字がわかりますでしょうか。
（スクショのためにブラウザを狭く表示しています）

似たような機能に、Broadcast messagesがあります。こちらはログインしてGitLabを利用しているユーザにメッセージを送るもので、一致するURLでのみ表示などの機能があります。
System header and footerで設定したメッセージはGitLabのすべての画面で同じように表示されます。
ログイン前の画面も同様です。ログアウトしなくても表示の確認ができます。
Appearance（外観）画面を一番下までスクロールすると、Update appearance settingsボタンの下にある、Preview last save: Sign-in pageというボタンがありますので、それをクリックします。

これがプレビューしている状態です。

Appearance（外観）の他の設定機能

Appearance（外観）画面では、他にもこのような設定項目がありますので、興味がある方は試してみてください！

• Sign in/Sign up pages
  • ログイン前の画面に表示するタイトルとテキスト、画像（ロゴ）を設定できます。
• New project pages
  • 新規にプロジェクトを作成する際にガイドラインとして表示するテキストを設定できます。
• Profile image guideline
  • ユーザがEdit profile画面で、Public avatar（自分のアバター)を設定する項目でガイドラインとして表示するテキストを設定できます。

おわりに

クリスマスっぽくGitLabの外観を変えてみました！
🎄🎁🎄🎁 それではみなさん、よいクリスマスを♪🎁🎄🎁🎄