tubearchivist/browser-extension
1
0
Fork 0
mirror of https://github.com/tubearchivist/browser-extension.git synced 2024-11-05 03:30:12 +00:00
Code Issues Projects Releases Wiki Activity
Tube Archivist Companion for your Browser
69 Commits 1 Branch 15 Tags 4 MiB
JavaScript 87.5%
HTML 6.4%
CSS 3.6%
Shell 2.5%
4bafe4d3bb
Go to file
simon 4bafe4d3bb
fix linebreak popup width
2022-11-28 16:22:56 +07:00
assets fix screenshot resolution 2022-07-03 19:45:11 +07:00
extension fix linebreak popup width 2022-11-28 16:22:56 +07:00
.gitignore ignore release packages 2022-04-07 20:33:23 +07:00
deploy.sh fix push repo 2022-06-04 09:40:10 +07:00
LICENSE add license 2022-04-03 22:02:16 +07:00
README.md update roadmap 2022-11-28 11:50:03 +07:00

README.md

Tube Archivist Companion

Tube Archivist Companion for your Browser

tubearchivist-firefox tubearchivist-chrome

Core Functionality

A browser extension to bridge YouTube with Tube Archivist. This extension allows you to do the following:

  • Add your Tube Archivist connection details in the addon popup
  • Add a download button to the popup for YouTube links
  • Add a subscribe button to subscribe to channels and playlists
  • Sync your cookies for yt-dlp.

popup screenshot

Install

Update

After a new release here on GitHub, you'll get updates automatically in your browser. Due to the verification process, for Firefox this usually takes 1-2 hours, for Chrome 2-3 days.

Permissions

  • Access your data for www.youtube.com: Needed for the addon to know your current page on YouTube to send the link to Tube Archivist.
  • Storage: Needed to store your connection details, needed to store your last visited YouTube link within the browser.
  • Cookie: Needed to read your cookies for youtube.com to access restricted videos.

Setup

  • URL: This is where your Tube Archivist instance is located. Can be a host name or a IP address, use a full URL with protocol, e.g. http://.
  • Port: Network port of TA.
  • API key: You can find your API key on the settings page of your Tube Archivist instance.

A green checkmark will appear next to the Save button if your connection is working.

Options

  • Sync YouTube cookies: Send your cookies to TubeArchivist to use for yt-dlp requests.

Test this extension

Use the correct manifest file for your browser. Either rename the browser specific file to manifest.json before loading the addon or symlink it to the correct location, e.g. ln -s manifest-firefox.json manifest.json.

  • Firefox
    • Open about:debugging#/runtime/this-firefox
    • Click on Load Temporary Add-on
    • Select the manifest.json file to load the addon.
  • Chrome / Chromium
    • Open chrome://extensions/
    • Toggle Developer mode on top right
    • Click on Load unpacked
    • Open the folder containing the manifest.json file.

Compatibility

  • Verify that you are running the latest version of Tube Archivist as the API is under development and will change.
  • For testing this extension between releases, use the unstable builds of Tube Archivist, only for your tesing environment.

Roadmap

Join us on Discord and help us improve and extend this project. This is a list of planned features, in no particular order:

  • Get download and subscribe status from TA to show on the injected buttons
  • Implement download button for videos on the YouTube homepage over inline preview
  • Implement download/subscribe button for playlists
  • Implement download button for videos on playlist
  • Error handling for connection errors