Skip to content

Latest commit

 

History

History
114 lines (92 loc) · 4.31 KB

README.md

File metadata and controls

114 lines (92 loc) · 4.31 KB

Etherna Video Importer

Overview

Tool to import videos on Etherna from different sources.

Instructions

Download and extract binaries from release page.

Currently exists two versions:

  • EthernaVideoImporter for a generic use
  • EthernaVideoImporter.Devcon to import specifically Devcon Archive's videos

Etherna Video Importer requires at least .NET 7 Runtime and ASP.NET Core 7 Runtime installed on local machine to run, or it needs the selfcontained version of package, that already contains framework dependencies.

Warning: this client still requires to be able to open a browser to provide authentication.
Future releases will improve this aspect accepting API keys instead.

Setup FFmpeg

To run the importer it is necessary to download FFmpeg locally, and copy the binary file into the default folder "\FFmpeg", or specify its location with arguments.

How to use

EthernaVideoImporter's help

Usage:  EthernaVideoImporter SOURCE_TYPE SOURCE_URI [OPTIONS]

Source types:
  ytchannel     YouTube channel
  ytvideo       YouTube video
  local         Local videos

Options:
  -ff   Path FFmpeg (default dir: .\FFmpeg\)
  -t    TTL (days) Postage Stamp (default value: 365 days)
  -o    Offer video downloads to everyone
  -p    Pin videos
  -m    Remove indexed videos generated with this tool but missing from source
  -e    Remove indexed videos not generated with this tool
  -u    Try to unpin contents removed from index
  -i    Ignore new version of EthernaVideoImporter
  --beenode             Use bee native node
  --beenodeurl          Url of Bee node (default value: http://localhost/)
  --beenodeapiport      Port used by API (default value: 1633)
  --beenodedebugport    Port used by Debug (default value: 1635)
  --skip1440    Skip upload resolution 1440p
  --skip1080    Skip upload resolution 1080p
  --skip720     Skip upload resolution 720p
  --skip480     Skip upload resolution 480p
  --skip360     Skip upload resolution 360p

Run 'EthernaVideoImporter -h' to print help

EthernaVideoImporter.Devcon's help

Usage:  EthernaVideoImporter.Devcon md MD_FOLDER [OPTIONS]

Options:
  -ff   Path FFmpeg (default dir: .\FFmpeg\)
  -t    TTL (days) Postage Stamp (default value: 365 days)
  -o    Offer video downloads to everyone
  -p    Pin videos
  -m    Remove indexed videos generated with this tool but missing from source
  -e    Remove indexed videos not generated with this tool
  -u    Try to unpin contents removed from index
  -i    Ignore new version of EthernaVideoImporter.Devcon
  --beenode             Use bee native node
  --beenodeurl          Url of Bee node (default value: http://localhost/)
  --beenodeapiport      Port used by API (default value: 1633)
  --beenodedebugport    Port used by Debug (default value: 1635)
  --skip1440    Skip upload resolution 1440p
  --skip1080    Skip upload resolution 1080p
  --skip720     Skip upload resolution 720p
  --skip480     Skip upload resolution 480p
  --skip360     Skip upload resolution 360p

Run 'EthernaVideoImporter.Devcon -h' to print help

Local videos

To import from local videos you will need a metadata descriptor file.
Metadata is a Json file with following structure.

[
    {
        "Id": "myId1",
        "Title": "My video 1 title",
        "Description": "My video description",
        "VideoFilePath": "my/source/local/video/path.mp4",
        "ThumbnailFilePath": "my/optional/thumbnail/path.jpg"
    },
    {
        "Id": "myId2",
        "Title": "My video 2 title",
        ...
    },
    ...
]

The Id field is mandatory, and is needed to trace same video through different executions. Each Id needs to be unique in the file.
The ThumbnailFilePath field is optional.

The Json file path needs to be passed as source uri with the source type local.

Issue reports

If you've discovered a bug, or have an idea for a new feature, please report it to our issue manager based on Jira https://etherna.atlassian.net/projects/EVI.

Detailed reports with stack traces, actual and expected behaviours are welcome.

Questions? Problems?

For questions or problems please write an email to [email protected].