Skip to content

Latest commit

 

History

History
161 lines (112 loc) · 4.83 KB

README.md

File metadata and controls

161 lines (112 loc) · 4.83 KB
Raw

HomePage

HomePage is a trivial flask web app that pulls the audio track from almost any internet video. It is intended to be deployed inside a private network for private use.

HomePage relies on trustworthy youtube_dl to download the videos, so quite a few sites are supported. Playlists are also supported.

HomePage

Prerequsites

  • python 3.6 or above with pip
  • Superuser access (for port 80)
  • pyenv and poetry (not required with PyPi)
  • Ubuntu, Debian, Mint or Arch.

Install

The basic installation is very simple.

$ python3 -m pip install --user homepage

# Normal desktop
$ homepage -i

# Server without x11
$ homepage -ic

If you are using Arch, please ensure you have an up-to-date version and package list

Then, you can deploy with:

$ homepage -dfp

Alternatively, if your system is running an older version of python or you wish to run this project inside a virtual environment, you can do that too.

First, go ahead and install pyenv. Then install poetry. Once you've installed those, we just to install a few more things.

$ git clone https://github.com/Sh3llcod3/HomePage.git
$ cd HomePage/
$ pyenv install 3.9.0
$ pyenv local 3.9.0
$ poetry poetry self update --preview
$ poetry update
$ poetry install # Add --no-dev if you don't want dev deps
$ poetry shell
$ homepage -ip
$ homepage -df

After installing pyenv, the lines you add to your ~/.bashrc/.bash_profile may need to be different, please see the FAQ.

Uninstall

If you installed using pip:

python3 -m pip uninstall -y homepage easyparse Flask youtube_dl gevent

and it will remove this completely from your system. You can vary this command based on what you want to keep.

Otherwise, if you've installed using poetry and assuming you're inside the current directory:

$ exit # Exit virtualenv or press Ctrl-d
$ poetry env remove 3.9
$ poetry cache clear --all pypi
$ cd .. && rm -rf HomePage/

Usage

Once deployed, if you're using this on the device which is hosting it, fire up your favourite web browser and head to the displayed address. If you're on another device, simply head to the IP address of the host node.

If you have Superuser access, use the -f switch. This will add an iptables rule forwarding port 80 to 5000.

Playlists are supported and all sites that will with ytdl will also work here.

Troubleshooting

I'm having problems with the env

You may have inserted the wrong lines in your ~/.bashrc or .bash_profile (if using arch). The initialization lines shown on the pyenv repo don't work well with poetry. Instead, add these lines to the end of the file and remove any previous lines you may have added before (taking care to ensure you don't remove anything else).

# Pyenv installation

if [[ -z "$VIRTUAL_ENV" ]]; then
    export PATH="$HOME/.pyenv/bin:$PATH"
    eval "$(pyenv init -)"
fi

Can I change the background?

To change the background, swap out homepage/static/bg.webp with any image you like, but keep the same name and use WEBP format.

Pyenv fails to install 3.9.0

You may have forgotten to install the crucial pyenv dependencies. Check here for their wiki page.

Then retry the pyenv installation.

Why does this exist?

I wanted a simple no-frills web-app to pull audio tracks on private network devices, without having access to a command line version of youtube_dl or resorting to using external sites or apps.

Why is it not working?

Your version of youtube_dl may be out of date. Having a version of youtube_dl that is even one version old can mean your tracks may fail to download. Fortunately, the repo is updated frequently and you can pull in the updates very easily.

If you're using it from PyPi, then:

$ python3 -m pip install --upgrade youtube_dl gevent Flask --user
$ youtube-dl --rm-cache-dir

If you're using it from Poetry, then go to your cloned repo and run:

$ poetry update
$ poetry shell

Does this scale to multiple users asynchronously?

No. It was never intended to scale in the first place. Neither is it secure in any way. Therefore, I should stress that you should NOT deploy this to anywhere except your RFC1918 private/internal network range with caution.

Does it have Windows support?

Yes. If you can get the latest executables for lame, atomicparsley, faac, ffmpeg and place them inside the project's directory, it should work.

To-do

  • Add auth
  • Replace xhr with websocket
  • Save user preferences using cookies
  • Display past tracks only for that user
  • Add management card
  • Make it work on windows and generate executables