├── .github
└── workflows
│ ├── build-image.yml
│ ├── publish-to-testing.yml
│ └── yt-dlp-autoupdater.yml
├── .gitignore
├── Dockerfile
├── LICENSE
├── README.md
├── requirements.txt
├── start.sh
├── start_app.py
└── tubetube
├── __init__.py
├── helpers.py
├── settings.py
├── static
├── js_general_script.js
├── js_table_script.js
├── js_theme_switcher.js
├── logo.png
├── phone-screenshot.png
├── screenshot.png
├── style.css
└── tubetube.png
├── templates
└── index.html
├── tubetube.py
└── yt_downloader.py
/.github/workflows/build-image.yml:
--------------------------------------------------------------------------------
1 | name: Build Image and Deploy to GHCR
2 |
3 | on:
4 | workflow_dispatch:
5 |
6 | release:
7 | types: [created]
8 |
9 | jobs:
10 | build-docker-image:
11 | runs-on: ubuntu-latest
12 | steps:
13 | - name: Checkout GitHub Action
14 | uses: actions/checkout@main
15 |
16 | - name: Set up Docker Buildx
17 | uses: docker/setup-buildx-action@v3
18 |
19 | - name: Login to GitHub Container Registry
20 | uses: docker/login-action@v3
21 | with:
22 | registry: ghcr.io
23 | username: ${{ github.actor }}
24 | password: ${{ secrets.PAT }}
25 |
26 | - name: Get Version
27 | id: get_version
28 | run: |
29 | RAW_VERSION="${{ github.event.release.tag_name }}"
30 | VERSION="${RAW_VERSION#v}"
31 | echo "VERSION=${VERSION}" >> $GITHUB_ENV
32 | echo "Version = ${VERSION}"
33 |
34 | - name: Build and Push Docker Image
35 | run: |
36 | VERSION="${{ github.event.release.tag_name }}"
37 | docker buildx build \
38 | --platform linux/amd64,linux/arm64 \
39 | --tag ghcr.io/mattblackonly/tubetube:latest \
40 | --tag ghcr.io/mattblackonly/tubetube:${{ env.VERSION }} \
41 | --build-arg TUBETUBE_VERSION=${VERSION} \
42 | --push .
43 |
--------------------------------------------------------------------------------
/.github/workflows/publish-to-testing.yml:
--------------------------------------------------------------------------------
1 | name: Publish to Testing Branch
2 |
3 | on:
4 | push:
5 | branches:
6 | - 'testing'
7 |
8 | jobs:
9 | publish-to-testing:
10 | runs-on: ubuntu-latest
11 | steps:
12 | - name: Checkout Code
13 | uses: actions/checkout@v4
14 |
15 | - name: Set up Docker Buildx
16 | uses: docker/setup-buildx-action@v3
17 |
18 | - name: Login to GitHub Container Registry
19 | uses: docker/login-action@v3
20 | with:
21 | registry: ghcr.io
22 | username: ${{ github.actor }}
23 | password: ${{ secrets.PAT }}
24 |
25 | - name: Build and Push Docker Image for Testing
26 | run: |
27 | echo "Publishing to :testing image"
28 | docker buildx build \
29 | --platform linux/amd64,linux/arm64 \
30 | --tag ghcr.io/mattblackonly/tubetube:testing \
31 | --build-arg TUBETUBE_VERSION=testing \
32 | --push .
--------------------------------------------------------------------------------
/.github/workflows/yt-dlp-autoupdater.yml:
--------------------------------------------------------------------------------
1 | name: Check and Update yt-dlp Version
2 |
3 | on:
4 | schedule:
5 | - cron: '0 12 * * *'
6 | workflow_dispatch:
7 |
8 | jobs:
9 | check-yt-dlp-version:
10 | runs-on: ubuntu-latest
11 | outputs:
12 | updated_flag: ${{ steps.update_requirements.outputs.updated_flag }}
13 |
14 | steps:
15 | - name: Checkout code
16 | uses: actions/checkout@v4
17 | with:
18 | token: ${{ secrets.PAT }}
19 |
20 | - name: Set up Python
21 | uses: actions/setup-python@v5
22 | with:
23 | python-version: '3.12'
24 |
25 | - name: Get latest yt-dlp version
26 | id: get_latest_ytdlp_version
27 | run: |
28 | pip install yt-dlp
29 | latest_version=$(yt-dlp --version)
30 | echo "Latest yt-dlp version: $latest_version"
31 | echo "latest_version=$latest_version" >> $GITHUB_ENV
32 |
33 | - name: Extract yt-dlp version from requirements.txt
34 | id: extract_version
35 | run: |
36 | current_version=$(grep -oP "(?<=yt_dlp\[default\]==)\d+(\.\d+)+" requirements.txt || echo "0.0")
37 | echo "Version in requirements.txt: $current_version"
38 | echo "current_version=$current_version" >> $GITHUB_ENV
39 |
40 | - name: Update requirements.txt if new version available
41 | id: update_requirements
42 | run: |
43 | if [ "${{ env.latest_version }}" = "${{ env.current_version }}" ]; then
44 | echo "updated_flag=false" >> $GITHUB_OUTPUT
45 | else
46 | latest_version=${{ env.latest_version }}
47 | sed -i "s/^yt_dlp.*/yt_dlp[default]==$latest_version/" requirements.txt
48 | git config --global user.email "updater@tubetube"
49 | git config --global user.name "AutoUpdater"
50 | git commit -m "Update yt-dlp version to $latest_version" requirements.txt
51 | git push
52 | echo "updated_flag=true" >> $GITHUB_OUTPUT
53 | fi
54 |
55 | generate-release:
56 | runs-on: ubuntu-latest
57 | needs: check-yt-dlp-version
58 | if: ${{ needs.check-yt-dlp-version.outputs.updated_flag == 'true' }}
59 |
60 | env:
61 | GH_TOKEN: ${{ secrets.PAT }}
62 |
63 | steps:
64 | - name: Checkout code
65 | uses: actions/checkout@v4
66 | with:
67 | token: ${{ secrets.PAT }}
68 |
69 | - name: Pull latest changes
70 | run: git pull origin main
71 |
72 | - name: Fetch and list tags
73 | run: |
74 | git fetch --tags
75 | echo "Tags:"
76 | git tag --list
77 |
78 | - name: Increment release
79 | id: increment_release
80 | run: |
81 | latest_tag=$(git tag --list | grep -v 'testing' | sed 's/^v//' | sort -V | tail -n 1 || echo "0.0.0")
82 | major=$(echo $latest_tag | cut -d. -f1)
83 | minor=$(echo $latest_tag | cut -d. -f2)
84 | patch=$(echo $latest_tag | cut -d. -f3)
85 | new_patch=$((patch + 1))
86 | new_tag="v${major}.${minor}.${new_patch}"
87 |
88 | echo "CURRENT_RELEASE=$latest_tag" >> $GITHUB_ENV
89 | echo "NEW_RELEASE=$new_tag" >> $GITHUB_ENV
90 | echo "Current release: $latest_tag"
91 | echo "New release: $new_tag"
92 |
93 | - name: Create new Git tag
94 | run: |
95 | git config --global user.name 'github-actions[bot]'
96 | git config --global user.email 'github-actions[bot]@users.noreply.github.com'
97 | git tag -a ${{ env.NEW_RELEASE }} -m "Release version ${{ env.NEW_RELEASE }}"
98 | git push origin ${{ env.NEW_RELEASE }}
99 |
100 | - name: Create release
101 | run: |
102 | gh release create "${{ env.NEW_RELEASE }}" \
103 | --repo="${GITHUB_REPOSITORY}" \
104 | --title="${{ env.NEW_RELEASE }}" \
105 | --generate-notes
106 |
--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | # Byte-compiled / optimized / DLL files
2 | __pycache__/
3 | *.py[cod]
4 | *$py.class
5 |
6 | # C extensions
7 | *.so
8 |
9 | # Distribution / packaging
10 | .Python
11 | build/
12 | develop-eggs/
13 | dist/
14 | downloads/
15 | eggs/
16 | .eggs/
17 | lib/
18 | lib64/
19 | parts/
20 | sdist/
21 | var/
22 | wheels/
23 | share/python-wheels/
24 | *.egg-info/
25 | .installed.cfg
26 | *.egg
27 | MANIFEST
28 |
29 | # PyInstaller
30 | # Usually these files are written by a python script from a template
31 | # before PyInstaller builds the exe, so as to inject date/other infos into it.
32 | *.manifest
33 | *.spec
34 |
35 | # Installer logs
36 | pip-log.txt
37 | pip-delete-this-directory.txt
38 |
39 | # Unit test / coverage reports
40 | htmlcov/
41 | .tox/
42 | .nox/
43 | .coverage
44 | .coverage.*
45 | .cache
46 | nosetests.xml
47 | coverage.xml
48 | *.cover
49 | *.py,cover
50 | .hypothesis/
51 | .pytest_cache/
52 | cover/
53 |
54 | # Translations
55 | *.mo
56 | *.pot
57 |
58 | # Django stuff:
59 | *.log
60 | local_settings.py
61 | db.sqlite3
62 | db.sqlite3-journal
63 |
64 | # Flask stuff:
65 | instance/
66 | .webassets-cache
67 |
68 | # Scrapy stuff:
69 | .scrapy
70 |
71 | # Sphinx documentation
72 | docs/_build/
73 |
74 | # PyBuilder
75 | .pybuilder/
76 | target/
77 |
78 | # Jupyter Notebook
79 | .ipynb_checkpoints
80 |
81 | # IPython
82 | profile_default/
83 | ipython_config.py
84 |
85 | # pyenv
86 | # For a library or package, you might want to ignore these files since the code is
87 | # intended to run in multiple environments; otherwise, check them in:
88 | # .python-version
89 |
90 | # pipenv
91 | # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
92 | # However, in case of collaboration, if having platform-specific dependencies or dependencies
93 | # having no cross-platform support, pipenv may install dependencies that don't work, or not
94 | # install all needed dependencies.
95 | #Pipfile.lock
96 |
97 | # poetry
98 | # Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
99 | # This is especially recommended for binary packages to ensure reproducibility, and is more
100 | # commonly ignored for libraries.
101 | # https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
102 | #poetry.lock
103 |
104 | # pdm
105 | # Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
106 | #pdm.lock
107 | # pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
108 | # in version control.
109 | # https://pdm.fming.dev/latest/usage/project/#working-with-version-control
110 | .pdm.toml
111 | .pdm-python
112 | .pdm-build/
113 |
114 | # PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
115 | __pypackages__/
116 |
117 | # Celery stuff
118 | celerybeat-schedule
119 | celerybeat.pid
120 |
121 | # SageMath parsed files
122 | *.sage.py
123 |
124 | # Environments
125 | .env
126 | .venv
127 | env/
128 | venv/
129 | ENV/
130 | env.bak/
131 | venv.bak/
132 |
133 | # Spyder project settings
134 | .spyderproject
135 | .spyproject
136 |
137 | # Rope project settings
138 | .ropeproject
139 |
140 | # mkdocs documentation
141 | /site
142 |
143 | # mypy
144 | .mypy_cache/
145 | .dmypy.json
146 | dmypy.json
147 |
148 | # Pyre type checker
149 | .pyre/
150 |
151 | # pytype static type analyzer
152 | .pytype/
153 |
154 | # Cython debug symbols
155 | cython_debug/
156 |
157 | # PyCharm
158 | # JetBrains specific template is maintained in a separate JetBrains.gitignore that can
159 | # be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
160 | # and can be added to the global gitignore or merged into this file. For a more nuclear
161 | # option (not recommended) you can uncomment the following to ignore the entire idea folder.
162 | #.idea/
163 |
--------------------------------------------------------------------------------
/Dockerfile:
--------------------------------------------------------------------------------
1 | FROM python:3.12-alpine
2 |
3 | # Install dependencies, including su-exec
4 | RUN apk update && apk add --no-cache ffmpeg su-exec
5 |
6 | # Create appuser and appgroup
7 | RUN addgroup -g 1000 appgroup && adduser -D -u 1000 -G appgroup appuser
8 |
9 | # Set environment variables
10 | ARG TUBETUBE_VERSION
11 | ENV PYTHONDONTWRITEBYTECODE=1 \
12 | PYTHONUNBUFFERED=1 \
13 | PYTHONPATH=/app/tubetube \
14 | TUBETUBE_VERSION=${TUBETUBE_VERSION}
15 |
16 | # Set the working directory
17 | WORKDIR /app
18 |
19 | # Copy the application code
20 | COPY . .
21 |
22 | # Install Python dependencies
23 | RUN pip install --upgrade pip --root-user-action=ignore && \
24 | pip install --no-cache-dir --root-user-action=ignore -r requirements.txt
25 |
26 | # Ensure proper ownership of /config, /data and /temp directories
27 | RUN mkdir -p /config /data /temp && \
28 | chown -R appuser:appgroup /config /data /temp && \
29 | chmod -R 775 /temp
30 |
31 | # Make script executable
32 | RUN chmod +x /app/start.sh
33 |
34 | # Expose the application port
35 | EXPOSE 6543
36 |
37 | # Use the start script as the entrypoint
38 | ENTRYPOINT ["/app/start.sh"]
39 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | GNU GENERAL PUBLIC LICENSE
2 | Version 3, 29 June 2007
3 |
4 | Copyright (C) 2007 Free Software Foundation, Inc.
5 | Everyone is permitted to copy and distribute verbatim copies
6 | of this license document, but changing it is not allowed.
7 |
8 | Preamble
9 |
10 | The GNU General Public License is a free, copyleft license for
11 | software and other kinds of works.
12 |
13 | The licenses for most software and other practical works are designed
14 | to take away your freedom to share and change the works. By contrast,
15 | the GNU General Public License is intended to guarantee your freedom to
16 | share and change all versions of a program--to make sure it remains free
17 | software for all its users. We, the Free Software Foundation, use the
18 | GNU General Public License for most of our software; it applies also to
19 | any other work released this way by its authors. You can apply it to
20 | your programs, too.
21 |
22 | When we speak of free software, we are referring to freedom, not
23 | price. Our General Public Licenses are designed to make sure that you
24 | have the freedom to distribute copies of free software (and charge for
25 | them if you wish), that you receive source code or can get it if you
26 | want it, that you can change the software or use pieces of it in new
27 | free programs, and that you know you can do these things.
28 |
29 | To protect your rights, we need to prevent others from denying you
30 | these rights or asking you to surrender the rights. Therefore, you have
31 | certain responsibilities if you distribute copies of the software, or if
32 | you modify it: responsibilities to respect the freedom of others.
33 |
34 | For example, if you distribute copies of such a program, whether
35 | gratis or for a fee, you must pass on to the recipients the same
36 | freedoms that you received. You must make sure that they, too, receive
37 | or can get the source code. And you must show them these terms so they
38 | know their rights.
39 |
40 | Developers that use the GNU GPL protect your rights with two steps:
41 | (1) assert copyright on the software, and (2) offer you this License
42 | giving you legal permission to copy, distribute and/or modify it.
43 |
44 | For the developers' and authors' protection, the GPL clearly explains
45 | that there is no warranty for this free software. For both users' and
46 | authors' sake, the GPL requires that modified versions be marked as
47 | changed, so that their problems will not be attributed erroneously to
48 | authors of previous versions.
49 |
50 | Some devices are designed to deny users access to install or run
51 | modified versions of the software inside them, although the manufacturer
52 | can do so. This is fundamentally incompatible with the aim of
53 | protecting users' freedom to change the software. The systematic
54 | pattern of such abuse occurs in the area of products for individuals to
55 | use, which is precisely where it is most unacceptable. Therefore, we
56 | have designed this version of the GPL to prohibit the practice for those
57 | products. If such problems arise substantially in other domains, we
58 | stand ready to extend this provision to those domains in future versions
59 | of the GPL, as needed to protect the freedom of users.
60 |
61 | Finally, every program is threatened constantly by software patents.
62 | States should not allow patents to restrict development and use of
63 | software on general-purpose computers, but in those that do, we wish to
64 | avoid the special danger that patents applied to a free program could
65 | make it effectively proprietary. To prevent this, the GPL assures that
66 | patents cannot be used to render the program non-free.
67 |
68 | The precise terms and conditions for copying, distribution and
69 | modification follow.
70 |
71 | TERMS AND CONDITIONS
72 |
73 | 0. Definitions.
74 |
75 | "This License" refers to version 3 of the GNU General Public License.
76 |
77 | "Copyright" also means copyright-like laws that apply to other kinds of
78 | works, such as semiconductor masks.
79 |
80 | "The Program" refers to any copyrightable work licensed under this
81 | License. Each licensee is addressed as "you". "Licensees" and
82 | "recipients" may be individuals or organizations.
83 |
84 | To "modify" a work means to copy from or adapt all or part of the work
85 | in a fashion requiring copyright permission, other than the making of an
86 | exact copy. The resulting work is called a "modified version" of the
87 | earlier work or a work "based on" the earlier work.
88 |
89 | A "covered work" means either the unmodified Program or a work based
90 | on the Program.
91 |
92 | To "propagate" a work means to do anything with it that, without
93 | permission, would make you directly or secondarily liable for
94 | infringement under applicable copyright law, except executing it on a
95 | computer or modifying a private copy. Propagation includes copying,
96 | distribution (with or without modification), making available to the
97 | public, and in some countries other activities as well.
98 |
99 | To "convey" a work means any kind of propagation that enables other
100 | parties to make or receive copies. Mere interaction with a user through
101 | a computer network, with no transfer of a copy, is not conveying.
102 |
103 | An interactive user interface displays "Appropriate Legal Notices"
104 | to the extent that it includes a convenient and prominently visible
105 | feature that (1) displays an appropriate copyright notice, and (2)
106 | tells the user that there is no warranty for the work (except to the
107 | extent that warranties are provided), that licensees may convey the
108 | work under this License, and how to view a copy of this License. If
109 | the interface presents a list of user commands or options, such as a
110 | menu, a prominent item in the list meets this criterion.
111 |
112 | 1. Source Code.
113 |
114 | The "source code" for a work means the preferred form of the work
115 | for making modifications to it. "Object code" means any non-source
116 | form of a work.
117 |
118 | A "Standard Interface" means an interface that either is an official
119 | standard defined by a recognized standards body, or, in the case of
120 | interfaces specified for a particular programming language, one that
121 | is widely used among developers working in that language.
122 |
123 | The "System Libraries" of an executable work include anything, other
124 | than the work as a whole, that (a) is included in the normal form of
125 | packaging a Major Component, but which is not part of that Major
126 | Component, and (b) serves only to enable use of the work with that
127 | Major Component, or to implement a Standard Interface for which an
128 | implementation is available to the public in source code form. A
129 | "Major Component", in this context, means a major essential component
130 | (kernel, window system, and so on) of the specific operating system
131 | (if any) on which the executable work runs, or a compiler used to
132 | produce the work, or an object code interpreter used to run it.
133 |
134 | The "Corresponding Source" for a work in object code form means all
135 | the source code needed to generate, install, and (for an executable
136 | work) run the object code and to modify the work, including scripts to
137 | control those activities. However, it does not include the work's
138 | System Libraries, or general-purpose tools or generally available free
139 | programs which are used unmodified in performing those activities but
140 | which are not part of the work. For example, Corresponding Source
141 | includes interface definition files associated with source files for
142 | the work, and the source code for shared libraries and dynamically
143 | linked subprograms that the work is specifically designed to require,
144 | such as by intimate data communication or control flow between those
145 | subprograms and other parts of the work.
146 |
147 | The Corresponding Source need not include anything that users
148 | can regenerate automatically from other parts of the Corresponding
149 | Source.
150 |
151 | The Corresponding Source for a work in source code form is that
152 | same work.
153 |
154 | 2. Basic Permissions.
155 |
156 | All rights granted under this License are granted for the term of
157 | copyright on the Program, and are irrevocable provided the stated
158 | conditions are met. This License explicitly affirms your unlimited
159 | permission to run the unmodified Program. The output from running a
160 | covered work is covered by this License only if the output, given its
161 | content, constitutes a covered work. This License acknowledges your
162 | rights of fair use or other equivalent, as provided by copyright law.
163 |
164 | You may make, run and propagate covered works that you do not
165 | convey, without conditions so long as your license otherwise remains
166 | in force. You may convey covered works to others for the sole purpose
167 | of having them make modifications exclusively for you, or provide you
168 | with facilities for running those works, provided that you comply with
169 | the terms of this License in conveying all material for which you do
170 | not control copyright. Those thus making or running the covered works
171 | for you must do so exclusively on your behalf, under your direction
172 | and control, on terms that prohibit them from making any copies of
173 | your copyrighted material outside their relationship with you.
174 |
175 | Conveying under any other circumstances is permitted solely under
176 | the conditions stated below. Sublicensing is not allowed; section 10
177 | makes it unnecessary.
178 |
179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
180 |
181 | No covered work shall be deemed part of an effective technological
182 | measure under any applicable law fulfilling obligations under article
183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
184 | similar laws prohibiting or restricting circumvention of such
185 | measures.
186 |
187 | When you convey a covered work, you waive any legal power to forbid
188 | circumvention of technological measures to the extent such circumvention
189 | is effected by exercising rights under this License with respect to
190 | the covered work, and you disclaim any intention to limit operation or
191 | modification of the work as a means of enforcing, against the work's
192 | users, your or third parties' legal rights to forbid circumvention of
193 | technological measures.
194 |
195 | 4. Conveying Verbatim Copies.
196 |
197 | You may convey verbatim copies of the Program's source code as you
198 | receive it, in any medium, provided that you conspicuously and
199 | appropriately publish on each copy an appropriate copyright notice;
200 | keep intact all notices stating that this License and any
201 | non-permissive terms added in accord with section 7 apply to the code;
202 | keep intact all notices of the absence of any warranty; and give all
203 | recipients a copy of this License along with the Program.
204 |
205 | You may charge any price or no price for each copy that you convey,
206 | and you may offer support or warranty protection for a fee.
207 |
208 | 5. Conveying Modified Source Versions.
209 |
210 | You may convey a work based on the Program, or the modifications to
211 | produce it from the Program, in the form of source code under the
212 | terms of section 4, provided that you also meet all of these conditions:
213 |
214 | a) The work must carry prominent notices stating that you modified
215 | it, and giving a relevant date.
216 |
217 | b) The work must carry prominent notices stating that it is
218 | released under this License and any conditions added under section
219 | 7. This requirement modifies the requirement in section 4 to
220 | "keep intact all notices".
221 |
222 | c) You must license the entire work, as a whole, under this
223 | License to anyone who comes into possession of a copy. This
224 | License will therefore apply, along with any applicable section 7
225 | additional terms, to the whole of the work, and all its parts,
226 | regardless of how they are packaged. This License gives no
227 | permission to license the work in any other way, but it does not
228 | invalidate such permission if you have separately received it.
229 |
230 | d) If the work has interactive user interfaces, each must display
231 | Appropriate Legal Notices; however, if the Program has interactive
232 | interfaces that do not display Appropriate Legal Notices, your
233 | work need not make them do so.
234 |
235 | A compilation of a covered work with other separate and independent
236 | works, which are not by their nature extensions of the covered work,
237 | and which are not combined with it such as to form a larger program,
238 | in or on a volume of a storage or distribution medium, is called an
239 | "aggregate" if the compilation and its resulting copyright are not
240 | used to limit the access or legal rights of the compilation's users
241 | beyond what the individual works permit. Inclusion of a covered work
242 | in an aggregate does not cause this License to apply to the other
243 | parts of the aggregate.
244 |
245 | 6. Conveying Non-Source Forms.
246 |
247 | You may convey a covered work in object code form under the terms
248 | of sections 4 and 5, provided that you also convey the
249 | machine-readable Corresponding Source under the terms of this License,
250 | in one of these ways:
251 |
252 | a) Convey the object code in, or embodied in, a physical product
253 | (including a physical distribution medium), accompanied by the
254 | Corresponding Source fixed on a durable physical medium
255 | customarily used for software interchange.
256 |
257 | b) Convey the object code in, or embodied in, a physical product
258 | (including a physical distribution medium), accompanied by a
259 | written offer, valid for at least three years and valid for as
260 | long as you offer spare parts or customer support for that product
261 | model, to give anyone who possesses the object code either (1) a
262 | copy of the Corresponding Source for all the software in the
263 | product that is covered by this License, on a durable physical
264 | medium customarily used for software interchange, for a price no
265 | more than your reasonable cost of physically performing this
266 | conveying of source, or (2) access to copy the
267 | Corresponding Source from a network server at no charge.
268 |
269 | c) Convey individual copies of the object code with a copy of the
270 | written offer to provide the Corresponding Source. This
271 | alternative is allowed only occasionally and noncommercially, and
272 | only if you received the object code with such an offer, in accord
273 | with subsection 6b.
274 |
275 | d) Convey the object code by offering access from a designated
276 | place (gratis or for a charge), and offer equivalent access to the
277 | Corresponding Source in the same way through the same place at no
278 | further charge. You need not require recipients to copy the
279 | Corresponding Source along with the object code. If the place to
280 | copy the object code is a network server, the Corresponding Source
281 | may be on a different server (operated by you or a third party)
282 | that supports equivalent copying facilities, provided you maintain
283 | clear directions next to the object code saying where to find the
284 | Corresponding Source. Regardless of what server hosts the
285 | Corresponding Source, you remain obligated to ensure that it is
286 | available for as long as needed to satisfy these requirements.
287 |
288 | e) Convey the object code using peer-to-peer transmission, provided
289 | you inform other peers where the object code and Corresponding
290 | Source of the work are being offered to the general public at no
291 | charge under subsection 6d.
292 |
293 | A separable portion of the object code, whose source code is excluded
294 | from the Corresponding Source as a System Library, need not be
295 | included in conveying the object code work.
296 |
297 | A "User Product" is either (1) a "consumer product", which means any
298 | tangible personal property which is normally used for personal, family,
299 | or household purposes, or (2) anything designed or sold for incorporation
300 | into a dwelling. In determining whether a product is a consumer product,
301 | doubtful cases shall be resolved in favor of coverage. For a particular
302 | product received by a particular user, "normally used" refers to a
303 | typical or common use of that class of product, regardless of the status
304 | of the particular user or of the way in which the particular user
305 | actually uses, or expects or is expected to use, the product. A product
306 | is a consumer product regardless of whether the product has substantial
307 | commercial, industrial or non-consumer uses, unless such uses represent
308 | the only significant mode of use of the product.
309 |
310 | "Installation Information" for a User Product means any methods,
311 | procedures, authorization keys, or other information required to install
312 | and execute modified versions of a covered work in that User Product from
313 | a modified version of its Corresponding Source. The information must
314 | suffice to ensure that the continued functioning of the modified object
315 | code is in no case prevented or interfered with solely because
316 | modification has been made.
317 |
318 | If you convey an object code work under this section in, or with, or
319 | specifically for use in, a User Product, and the conveying occurs as
320 | part of a transaction in which the right of possession and use of the
321 | User Product is transferred to the recipient in perpetuity or for a
322 | fixed term (regardless of how the transaction is characterized), the
323 | Corresponding Source conveyed under this section must be accompanied
324 | by the Installation Information. But this requirement does not apply
325 | if neither you nor any third party retains the ability to install
326 | modified object code on the User Product (for example, the work has
327 | been installed in ROM).
328 |
329 | The requirement to provide Installation Information does not include a
330 | requirement to continue to provide support service, warranty, or updates
331 | for a work that has been modified or installed by the recipient, or for
332 | the User Product in which it has been modified or installed. Access to a
333 | network may be denied when the modification itself materially and
334 | adversely affects the operation of the network or violates the rules and
335 | protocols for communication across the network.
336 |
337 | Corresponding Source conveyed, and Installation Information provided,
338 | in accord with this section must be in a format that is publicly
339 | documented (and with an implementation available to the public in
340 | source code form), and must require no special password or key for
341 | unpacking, reading or copying.
342 |
343 | 7. Additional Terms.
344 |
345 | "Additional permissions" are terms that supplement the terms of this
346 | License by making exceptions from one or more of its conditions.
347 | Additional permissions that are applicable to the entire Program shall
348 | be treated as though they were included in this License, to the extent
349 | that they are valid under applicable law. If additional permissions
350 | apply only to part of the Program, that part may be used separately
351 | under those permissions, but the entire Program remains governed by
352 | this License without regard to the additional permissions.
353 |
354 | When you convey a copy of a covered work, you may at your option
355 | remove any additional permissions from that copy, or from any part of
356 | it. (Additional permissions may be written to require their own
357 | removal in certain cases when you modify the work.) You may place
358 | additional permissions on material, added by you to a covered work,
359 | for which you have or can give appropriate copyright permission.
360 |
361 | Notwithstanding any other provision of this License, for material you
362 | add to a covered work, you may (if authorized by the copyright holders of
363 | that material) supplement the terms of this License with terms:
364 |
365 | a) Disclaiming warranty or limiting liability differently from the
366 | terms of sections 15 and 16 of this License; or
367 |
368 | b) Requiring preservation of specified reasonable legal notices or
369 | author attributions in that material or in the Appropriate Legal
370 | Notices displayed by works containing it; or
371 |
372 | c) Prohibiting misrepresentation of the origin of that material, or
373 | requiring that modified versions of such material be marked in
374 | reasonable ways as different from the original version; or
375 |
376 | d) Limiting the use for publicity purposes of names of licensors or
377 | authors of the material; or
378 |
379 | e) Declining to grant rights under trademark law for use of some
380 | trade names, trademarks, or service marks; or
381 |
382 | f) Requiring indemnification of licensors and authors of that
383 | material by anyone who conveys the material (or modified versions of
384 | it) with contractual assumptions of liability to the recipient, for
385 | any liability that these contractual assumptions directly impose on
386 | those licensors and authors.
387 |
388 | All other non-permissive additional terms are considered "further
389 | restrictions" within the meaning of section 10. If the Program as you
390 | received it, or any part of it, contains a notice stating that it is
391 | governed by this License along with a term that is a further
392 | restriction, you may remove that term. If a license document contains
393 | a further restriction but permits relicensing or conveying under this
394 | License, you may add to a covered work material governed by the terms
395 | of that license document, provided that the further restriction does
396 | not survive such relicensing or conveying.
397 |
398 | If you add terms to a covered work in accord with this section, you
399 | must place, in the relevant source files, a statement of the
400 | additional terms that apply to those files, or a notice indicating
401 | where to find the applicable terms.
402 |
403 | Additional terms, permissive or non-permissive, may be stated in the
404 | form of a separately written license, or stated as exceptions;
405 | the above requirements apply either way.
406 |
407 | 8. Termination.
408 |
409 | You may not propagate or modify a covered work except as expressly
410 | provided under this License. Any attempt otherwise to propagate or
411 | modify it is void, and will automatically terminate your rights under
412 | this License (including any patent licenses granted under the third
413 | paragraph of section 11).
414 |
415 | However, if you cease all violation of this License, then your
416 | license from a particular copyright holder is reinstated (a)
417 | provisionally, unless and until the copyright holder explicitly and
418 | finally terminates your license, and (b) permanently, if the copyright
419 | holder fails to notify you of the violation by some reasonable means
420 | prior to 60 days after the cessation.
421 |
422 | Moreover, your license from a particular copyright holder is
423 | reinstated permanently if the copyright holder notifies you of the
424 | violation by some reasonable means, this is the first time you have
425 | received notice of violation of this License (for any work) from that
426 | copyright holder, and you cure the violation prior to 30 days after
427 | your receipt of the notice.
428 |
429 | Termination of your rights under this section does not terminate the
430 | licenses of parties who have received copies or rights from you under
431 | this License. If your rights have been terminated and not permanently
432 | reinstated, you do not qualify to receive new licenses for the same
433 | material under section 10.
434 |
435 | 9. Acceptance Not Required for Having Copies.
436 |
437 | You are not required to accept this License in order to receive or
438 | run a copy of the Program. Ancillary propagation of a covered work
439 | occurring solely as a consequence of using peer-to-peer transmission
440 | to receive a copy likewise does not require acceptance. However,
441 | nothing other than this License grants you permission to propagate or
442 | modify any covered work. These actions infringe copyright if you do
443 | not accept this License. Therefore, by modifying or propagating a
444 | covered work, you indicate your acceptance of this License to do so.
445 |
446 | 10. Automatic Licensing of Downstream Recipients.
447 |
448 | Each time you convey a covered work, the recipient automatically
449 | receives a license from the original licensors, to run, modify and
450 | propagate that work, subject to this License. You are not responsible
451 | for enforcing compliance by third parties with this License.
452 |
453 | An "entity transaction" is a transaction transferring control of an
454 | organization, or substantially all assets of one, or subdividing an
455 | organization, or merging organizations. If propagation of a covered
456 | work results from an entity transaction, each party to that
457 | transaction who receives a copy of the work also receives whatever
458 | licenses to the work the party's predecessor in interest had or could
459 | give under the previous paragraph, plus a right to possession of the
460 | Corresponding Source of the work from the predecessor in interest, if
461 | the predecessor has it or can get it with reasonable efforts.
462 |
463 | You may not impose any further restrictions on the exercise of the
464 | rights granted or affirmed under this License. For example, you may
465 | not impose a license fee, royalty, or other charge for exercise of
466 | rights granted under this License, and you may not initiate litigation
467 | (including a cross-claim or counterclaim in a lawsuit) alleging that
468 | any patent claim is infringed by making, using, selling, offering for
469 | sale, or importing the Program or any portion of it.
470 |
471 | 11. Patents.
472 |
473 | A "contributor" is a copyright holder who authorizes use under this
474 | License of the Program or a work on which the Program is based. The
475 | work thus licensed is called the contributor's "contributor version".
476 |
477 | A contributor's "essential patent claims" are all patent claims
478 | owned or controlled by the contributor, whether already acquired or
479 | hereafter acquired, that would be infringed by some manner, permitted
480 | by this License, of making, using, or selling its contributor version,
481 | but do not include claims that would be infringed only as a
482 | consequence of further modification of the contributor version. For
483 | purposes of this definition, "control" includes the right to grant
484 | patent sublicenses in a manner consistent with the requirements of
485 | this License.
486 |
487 | Each contributor grants you a non-exclusive, worldwide, royalty-free
488 | patent license under the contributor's essential patent claims, to
489 | make, use, sell, offer for sale, import and otherwise run, modify and
490 | propagate the contents of its contributor version.
491 |
492 | In the following three paragraphs, a "patent license" is any express
493 | agreement or commitment, however denominated, not to enforce a patent
494 | (such as an express permission to practice a patent or covenant not to
495 | sue for patent infringement). To "grant" such a patent license to a
496 | party means to make such an agreement or commitment not to enforce a
497 | patent against the party.
498 |
499 | If you convey a covered work, knowingly relying on a patent license,
500 | and the Corresponding Source of the work is not available for anyone
501 | to copy, free of charge and under the terms of this License, through a
502 | publicly available network server or other readily accessible means,
503 | then you must either (1) cause the Corresponding Source to be so
504 | available, or (2) arrange to deprive yourself of the benefit of the
505 | patent license for this particular work, or (3) arrange, in a manner
506 | consistent with the requirements of this License, to extend the patent
507 | license to downstream recipients. "Knowingly relying" means you have
508 | actual knowledge that, but for the patent license, your conveying the
509 | covered work in a country, or your recipient's use of the covered work
510 | in a country, would infringe one or more identifiable patents in that
511 | country that you have reason to believe are valid.
512 |
513 | If, pursuant to or in connection with a single transaction or
514 | arrangement, you convey, or propagate by procuring conveyance of, a
515 | covered work, and grant a patent license to some of the parties
516 | receiving the covered work authorizing them to use, propagate, modify
517 | or convey a specific copy of the covered work, then the patent license
518 | you grant is automatically extended to all recipients of the covered
519 | work and works based on it.
520 |
521 | A patent license is "discriminatory" if it does not include within
522 | the scope of its coverage, prohibits the exercise of, or is
523 | conditioned on the non-exercise of one or more of the rights that are
524 | specifically granted under this License. You may not convey a covered
525 | work if you are a party to an arrangement with a third party that is
526 | in the business of distributing software, under which you make payment
527 | to the third party based on the extent of your activity of conveying
528 | the work, and under which the third party grants, to any of the
529 | parties who would receive the covered work from you, a discriminatory
530 | patent license (a) in connection with copies of the covered work
531 | conveyed by you (or copies made from those copies), or (b) primarily
532 | for and in connection with specific products or compilations that
533 | contain the covered work, unless you entered into that arrangement,
534 | or that patent license was granted, prior to 28 March 2007.
535 |
536 | Nothing in this License shall be construed as excluding or limiting
537 | any implied license or other defenses to infringement that may
538 | otherwise be available to you under applicable patent law.
539 |
540 | 12. No Surrender of Others' Freedom.
541 |
542 | If conditions are imposed on you (whether by court order, agreement or
543 | otherwise) that contradict the conditions of this License, they do not
544 | excuse you from the conditions of this License. If you cannot convey a
545 | covered work so as to satisfy simultaneously your obligations under this
546 | License and any other pertinent obligations, then as a consequence you may
547 | not convey it at all. For example, if you agree to terms that obligate you
548 | to collect a royalty for further conveying from those to whom you convey
549 | the Program, the only way you could satisfy both those terms and this
550 | License would be to refrain entirely from conveying the Program.
551 |
552 | 13. Use with the GNU Affero General Public License.
553 |
554 | Notwithstanding any other provision of this License, you have
555 | permission to link or combine any covered work with a work licensed
556 | under version 3 of the GNU Affero General Public License into a single
557 | combined work, and to convey the resulting work. The terms of this
558 | License will continue to apply to the part which is the covered work,
559 | but the special requirements of the GNU Affero General Public License,
560 | section 13, concerning interaction through a network will apply to the
561 | combination as such.
562 |
563 | 14. Revised Versions of this License.
564 |
565 | The Free Software Foundation may publish revised and/or new versions of
566 | the GNU General Public License from time to time. Such new versions will
567 | be similar in spirit to the present version, but may differ in detail to
568 | address new problems or concerns.
569 |
570 | Each version is given a distinguishing version number. If the
571 | Program specifies that a certain numbered version of the GNU General
572 | Public License "or any later version" applies to it, you have the
573 | option of following the terms and conditions either of that numbered
574 | version or of any later version published by the Free Software
575 | Foundation. If the Program does not specify a version number of the
576 | GNU General Public License, you may choose any version ever published
577 | by the Free Software Foundation.
578 |
579 | If the Program specifies that a proxy can decide which future
580 | versions of the GNU General Public License can be used, that proxy's
581 | public statement of acceptance of a version permanently authorizes you
582 | to choose that version for the Program.
583 |
584 | Later license versions may give you additional or different
585 | permissions. However, no additional obligations are imposed on any
586 | author or copyright holder as a result of your choosing to follow a
587 | later version.
588 |
589 | 15. Disclaimer of Warranty.
590 |
591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
599 |
600 | 16. Limitation of Liability.
601 |
602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
610 | SUCH DAMAGES.
611 |
612 | 17. Interpretation of Sections 15 and 16.
613 |
614 | If the disclaimer of warranty and limitation of liability provided
615 | above cannot be given local legal effect according to their terms,
616 | reviewing courts shall apply local law that most closely approximates
617 | an absolute waiver of all civil liability in connection with the
618 | Program, unless a warranty or assumption of liability accompanies a
619 | copy of the Program in return for a fee.
620 |
621 | END OF TERMS AND CONDITIONS
622 |
623 | How to Apply These Terms to Your New Programs
624 |
625 | If you develop a new program, and you want it to be of the greatest
626 | possible use to the public, the best way to achieve this is to make it
627 | free software which everyone can redistribute and change under these terms.
628 |
629 | To do so, attach the following notices to the program. It is safest
630 | to attach them to the start of each source file to most effectively
631 | state the exclusion of warranty; and each file should have at least
632 | the "copyright" line and a pointer to where the full notice is found.
633 |
634 |
635 | Copyright (C)
636 |
637 | This program is free software: you can redistribute it and/or modify
638 | it under the terms of the GNU General Public License as published by
639 | the Free Software Foundation, either version 3 of the License, or
640 | (at your option) any later version.
641 |
642 | This program is distributed in the hope that it will be useful,
643 | but WITHOUT ANY WARRANTY; without even the implied warranty of
644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
645 | GNU General Public License for more details.
646 |
647 | You should have received a copy of the GNU General Public License
648 | along with this program. If not, see .
649 |
650 | Also add information on how to contact you by electronic and paper mail.
651 |
652 | If the program does terminal interaction, make it output a short
653 | notice like this when it starts in an interactive mode:
654 |
655 | Copyright (C)
656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
657 | This is free software, and you are welcome to redistribute it
658 | under certain conditions; type `show c' for details.
659 |
660 | The hypothetical commands `show w' and `show c' should show the appropriate
661 | parts of the General Public License. Of course, your program's commands
662 | might be different; for a GUI interface, you would use an "about box".
663 |
664 | You should also get your employer (if you work as a programmer) or school,
665 | if any, to sign a "copyright disclaimer" for the program, if necessary.
666 | For more information on this, and how to apply and follow the GNU GPL, see
667 | .
668 |
669 | The GNU General Public License does not permit incorporating your program
670 | into proprietary programs. If your program is a subroutine library, you
671 | may consider it more useful to permit linking proprietary applications with
672 | the library. If this is what you want to do, use the GNU Lesser General
673 | Public License instead of this License. But first, please read
674 | .
675 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | 
2 |
3 |
4 | **TubeTube** is a simple YouTube downloader.
5 |
6 |
7 | ## Features:
8 | - **Multithreaded Downloads:** Fast, simultaneous downloads.
9 | - **Custom Locations & Formats:** YAML-based settings.
10 | - **Mobile Optimized:** Designed for small screens.
11 | - **Download Options:** Choose between audio or video.
12 | - **Live Video Support:** Supports multiple live streams.
13 |
14 |
15 | ## Docker Compose Configuration
16 |
17 | Create a `docker-compose.yml` file:
18 |
19 | ```yaml
20 | services:
21 | tubetube:
22 | image: ghcr.io/mattblackonly/tubetube:latest
23 | container_name: tubetube
24 | ports:
25 | - 6543:6543
26 | volumes:
27 | - /path/to/general:/data/General
28 | - /path/to/music:/data/Music
29 | - /path/to/podcasts:/data/Podcast
30 | - /path/to/videos:/data/Video
31 | - /path/to/config:/config
32 | - /path/to/temp:/temp # Optional. Temp files are deleted on startup.
33 | - /etc/localtime:/etc/localtime:ro # Optional. Sync time with host.
34 | - /etc/timezone:/etc/timezone:ro # Optional. Sync timezone with host.
35 | environment:
36 | - PUID=1000
37 | - PGID=1000
38 | restart: unless-stopped
39 | ```
40 |
41 |
42 | ## Directory Configuration
43 |
44 | Create a `settings.yaml` file in the `/path/to/config` directory with the following format:
45 |
46 | ```yaml
47 | General:
48 | audio_ext: m4a
49 | audio_format_id: '140'
50 | video_ext: mp4
51 | video_format_id: '625'
52 | Music:
53 | audio_ext: mp3
54 | audio_format_id: '140'
55 | Podcast:
56 | audio_ext: m4a
57 | audio_format_id: '140'
58 | Video:
59 | audio_format_id: '140'
60 | video_ext: mp4
61 | video_format_id: '625'
62 |
63 | ```
64 |
65 |
66 | ### Notes:
67 |
68 | - Replace `/path/to/general`, etc.. with actual paths on your host machine.
69 | - Ensure the `settings.yaml` file is correctly placed in the `/path/to/config` directory.
70 | - The volume paths in the `docker-compose.yml` file should match the names specified in the settings.yaml file (e.g., /data/**General**, etc..).
71 | - You can create as many directory locations as needed in `settings.yaml`, but each must be mapped individually in `docker-compose.yml`.
72 | - To use a cookies file, create a `cookies.txt` file and place it in the config directory.
73 |
74 | #### Subtitle Configuration
75 |
76 | - When `WRITE_SUBS=True`, actual subtitles will be saved to a subtitle file. If no actual subtitles are available, no subtitles will be created. Additionally, setting `ALLOW_AUTO_SUBS=True` provides a fallback to automatically generated subtitles saved to the subtitle file.
77 | - When `EMBED_SUBS=True`, actual subtitles will be embedded into the video. If no actual subtitles are present, no subtitles will be included. Similarly, `ALLOW_AUTO_SUBS=True` can serve as a fallback to embed automatically generated subtitles.
78 |
79 | To effectively manage subtitles, enable `ALLOW_AUTO_SUBS` in conjunction with either `WRITE_SUBS` or `EMBED_SUBS`. This configuration will attempt to download actual subtitles, and if they are not available, it will default to using automatically generated subtitles.
80 |
81 | ## Configuration via Environment Variables
82 |
83 | Customize the behavior of **TubeTube** by setting the following environment variables in your `docker-compose.yml` file:
84 |
85 | ```yaml
86 | environment:
87 | - PUID=1000 # User ID for permissions (default: 1000)
88 | - PGID=1000 # Group ID for permissions (default: 1000)
89 | - VERBOSE_LOGS=false # Enable verbose logging for yt-dlp (default: false)
90 | - TRIM_METADATA=false # Trim metadata from files (default: false)
91 | - PREFERRED_LANGUAGE=en # Desired audio language for downloads (default: en)
92 | - PREFERRED_AUDIO_CODEC=aac # Desired audio codec (default: aac)
93 | - PREFERRED_VIDEO_CODEC=vp9 # Desired video codec (default: vp9)
94 | - PREFERRED_VIDEO_EXT=mp4 # Desired video file extension (default: mp4)
95 | - EMBED_SUBS=false # Embed subtitles in the video (default: false)
96 | - WRITE_SUBS=false # Write subtitles as separate files (default: false)
97 | - ALLOW_AUTO_SUBS=false # Allow automatically generated subtitles as a fallback (default: true)
98 | - SUBTITLE_FORMAT=vtt # Format of the subtitles (default: vtt)
99 | - SUBTITLE_LANGUAGES=en # Subtitle language (default: en)
100 | - THREAD_COUNT=4 # Number of threads for processing (default: 4)
101 | ```
102 |
103 | ## Screenshots
104 |
105 | ### Phone (Dark Mode)
106 |
107 | 
108 |
109 |
110 |
111 | ### Desktop (Dark Mode)
112 |
113 | 
114 |
115 |
116 | ## Star History
117 |
118 |
119 |
120 |
121 |
122 |
123 |
124 |
--------------------------------------------------------------------------------
/requirements.txt:
--------------------------------------------------------------------------------
1 | gunicorn
2 | gevent
3 | gevent-websocket
4 | flask
5 | flask_socketio
6 | yt_dlp[default]==2025.05.22
7 | pyyaml
8 |
--------------------------------------------------------------------------------
/start.sh:
--------------------------------------------------------------------------------
1 | #!/bin/sh
2 |
3 | # ASCII Art
4 | echo "-----------------------------------------------------------"
5 | echo " TTTTT U U BBBBB EEEEE TTTTT U U BBBBB EEEEE"
6 | echo " T U U B B E T U U B B E "
7 | echo " T U U BBBBB EEEE T U U BBBBB EEEE "
8 | echo " T U U B B E T U U B B E "
9 | echo " T UUU BBBBB EEEEE T UUU BBBBB EEEEE"
10 | echo "-----------------------------------------------------------"
11 | echo "TUBETUBE - YouTube Downloader using yt-dlp"
12 | echo -e "\e[1;32mDesigned by MattBlackOnly\e[0m"
13 | echo "-----------------------------------------------------------"
14 |
15 | # Log versions
16 | if [ -z "$TUBETUBE_VERSION" ]; then
17 | echo "TUBETUBE_VERSION environment variable is not set."
18 | else
19 | echo "Tubetube version: ${TUBETUBE_VERSION}"
20 | fi
21 |
22 | if [ -f "requirements.txt" ]; then
23 | YT_DLP_VERSION=$(awk -F'==' '/yt_dlp\[default\]/{print $2}' requirements.txt)
24 | if [ -z "$YT_DLP_VERSION" ]; then
25 | echo "yt-dlp version not found in requirements.txt"
26 | else
27 | echo "yt-dlp version: $YT_DLP_VERSION"
28 | fi
29 | else
30 | echo "requirements.txt not found."
31 | fi
32 |
33 | # Default values for PUID and PGID
34 | PUID=${PUID:-1000}
35 | PGID=${PGID:-1000}
36 |
37 | echo "Using PUID=${PUID} and PGID=${PGID}"
38 |
39 | # Modify the appuser and appgroup to match PUID and PGID
40 | if [ "$(id -u appuser)" != "$PUID" ] || [ "$(id -g appuser)" != "$PGID" ]; then
41 | echo "Updating UID and GID for appuser to match PUID:PGID..."
42 | deluser appuser
43 | addgroup -g "$PGID" appgroup
44 | adduser -D -u "$PUID" -G appgroup appuser
45 | fi
46 |
47 | # Ensure ownership of /config, /data and /temp are correct
48 | echo "Setting up directories..."
49 | chown -R appuser:appgroup /config /data /temp
50 |
51 | # Start the application as appuser
52 | echo "Starting TubeTube..."
53 | exec su-exec appuser:appgroup gunicorn tubetube.tubetube:app -c start_app.py
54 |
--------------------------------------------------------------------------------
/start_app.py:
--------------------------------------------------------------------------------
1 | bind = "0.0.0.0:6543"
2 | workers = 1
3 | threads = 4
4 | timeout = 180
5 | worker_class = "geventwebsocket.gunicorn.workers.GeventWebSocketWorker"
6 |
--------------------------------------------------------------------------------
/tubetube/__init__.py:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/MattBlackOnly/TubeTube/921398bd00b5e26a64a53a920fb9001f0f513108/tubetube/__init__.py
--------------------------------------------------------------------------------
/tubetube/helpers.py:
--------------------------------------------------------------------------------
1 | import re
2 | import yt_dlp
3 |
4 |
5 | def parse_video_id(url):
6 | patterns = [
7 | r"(?:https?://)?(?:www\.)?(?:youtube\.com/watch\?v=|youtu\.be/)([a-zA-Z0-9_-]{11})",
8 | r"(?:https?://)?(?:www\.)?youtube\.com/embed/([a-zA-Z0-9_-]{11})",
9 | r"(?:https?://)?(?:www\.)?youtube\.com/share/([a-zA-Z0-9_-]{11})",
10 | ]
11 |
12 | for pattern in patterns:
13 | match = re.match(pattern, url)
14 | if match:
15 | return match.group(1)
16 | return None
17 |
18 |
19 | class TrimDescriptionPP(yt_dlp.postprocessor.PostProcessor):
20 | def run(self, info):
21 | description = info.get("description", "")
22 |
23 | if description:
24 | trimmed_description = description[:250]
25 | self.to_screen(f"Original description length: {len(description)}")
26 | self.to_screen(f"Trimmed description to 250 chars: {trimmed_description}")
27 |
28 | info["description"] = trimmed_description
29 | else:
30 | self.to_screen("No description found to trim.")
31 |
32 | return [], info
33 |
--------------------------------------------------------------------------------
/tubetube/settings.py:
--------------------------------------------------------------------------------
1 | import os
2 | import logging
3 | import yaml
4 |
5 |
6 | class DownloadCancelledException(Exception):
7 | pass
8 |
9 |
10 | class Config:
11 | SECRET_KEY = "a_secret_key"
12 | SOCKETIO_CORS_ALLOWED_ORIGINS = "*"
13 | DEFAULT_FOLDER_LOCATIONS = {
14 | "Video": {"video_ext": "mp4", "video_format_id": "625", "audio_format_id": "140"},
15 | "Music": {"audio_ext": "mp3", "audio_format_id": "140"},
16 | "Podcast": {"audio_ext": "m4a", "audio_format_id": "140"},
17 | "General": {"audio_ext": "m4a", "audio_format_id": "140", "video_ext": "mp4", "video_format_id": "625"},
18 | }
19 |
20 |
21 | class Settings:
22 | def __init__(self):
23 | self.config_folder = "/config"
24 | self.settings_file_path = os.path.join(self.config_folder, "settings.yaml")
25 |
26 | self.folder_locations = self._load_settings()
27 | self.audio_locations, self.video_locations = self._categorise_locations()
28 |
29 | all_folders = set(self.audio_locations.keys()).union(set(self.video_locations.keys()))
30 |
31 | for folder_name in all_folders:
32 | os.makedirs(os.path.join("/data", folder_name), exist_ok=True)
33 |
34 | os.makedirs(self.config_folder, exist_ok=True)
35 |
36 | cookies_json_file = os.path.join(self.config_folder, "cookies.txt")
37 | self.cookies_file = cookies_json_file if os.path.exists(cookies_json_file) else None
38 |
39 | def _load_settings(self):
40 | if not os.path.exists(self.settings_file_path):
41 | with open(self.settings_file_path, "w") as file:
42 | yaml.safe_dump(Config.DEFAULT_FOLDER_LOCATIONS, file, default_flow_style=False)
43 | return Config.DEFAULT_FOLDER_LOCATIONS
44 |
45 | try:
46 | with open(self.settings_file_path, "r") as file:
47 | return yaml.safe_load(file) or Config.DEFAULT_FOLDER_LOCATIONS
48 |
49 | except yaml.YAMLError as e:
50 | logging.error(f"YAML loading error: {e}")
51 | return Config.DEFAULT_FOLDER_LOCATIONS
52 |
53 | def _categorise_locations(self):
54 | audio_locations = {}
55 | video_locations = {}
56 |
57 | for folder_name, download_settings in self.folder_locations.items():
58 | has_video = "video_ext" in download_settings
59 | has_audio = "audio_ext" in download_settings
60 |
61 | if has_video:
62 | video_locations[folder_name] = download_settings
63 | if has_audio:
64 | audio_locations[folder_name] = download_settings
65 |
66 | return audio_locations, video_locations
67 |
--------------------------------------------------------------------------------
/tubetube/static/js_general_script.js:
--------------------------------------------------------------------------------
1 | const socket = io();
2 | const folderSelect = document.getElementById('folder-location-select');
3 | const mediaTypeSwitch = document.getElementById('media-type-switch');
4 | const downloadButton = document.getElementById('download-button');
5 | const spinnerBorder = document.getElementById('spinner-border');
6 | const urlInput = document.getElementById('download-url');
7 |
8 | let folderData = {
9 | audio: {},
10 | video: {}
11 | };
12 |
13 | function populateDropdown() {
14 | folderSelect.innerHTML = '';
15 |
16 | const mediaType = mediaTypeSwitch.checked ? 'audio' : 'video';
17 | const dataToUse = folderData[mediaType];
18 |
19 | Object.keys(dataToUse).forEach(name => {
20 | const option = document.createElement('option');
21 | option.value = name;
22 | option.textContent = name;
23 | folderSelect.appendChild(option);
24 | });
25 |
26 | const selectedFolder = localStorage.getItem(`selectedFolder_${mediaType}`);
27 | if (selectedFolder && dataToUse[selectedFolder]) {
28 | folderSelect.value = selectedFolder;
29 | } else {
30 | folderSelect.value = '';
31 | }
32 | }
33 |
34 | function saveSelection() {
35 | const mediaType = mediaTypeSwitch.checked ? 'audio' : 'video';
36 | localStorage.setItem(`selectedFolder_${mediaType}`, folderSelect.value);
37 | localStorage.setItem('mediaType', mediaType);
38 | }
39 |
40 | socket.on('update_folder_locations', function (data) {
41 | folderData = data;
42 | const savedMediaType = localStorage.getItem('mediaType') || 'video';
43 | mediaTypeSwitch.checked = savedMediaType === 'audio';
44 | populateDropdown();
45 | });
46 |
47 | mediaTypeSwitch.addEventListener('change', function () {
48 | populateDropdown();
49 | saveSelection();
50 | });
51 |
52 | folderSelect.addEventListener('change', saveSelection);
53 |
54 | function initiateDownload() {
55 | const url = urlInput;
56 |
57 | if (!url.value.trim()) {
58 | alert('The URL is empty. Please provide a URL to download.');
59 | return;
60 | }
61 |
62 | const folderName = folderSelect.value;
63 | if (folderName === "Select folder location" || folderName === "") {
64 | alert('No folder selected. Please select a valid folder.');
65 | return;
66 | }
67 |
68 | const audioOnly = mediaTypeSwitch.checked;
69 | socket.emit('download', { url: url.value, folder_name: folderName, audio_only: audioOnly });
70 | url.disabled = true;
71 | downloadButton.disabled = true;
72 | spinnerBorder.style.display = 'inline-block';
73 |
74 | setTimeout(() => {
75 | spinnerBorder.style.display = 'none';
76 | url.value = '';
77 | url.disabled = false;
78 | downloadButton.disabled = false;
79 | }, 2500);
80 | }
81 |
82 | downloadButton.addEventListener('click', initiateDownload);
83 |
84 | urlInput.addEventListener('keydown', function (event) {
85 | if (event.key === 'Enter') {
86 | event.preventDefault();
87 | initiateDownload();
88 | }
89 | });
90 |
91 | socket.on("toast", function (data) {
92 | document.getElementById('toast-title').innerText = data.title;
93 | document.getElementById('toast-message').innerText = data.body;
94 | document.getElementById('toast-time').innerText = new Date().toLocaleTimeString();
95 |
96 | var toastElement = document.getElementById('toast');
97 | var toast = new bootstrap.Toast(toastElement);
98 | toast.show();
99 | });
--------------------------------------------------------------------------------
/tubetube/static/js_table_script.js:
--------------------------------------------------------------------------------
1 | const tableBody = document.getElementById('activity-table-body');
2 | const template = document.getElementById('row-template');
3 | const selectAll = document.getElementById('select-all');
4 | const removeSelected = document.getElementById('remove-selected');
5 | const removeCompleted = document.getElementById('remove-completed');
6 | let lastChecked = null;
7 |
8 | function updateSelectAllState() {
9 | const allCheckboxes = document.querySelectorAll('.row-select');
10 | const allChecked = Array.from(allCheckboxes).every(checkbox => checkbox.checked);
11 | const anyChecked = Array.from(allCheckboxes).some(checkbox => checkbox.checked);
12 |
13 | selectAll.checked = allChecked;
14 | selectAll.indeterminate = !allChecked && anyChecked;
15 | }
16 |
17 | function renderRow(data) {
18 | const row = document.importNode(template.content, true);
19 | const tr = row.querySelector('tr');
20 |
21 | const checkbox = tr.querySelector('.row-select');
22 | const uniqueId = `checkbox-${data.id}`;
23 |
24 | checkbox.setAttribute('id', uniqueId);
25 | checkbox.setAttribute('name', `row-select-${data.id}`);
26 | checkbox.addEventListener('change', updateSelectAllState);
27 |
28 | tr.setAttribute('data-id', data.id);
29 | tr.querySelector('.row-select').setAttribute('data-id', data.id);
30 | tr.querySelector('.id').textContent = data.id;
31 | tr.querySelector('.title').textContent = data.title;
32 | tr.querySelector('.status').textContent = data.status;
33 | tr.querySelector('.download-progress').textContent = data.progress;
34 | tableBody.appendChild(tr);
35 | }
36 |
37 | socket.on('update_download_list', (items) => {
38 | tableBody.innerHTML = '';
39 | for (const id in items) {
40 | renderRow(items[id]);
41 | }
42 | });
43 |
44 | socket.on('update_download_item', (update) => {
45 | const item = update.item;
46 | const row = document.querySelector(`tr[data-id='${item.id}']`);
47 | if (row) {
48 | row.querySelector('.status').textContent = item.status;
49 | row.querySelector('.download-progress').textContent = item.progress;
50 | }
51 | });
52 |
53 | socket.on('remove_download_item', (update) => {
54 | const row = document.querySelector(`tr[data-id='${update.id}']`);
55 | if (row) {
56 | row.remove();
57 | }
58 |
59 | const rowCount = document.querySelectorAll('#activity-table-body tr').length;
60 | if (rowCount === 0) {
61 | selectAll.checked = false;
62 | }
63 | });
64 |
65 | selectAll.addEventListener('change', function () {
66 | const isChecked = this.checked;
67 | document.querySelectorAll('.row-select').forEach(checkbox => {
68 | checkbox.checked = isChecked;
69 | });
70 | });
71 |
72 | removeSelected.addEventListener('click', function () {
73 | const removeIds = [];
74 | const cancelIds = [];
75 |
76 | document.querySelectorAll('.row-select:checked').forEach(checkbox => {
77 | const row = checkbox.closest('tr');
78 | const id = parseInt(row.getAttribute('data-id'), 10);
79 | const status = row.querySelector('.status').textContent.trim();
80 |
81 | if (status === 'In Progress' || status === 'Downloading' || status === 'Pending') {
82 | cancelIds.push(id);
83 | } else {
84 | removeIds.push(id);
85 | }
86 | });
87 |
88 | if (cancelIds.length > 0) {
89 | socket.emit('cancel_items', cancelIds);
90 | }
91 | if (removeIds.length > 0) {
92 | socket.emit('remove_items', removeIds);
93 | }
94 | });
95 |
96 | removeCompleted.addEventListener('click', function () {
97 | const completedIds = [];
98 |
99 | document.querySelectorAll('#activity-table-body tr').forEach(row => {
100 | const status = row.querySelector('.status').textContent.trim()
101 | if (status === 'Complete' || status === 'Cancelled') {
102 | const id = parseInt(row.getAttribute('data-id'), 10);
103 | completedIds.push(id);
104 | row.remove();
105 | }
106 | });
107 |
108 | if (completedIds.length > 0) {
109 | socket.emit('remove_items', completedIds);
110 | }
111 | });
112 |
113 | tableBody.addEventListener('click', function (event) {
114 | if (event.target.classList.contains('row-select')) {
115 | const currentCheckbox = event.target;
116 |
117 | if (event.shiftKey && lastChecked) {
118 | const checkboxes = Array.from(document.querySelectorAll('.row-select'));
119 | const start = checkboxes.indexOf(lastChecked);
120 | const end = checkboxes.indexOf(currentCheckbox);
121 |
122 | const range = checkboxes.slice(Math.min(start, end), Math.max(start, end) + 1);
123 | range.forEach(checkbox => {
124 | checkbox.checked = lastChecked.checked;
125 | });
126 | }
127 |
128 | lastChecked = currentCheckbox;
129 | updateSelectAllState();
130 | return;
131 | }
132 |
133 | const row = event.target.closest('tr');
134 | if (row) {
135 | const checkbox = row.querySelector('.row-select');
136 | if (checkbox) {
137 | checkbox.checked = !checkbox.checked;
138 |
139 | lastChecked = checkbox;
140 | updateSelectAllState();
141 | }
142 | }
143 | });
144 |
--------------------------------------------------------------------------------
/tubetube/static/js_theme_switcher.js:
--------------------------------------------------------------------------------
1 | const dayButton = document.getElementById('dayMode');
2 | const autoButton = document.getElementById('autoMode');
3 | const nightButton = document.getElementById('nightMode');
4 | const storedTheme = localStorage.getItem('theme');
5 | const storedMode = localStorage.getItem('mode');
6 |
7 | if (storedMode === 'auto') {
8 | setTheme(getSystemTheme());
9 | } else {
10 | setTheme(storedTheme || 'light');
11 | }
12 |
13 | function setTheme(theme) {
14 | document.documentElement.setAttribute('data-bs-theme', theme);
15 |
16 | const body = document.body;
17 | if (theme === 'light') {
18 | body.classList.add('bg-body-tertiary');
19 | } else if (theme === 'dark') {
20 | body.classList.remove('bg-body-tertiary');
21 | }
22 |
23 | dayButton.classList.toggle('active', theme === 'light' && localStorage.getItem('mode') === 'manual');
24 | autoButton.classList.toggle('active', localStorage.getItem('mode') === 'auto');
25 | nightButton.classList.toggle('active', theme === 'dark' && localStorage.getItem('mode') === 'manual');
26 | }
27 |
28 | function getSystemTheme() {
29 | return window.matchMedia('(prefers-color-scheme: dark)').matches ? 'dark' : 'light';
30 | }
31 |
32 | window.matchMedia('(prefers-color-scheme: dark)').addEventListener('change', event => {
33 | if (localStorage.getItem('mode') === 'auto') {
34 | setTheme(getSystemTheme());
35 | }
36 | });
37 |
38 | dayButton.addEventListener('click', () => {
39 | localStorage.setItem('theme', 'light');
40 | localStorage.setItem('mode', 'manual');
41 | setTheme('light');
42 | });
43 |
44 | nightButton.addEventListener('click', () => {
45 | localStorage.setItem('theme', 'dark');
46 | localStorage.setItem('mode', 'manual');
47 | setTheme('dark');
48 | });
49 |
50 | autoButton.addEventListener('click', () => {
51 | localStorage.setItem('mode', 'auto');
52 | setTheme(getSystemTheme());
53 | });
--------------------------------------------------------------------------------
/tubetube/static/logo.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/MattBlackOnly/TubeTube/921398bd00b5e26a64a53a920fb9001f0f513108/tubetube/static/logo.png
--------------------------------------------------------------------------------
/tubetube/static/phone-screenshot.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/MattBlackOnly/TubeTube/921398bd00b5e26a64a53a920fb9001f0f513108/tubetube/static/phone-screenshot.png
--------------------------------------------------------------------------------
/tubetube/static/screenshot.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/MattBlackOnly/TubeTube/921398bd00b5e26a64a53a920fb9001f0f513108/tubetube/static/screenshot.png
--------------------------------------------------------------------------------
/tubetube/static/style.css:
--------------------------------------------------------------------------------
1 | body {
2 | margin: 0;
3 | padding: 0;
4 | }
5 |
6 | .container {
7 | max-width: 85% !important;
8 | }
9 |
10 | .activity-table-section {
11 | height: 45vh;
12 | overflow-y: auto;
13 | }
14 |
15 | ::-webkit-scrollbar {
16 | width: 12px;
17 | }
18 |
19 | ::-webkit-scrollbar-track {
20 | background: #ffffff;
21 | border-radius: 10px;
22 | }
23 |
24 | ::-webkit-scrollbar-thumb {
25 | background: #007bffa4;
26 | border-radius: 10px;
27 | }
28 |
29 | ::-webkit-scrollbar-thumb:hover {
30 | background: #007bff;
31 | }
32 |
33 | ::-webkit-scrollbar-corner {
34 | background: #f1f1f1;
35 | }
36 |
37 | .fixed-layout {
38 | width: 100%;
39 | table-layout: fixed;
40 | }
41 |
42 | .checkbox-column {
43 | width: 5%;
44 | padding-bottom: 7.4px !important;
45 | }
46 |
47 | .row-select-checkbox {
48 | padding-top: 9px !important;
49 | }
50 |
51 | .id-column {
52 | width: 5%;
53 | padding-bottom: 7.2px !important;
54 | }
55 |
56 | .title-column {
57 | width: 45%;
58 | }
59 |
60 | .status-column {
61 | width: 27.5%;
62 | }
63 |
64 | .progress-column {
65 | width: 17.5%;
66 | }
67 |
68 | .text-wrap {
69 | white-space: normal;
70 | }
71 |
72 | @media screen and (max-width: 600px) {
73 | .container {
74 | max-width: 99% !important;
75 | }
76 |
77 | .activity-table-section {
78 | height: 50vh;
79 | overflow-x: auto;
80 | }
81 |
82 | .id-column,
83 | .progress-column {
84 | display: none;
85 | }
86 |
87 | .id,
88 | .download-progress {
89 | display: none;
90 | }
91 |
92 | .checkbox-column {
93 | width: 5%;
94 | padding-bottom: 6.23px !important;
95 | }
96 |
97 | .row-select-checkbox {
98 | padding-top: 9.75px !important;
99 | }
100 |
101 | .title-column {
102 | width: 40%;
103 | }
104 |
105 | .status-column {
106 | width: 25%;
107 | }
108 |
109 | .fixed-layout {
110 | overflow-x: auto;
111 | width: 100%;
112 | }
113 | }
--------------------------------------------------------------------------------
/tubetube/static/tubetube.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/MattBlackOnly/TubeTube/921398bd00b5e26a64a53a920fb9001f0f513108/tubetube/static/tubetube.png
--------------------------------------------------------------------------------
/tubetube/templates/index.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
7 | TubeTube
8 |
10 |
13 |
16 |
17 |
18 |
19 |
20 |
21 |
22 |