github
/
hobune
mirror of https://github.com/rebane2001/hobune
1
Fork 0
Code Releases Activity

Updated readme

This commit is contained in:
rebane2001 2023-05-11 17:16:46 +03:00
parent 0e317c90e0
commit e9eaabaa69
1 changed files with 14 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
README.md
View File

@ -4,16 +4,25 @@ A lightweight static HTML generator for self-hosting yt-dlp video archives.
# Features
- Static HTML (fast and secure)
- Parses yt-dlp info.json format
- Channel pages (with thumbnails)
- Channel pages (with thumbnails, name history)
- Watch page (with stats, description etc)
- Download buttons (video, description, thumbnail, subtitles)
- Highlight deleted videos
- Client-side search
- Highlight deleted/unlisted videos
- Client-side search/sorting
# Usage
1. Clone this repo (or download as zip).
2. Rename the `default.json` file to `config.json` and edit the `ytpath`, `ytpathweb`, `webpath`, `outpath` and `removedvideosfile` variables to suit your setup.
3. Run `python3 hobune.py`, this will generate HTML files in your `outpath`.
2. Rename the `default.json` file to `config.json` and edit the variables to suit your setup:
- `site_name`: Name/Title of the site (e.g. "Hobune")
- `files_path`: Local path of the video files (e.g. "/var/www/html/files/")
- `files_web_path`: Web path of the video files (e.g. "/files/" or "https://example.com/files/")
- `web_root`: Web root path (e.g. "/" or "https://example.com/")
- `output_path`: Output path for the HTML files (e.g. "/var/www/html/")
- `add_html_ext`: Add HTML extension to links (e.g. link to /videos/foobar.html instead of /videos/foobar)
- `removed_videos_file`: A text file where each line ends with a removed video ID (optional, e.g. "~/removed_videos.txt")
- `unlisted_videos_file`: Unlisted videos file - similar to the removed videos file (optional)
3. Run `python3 hobune.py`, this will generate HTML files in your `output_path`.
4. (optionally) Configure your webserver to allow downloads from /dl URLs and HTML pages without extensions.
```
@ -31,8 +40,3 @@ location /dl {
```
It is also recommended to edit the python script to suit your exact needs, since your setup probably won't be 1:1 same as the expected one.
# Notes (2022)
This codebase is a bit of a mess at the moment and I need to clean it up and refactor it at some point. Windows is not supported without code changes, although it can be made to work.
I've also added my comments code to this repo in an unorganized fashion. It is disabled by default, if you'd like to use it please read the contents of `comments.py`.