From 76c2bab6c026c2a332207bccfeba2177463cd4d7 Mon Sep 17 00:00:00 2001
From: syeopite <syeopite@syeopite.dev>
Date: Wed, 13 Mar 2024 14:01:20 -0700
Subject: [PATCH] Add config to add custom text in the footer

Co-authored-by: Aural Glow <125497673+auralglow@users.noreply.github.com>
---
 assets/css/default.css           | 12 ++++++------
 config/config.example.yml        | 15 ++++++++++++++-
 locales/en-US.json               |  2 +-
 src/invidious/config.cr          |  2 ++
 src/invidious/views/template.ecr |  9 +++++++--
 5 files changed, 30 insertions(+), 10 deletions(-)

diff --git a/assets/css/default.css b/assets/css/default.css
index e4f2c7460..1422686cc 100644
--- a/assets/css/default.css
+++ b/assets/css/default.css
@@ -470,7 +470,7 @@ footer a {
   color: #919191;
 }
 
-.footer-content #about-invidious-description > b {
+.footer-content #footer-custom-text > b {
   font-size: 30px;
 }
 
@@ -502,7 +502,7 @@ footer a {
 }
 
 @media screen and (max-width: 929px) {
-  #about-invidious-description {
+  #footer-custom-text {
     display: none;
   }
 }
@@ -583,7 +583,7 @@ span > select {
   color: #7c7c7c !important;
 }
 
-.light-theme footer #about-invidious-description > b {
+.light-theme footer #footer-custom-text > b {
   color: #565D64;
 }
 
@@ -631,7 +631,7 @@ span > select {
     color: #7c7c7c;
   }
   
-  .no-theme footer #about-invidious-description > b {
+  .no-theme footer #footer-custom-text > b {
     color: #565D64;
   }
 
@@ -709,7 +709,7 @@ body.dark-theme {
   color: #313131;
 } 
 
-.dark-theme .footer-content #about-invidious-description > b {
+.dark-theme .footer-content #footer-custom-text > b {
   color: #ccc;
 }
 
@@ -773,7 +773,7 @@ body.dark-theme {
     color: #313131;
   }
 
-  .no-theme footer #about-invidious-description > b {
+  .no-theme footer #footer-custom-text > b {
     color: #ccc;
   }
 }
diff --git a/config/config.example.yml b/config/config.example.yml
index 2d3f03f7a..118ac0c00 100644
--- a/config/config.example.yml
+++ b/config/config.example.yml
@@ -404,6 +404,18 @@ jobs:
 ##
 #banner:
 
+##
+## custom text displayed at the bottom of every page within Invidious' footer. This can
+## used for instance announcements, e.g
+##
+## When unset Invidious defaults to some text that describes what Invidious is. See
+## localization key default_invidious_footer_text 
+##
+## Accepted values: any string. HTML is accepted.
+## Default: <none>
+##
+#footer:
+
 ##
 ## Source code URL. If your instance is running a modified source
 ## code, you MUST publish it somewhere and set this option.
@@ -419,7 +431,8 @@ jobs:
 ## Accepted values: Email
 ## Default: <none>
 ##
-# instance_maintainer_email: 
+# instance_maintainer_email:
+
 
 # -----------------------------
 #  Miscellaneous
diff --git a/locales/en-US.json b/locales/en-US.json
index ba6c59c30..48a0eeced 100644
--- a/locales/en-US.json
+++ b/locales/en-US.json
@@ -462,7 +462,7 @@
     "next_steps_error_message_refresh": "Refresh",
     "next_steps_error_message_go_to_youtube": "Go to YouTube",
 
-    "footer_invidious_project_description": "A free and open source frontend for Youtube that that respects your privacy! Now you can watch videos (ad-free), subscribe to channels, create playlist and much more all without the prying eyes of Google!",
+    "default_invidious_footer_text": "A free and open source frontend for Youtube that that respects your privacy! Now you can watch videos (ad-free), subscribe to channels, create playlist and much more all without the prying eyes of Google!",
     "footer_navigation_section_header": "Navigation",
     "footer_home_link": "Home",
     "footer_project_information_section_header": "Invidious",
diff --git a/src/invidious/config.cr b/src/invidious/config.cr
index ba4036475..7f820018c 100644
--- a/src/invidious/config.cr
+++ b/src/invidious/config.cr
@@ -106,6 +106,8 @@ class Config
   property cache_annotations : Bool = false
   # Optional banner to be displayed along top of page for announcements, etc.
   property banner : String? = nil
+  # Optional footer text to be displayed within Invidious' footer. Can be used for maintainer contact info, etc.
+  property footer : String? = nil
   # Enables 'Strict-Transport-Security'. Ensure that `domain` and all subdomains are served securely
   property hsts : Bool? = true
   # Disable proxying server-wide: options: 'dash', 'livestreams', 'downloads', 'local'
diff --git a/src/invidious/views/template.ecr b/src/invidious/views/template.ecr
index c3f021e00..b55f70402 100644
--- a/src/invidious/views/template.ecr
+++ b/src/invidious/views/template.ecr
@@ -139,9 +139,14 @@
         <div class="pure-u-1 pure-u-md-2-24"></div>
         <div class="h-box pure-u-1 pure-u-md-20-24" id="footer-content-container">
             <div class="pure-u-1 footer-content">
-                <div class="footer-section pure-u-1-4" id="about-invidious-description">
+                <div class="footer-section pure-u-1-4" id="footer-custom-text">
                     <b>Invidious</b>
-                    <p><%=translate(locale, "footer_invidious_project_description")%></p>
+                    <% if CONFIG.footer %>
+                        <p><%=CONFIG.footer%></p>
+                    <% else %>
+                        <p><%=translate(locale, "default_invidious_footer_text")%></p>
+                    <% end %>
+                    
                 </div>
                 <div class="footer-section">
                     <b class="footer-section-header"><%= translate(locale, "footer_navigation_section_header")%></b>