mStream/docs/cli_arguments.md
2017-03-21 16:06:57 -04:00

1.3 KiB

Automatically setup port forwarding

mStream can try to automatically open a port to the internet. Use the '-t' command to try to setup port forwarding.

mstream  -t

Please note that not all routers will allow this. Some routers may close this port after a period of time.

You can get around this by having mStream retry this on a regular interval

mstream -t -r [time in milliseconds]
mstream -t -r 10000

Set Port

mstream -p 5050

User System

mStream can have a single user and guest.

# Set User
mstream -u [username] -x [password]

# Set user and guest
mstream -u [username] -x [password] -G [guest name] -X [guest password]

Database Options

You can either use mStream's default database or tap into BeetsDB.

Beets DB

mstream -D beets -d /path/to/beets.db

When using Beets, mStream is put into a read only mode. mStream will not be able to write to any tables that are managed by Beets. Playlist functionality is not affected by this since playlists are stored in a separate table.

Built In DB

mStream can read metadata and write it's own database. By default mStream will create a database in the folder it's launched in called 'mstreamdb.lite'. You can manually set the database file with:

mstream -d /path/to/mstream.db