Add config option to display source code URL in footer (#2450)

assets/css/default.css

@@ -314,6 +314,11 @@ footer a {
   text-decoration: underline;
 }
 
+footer span {
+  margin: 4px 0;
+  display: block;
+}
+
 /* keyframes */
 
 @keyframes spin {

config/config.example.yml

@@ -432,6 +432,15 @@ feed_threads: 1
 ##
 #cache_annotations: false
 
+##
+## Source code URL. If your instance is running a modfied source
+## code, you MUST publish it somewhere and set this option.
+##
+## Accepted values: a string
+## Default: <none>
+##
+#modified_source_code_url: ""
+
 
 
 #########################################

locales/en-US.json

@@ -425,5 +425,11 @@
     "Current version: ": "Current version: ",
     "next_steps_error_message": "After which you should try to: ",
     "next_steps_error_message_refresh": "Refresh",
-    "next_steps_error_message_go_to_youtube": "Go to YouTube"
+    "next_steps_error_message_go_to_youtube": "Go to YouTube",
+    "footer_donate": "Donate: ",
+    "footer_documentation": "Documentation",
+    "footer_source_code": "Source code",
+    "footer_original_source_code": "Original source code",
+    "footer_modfied_source_code": "Modified Source code",
+    "adminprefs_modified_source_code_url_label": "URL to modified source code repository"
 }

src/invidious/helpers/helpers.cr

@@ -97,6 +97,10 @@ class Config
   property hsts : Bool? = true                            # Enables 'Strict-Transport-Security'. Ensure that `domain` and all subdomains are served securely
   property disable_proxy : Bool? | Array(String)? = false # Disable proxying server-wide: options: 'dash', 'livestreams', 'downloads', 'local'
 
+  # URL to the modified source code to be easily AGPL compliant
+  # Will display in the footer, next to the main source code link
+  property modified_source_code_url : String? = nil
+
   @[YAML::Field(converter: Preferences::FamilyConverter)]
   property force_resolve : Socket::Family = Socket::Family::UNSPEC # Connect to YouTube over 'ipv6', 'ipv4'. Will sometimes resolve fix issues with rate-limiting (see https://github.com/ytdl-org/youtube-dl/issues/21729)
   property port : Int32 = 3000                                     # Port to listen for connections (overrided by command line argument)

src/invidious/routes/preferences.cr

@@ -200,6 +200,8 @@ module Invidious::Routes::PreferencesRoute
         statistics_enabled ||= "off"
         CONFIG.statistics_enabled = statistics_enabled == "on"
 
+        CONFIG.modified_source_code_url = env.params.body["modified_source_code_url"]?.try &.as(String)
+
         File.write("config/config.yml", CONFIG.to_yaml)
       end
     else

src/invidious/views/preferences.ecr

@@ -286,6 +286,11 @@
                     <label for="statistics_enabled"><%= translate(locale, "Report statistics: ") %></label>
                     <input name="statistics_enabled" id="statistics_enabled" type="checkbox" <% if CONFIG.statistics_enabled %>checked<% end %>>
                 </div>
+
+                <div class="pure-control-group">
+                    <label for="modified_source_code_url"><%= translate(locale, "adminprefs_modified_source_code_url_label") %></label>
+                    <input name="modified_source_code_url" id="modified_source_code_url" type="input" <% if CONFIG.modified_source_code_url %>checked<% end %>>
+                </div>
             <% end %>
 
             <% if env.get? "user" %>

src/invidious/views/template.ecr

@@ -117,38 +117,47 @@
             <footer>
                 <div class="pure-g">
                     <div class="pure-u-1 pure-u-md-1-3">
-                        <a href="https://github.com/iv-org/invidious">
+                        <span>
-                            <%= translate(locale, "Released under the AGPLv3 on Github.") %>
+                            <i class="icon ion-logo-github"></i>
-                        </a>
+                        <% if CONFIG.modified_source_code_url %>
-                    </div>
+                            <a href="https://github.com/iv-org/invidious"><%= translate(locale, "footer_original_source_code") %></a>&nbsp;/
-                    <div class="pure-u-1 pure-u-md-1-3">
+                            <a href="<%= CONFIG.modified_source_code_url %>"><%= translate(locale, "footer_modfied_source_code") %></a>
-                        <i class="icon ion-ios-wallet"></i>
+                        <% else %>
-                        BTC: <a href="bitcoin:bc1qfhe7rq3lqzuayzjxzyt9waz9ytrs09kla3tsgr">bc1qfhe7rq3lqzuayzjxzyt9waz9ytrs09kla3tsgr</a>
+                            <a href="https://github.com/iv-org/invidious"><%= translate(locale, "footer_source_code") %></a>
-                    </div>
+                        <% end %>
-                    <div class="pure-u-1 pure-u-md-1-3">
+                        </span>
-                        <i class="icon ion-ios-wallet"></i>
+                        <span>
-                        XMR: <a href="monero:41nMCtek197boJtiUvGnTFYMatrLEpnpkQDmUECqx5Es2uX3sTKKWVhSL76suXsG3LXqkEJBrCZBgPTwJrDp1FrZJfycGPR">Click here</a>
+                            <i class="icon ion-ios-paper"></i>
-                    </div>
+                            <a href="https://github.com/iv-org/documentation"><%= translate(locale, "footer_documentation") %></a>
-                    <div class="pure-u-1 pure-u-md-1-3">
+                        </span>
-                        <a href="https://github.com/iv-org/documentation">Documentation</a>
                     </div>
+
                     <div class="pure-u-1 pure-u-md-1-3">
+                        <span>
+                            <a href="https://github.com/iv-org/invidious/blob/master/LICENSE"><%= translate(locale, "Released under the AGPLv3 on Github.") %></a>
+                        </span>
+                        <span>
                             <i class="icon ion-logo-javascript"></i>
-                        <a rel="jslicense" href="/licenses">
+                            <a rel="jslicense" href="/licenses"><%= translate(locale, "View JavaScript license information.") %></a>
-                            <%= translate(locale, "View JavaScript license information.") %>
+                        </span>
-                        </a>
+                        <span>
-                        /
                             <i class="icon ion-ios-paper"></i>
-                        <a href="/privacy">
+                            <a href="/privacy"><%= translate(locale, "View privacy policy.") %></a>
-                            <%= translate(locale, "View privacy policy.") %>
+                        </span>
-                        </a>
                     </div>
+
                     <div class="pure-u-1 pure-u-md-1-3">
-                        <i class="icon ion-logo-github"></i>
+                        <span>
-                        <%= translate(locale, "Current version: ") %> <%= CURRENT_VERSION %>-<%= CURRENT_COMMIT %> @ <%= CURRENT_BRANCH %>
+                            <i class="icon ion-ios-wallet"></i>
+                            <%= translate(locale, "footer_donate") %>
+                            <a href="bitcoin:bc1qfhe7rq3lqzuayzjxzyt9waz9ytrs09kla3tsgr">BTC</a>&nbsp;/
+                            <a href="monero:41nMCtek197boJtiUvGnTFYMatrLEpnpkQDmUECqx5Es2uX3sTKKWVhSL76suXsG3LXqkEJBrCZBgPTwJrDp1FrZJfycGPR">XMR</a>
+                        </span>
+                        <span><%= translate(locale, "Current version: ") %> <%= CURRENT_VERSION %>-<%= CURRENT_COMMIT %> @ <%= CURRENT_BRANCH %></span>
                     </div>
                 </div>
             </footer>
+
         </div>
         <div class="pure-u-1 pure-u-md-2-24"></div>
     </div>