feat: add support for custom favicons (#4770)

* feat: add support for custom favicons * Commit updated API documentation * chore(i18n): add localization of text * fix(js): regenerate package lock file * chore(test): add favicon test * fix: max size not respected * Commit updated API documentation * fix: move favicon.ico to the static dir * fix: fix tests * fix: remove hard-coded content-type of icon * chore: update extracted translations * feat(admin): add support for resetting to default icon * chore: use a higher res default favicon * Commit updated API documentation --------- Co-authored-by: Owncast <owncast@owncast.online>
2026-01-28 18:07:19 -08:00
parent f8560db614
commit 6abaf20f2b
77 changed files with 981 additions and 177 deletions
@@ -1704,6 +1704,60 @@ paths:
      responses:
        '204':
          $ref: '#/components/responses/204'
+  /admin/config/favicon:
+    post:
+      summary: Upload custom favicon
+      operationId: SetFavicon
+      tags: ['Internal', 'Admin']
+      security:
+        - BasicAuth: []
+      requestBody:
+        content:
+          multipart/form-data:
+            schema:
+              type: object
+              properties:
+                favicon:
+                  type: string
+                  format: binary
+                  description: Favicon file (PNG or ICO, max 200KB)
+      responses:
+        '200':
+          description: Favicon updated
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/BaseAPIResponse'
+        '400':
+          $ref: '#/components/responses/400'
+        '401':
+          $ref: '#/components/responses/401BasicAuth'
+        default:
+          $ref: '#/components/responses/Default'
+    delete:
+      summary: Reset favicon to default
+      operationId: ResetFavicon
+      tags: ['Internal', 'Admin']
+      security:
+        - BasicAuth: []
+      responses:
+        '200':
+          description: Favicon reset to default
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/BaseAPIResponse'
+        '401':
+          $ref: '#/components/responses/401BasicAuth'
+        default:
+          $ref: '#/components/responses/Default'
+    options:
+      operationId: SetFaviconOptions
+      x-internal: true
+      tags: ['Objects', 'Internal', 'Admin']
+      responses:
+        '204':
+          $ref: '#/components/responses/204'
  /admin/config/tags:
    post:
      summary: Update server tags