a FIFO queue system for FFmpeg jobs for uwutube next. Documentation | Issues | Pull Requests

Dependencies

• redis - >= 6.0

Endpoints

POST /enqueue

Push a queue job to the stack.

Parameters

Name	Type	Description
file	File	A video file to transcode (with a MIME type specified in config.upload.supported_types).

Response

JSON

Name	Type	Description
status	Type	success or failure
message	Type	If the status is failure, a message containing the reason as to why the request failed.
file	Object	An object containing the file's given filename (/tmp/ID) as well as the time it was received.
stack	Object	An object containing the position of this job on the stack (0 to config.upload.max_queue_jobs) as well as the file's given ID (generated through UUID v4).

---

GET /enqueue

Get the number of jobs in the queue.

Parameters

None

Response

JSON

Name	Type	Description
queueSize	Integer	The current number of objects on the queue.

---

OPTIONS /enqueue

Return a list of possible options.

Parameters

None

Response

Headers

Name	Type	Description
Allow	String	A list of possible methods for use with this endpoint.

---

GET /status/:id

Parameters

Name	Type	Description
id	UUID	The ID of the job whose status is being requested.

Response

JSON

Name	Type	Description
id	Type	Description
value	Object	An object containing the file's fileName and the time it was uploaded.
inProgress	Boolean	true if the transcode is in-progress, false if the transcode has completed.
progress	Decimal	A value from 0 to 1 stating the current transcode progress.

---

OPTIONS /status

Return a list of possible options.

Parameters

None

Response

Headers

Name	Type	Description
Allow	String	A list of possible methods for use with this endpoint.

Running Locally

These instructions allow you to run ffmpeg-queue locally for development; please don't use these for production - instead, see the "Deploying" section below.

Using Docker

ffmpeg-queue has been configured for full use with Docker Compose. In order to use this, simply enter the main project directory and run docker compose up.

Manually

This manual method of running ffmpeg-queue is not recommended and does not include all components required to run the website. It is highly recommended that you run ffmpeg-queue using Docker.

To prepare the project, enter the directory and install dependencies thru yarn install. To run the project, enter the directory and run yarn start.

Deploying

Before deploying, please:

• Run git pull to ensure that you have the lastest version of the code, ensuring that all security fixes and patches are applied;
• Ensure that all config files are filled with correct information;
• Run yarn audit to ensure that there are no packages with security vulnerabilities.

Please be aware that none of the contributors to this project can be held responsible for data loss, pwnage / leaks, compromised accounts, etc.

Using Docker

TODO

Manually

TODO

License

Unless otherwise stated, files in this repository are provided under the GNU AGPLv3:

ffmpeg-queue - a simple FIFO queue system for FFmpeg jobs

Copyright (C) 2021 Alex Guthrie

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.

In addition to these terms, as per Section 7 of the license, the following additional terms are in effect:

Trademark use

This license does not grant any rights to use any trademarks 
associated with this program, including the trademark "uwutube", any 
logos associated with "uwutube" (such as the "uwutube" logo), or any 
other "uwutube" trademarks. This license also does not grant 
authorization to use the "uwutube" name or the names of any 
contributor for any purpose without written permission.

A copy of the GNU AGPLv3 is available within LICENSE.md, or at gnu.org.