docs

[Efreak]

docs

[anacrolix]

There's no help for running the program, description of how it works, etc. Without actually running the program, there's no way to tell how easy it is to use, or why it should be used in place of something else. Even just the output from the program would help, though it would be better to explain each option. I'll submit a pull adding the first two columns to the readme, but it would be better to have the addressed problems fixed.

Understandable, this project is really only in minimal maintenance mode on my part. I merged your PR, thanks.

Usage of dms:

Parameter Description Problem
-allowedIps string allowed ip of clients, separated by comma is there a default? like 127.0.0,1?
-config string json configuration file there's no example config file. What are the key names?
-deviceIcon string device icon Is there a default built-in? according to the screenshot, no, but the screenshot is so old it's no longer available (I made a pull to fix this)

Cheers

-fFprobeCachePath string path to FFprobe cache file (default "/home/efreak/.dms-ffprobe-cache")
-forceTranscodeTo string force transcoding to certain format, supported: 'chromecast', 'vp8'
-friendlyName string server friendly name Is there a default for this?

I think it generates it from the listen port and host name.

-http string http server port (default ":1338")
-ifname string specific SSDP network interface
-ignoreHidden ignore hidden files and directories Is hidden directories OS-specific? is it .hidden or does it support hidden windows directories too?

I think this is specific to Windows.

-ignoreUnreadable ignore unreadable files and directories
-logHeaders log HTTP headers Where does the log go? I assume stdout, but maybe stderr?

Pretty sure it's stderr.

-noProbe disable media probing with ffprobe
-noTranscode disable transcoding
-notifyInterval duration interval between SSPD announces (default 30s)
-path string browse root path does this index only specific types of files, or are all files indexed? If only specific file types are indexed, does it use the file extension or magic numbers, or ffprobe?, If it doesn't index everything, is there a way to specify/override what gets indexed? (ie, if I want my epubs or descriptive text files indexed as well)

Pretty sure it just filters images and videos. The reason is below.

-stallEventSubscribe workaround for some bad event subscribers What does this do, exactly?
Personally, I'm looking for a solution for roku, which (to my understanding) requires HLS streams. I'm not sure if this program provides this or not.

It's my impression that HLS is much more usable than UPnP/DLNA. However this project was written to interface with TVs that only supported UPnP/DLNA back in the day. I don't know what the HLS support is like now, and if there are more devices supporting it or alternatives in that area. However this project does still work with most TVs, and provides the bare minimum.

You're welcome to start a larger documentation effort if it interests you if this project works for you? It is packaged in several major distros so I'm sure downstream will be very receptive to usability improvements.