Peertube-dl/README.md

# Peertube-dl

A little Perl program which downloads videos from some webpages.

Wants to be something similar to youtube-dl with support for some sites not acceptables under youtube-dl policies.

Of course the name means Peertube will be supported someday.

## Supported webpages:

animeflv.net

animeflv.cc

kjanime.net

youtube.com (Video only in webpage, all formats on cli.)

## Installation

There is two alternative ways applying to the GNU/Linux OS:

### System install

```shell
# Be aware the apt command applies to Debian/Ubuntu or other distributions using apt as their package manager.
# I am not adding instructions to every distro since they can difficult reading this document.
# You should use the equivalent packages for your distribution if you are not using a Debian-like distribution of GNU/Linux.
sudo apt install perl make libwww-perl liburi-encode-perl libjson-perl liblwp-protocol-https-perl libtest-mockobject-perl libtest-most-perl libmojolicious-perl
perl Makefile.PL
make
make test
make install
```

### Localized install with cpanminus.

```
sudo apt install cpanminus
cpanm . --installdeps
cpanm .
```

### Windows

You should use Cywgin, Strawberry perl or WSL to be able to use this software in Windows
and then follow one of the two procedures given before to GNU/Linux.

I am not giving you a detailed instructions in that case given that I am not responsible 
of your bad software choices in operative systems.

### MAC

Maybe you can use homebrew to get the prerequisites and then install this program using the install 
with cpanminus.

Again not detailed instructions since it is not my problem the defective by desing OS and
hardware you choose.

It is doable anyway if you want to give a try.

## Usage

`peertube-dl <Supported url>`

You can assume the supported urls are the ones which have a media player.

## Webpage

You can deploy a webpage using:

`peertube-dl-web daemon`

For testing or:

`peertube-dl-hypnotoad`

In production.

The environment variable support for PIDFILE makes easy to write an init script.

## Disclaimer

SEEING THE ADS TO SUPPORT THE JOB OF THE DISTRIBUTORS AND CONTENT CREATORS 
ASSOCIATED WITH THESE PAGES IS CURRENTLY NOT SUPPORTED BUT CAN BE OPTIONAL
IN A FUTURE.

THIS SOFTWARE COMES WITH THE HOPE IT WILL BE USEFUL BUT WITHOUT ANY WARRANTY.

A COPY OF THE LICENSE WHICH APPLIES FOR THIS SOFTWARE (AGPLV3) CAN BE FOUND IN 
THE LICENSE FILE.

IF YOU RUN ANY PART OF THIS CODE AS A SERVICE OR DISTRIBUTE IT YOU MUST CONVEY
THE SOURCE CODE IN A HUMAN READABLE FORM TO THE DISTRIBUTEE OR USER.

## COPYRIGHT

© 2020 Sergio Iglesias and people listed on AUTHORS, if you submit a commit for
the first time add yourself to that file. Leave a Matrix address so I can reach
you for possible changes in the license, like a possible upgrade to a newer version
of AGPL.