1.9 KiB
Set Port
Use the -p command to set the port. Will default to 3000 if not set
mstream -p 5050
SSL
All you need to do is set the cert and key file and mStream will do the rest
mstream -c /path/to/cert.pem -k /path/to/key.pem
User System
mStream can have a single user and guest. If the user is not set mStream will disable to the user system and anyone will be able to access the server
# Set User
mstream -u [username] -x [password]
# Set user and guest
mstream -u [username] -x [password] -G [guest name] -X [guest password]
secret
You can set your login secret key with the -s command
mstream -s /path/to/secret/file
If not set mStream will generate a random string to use as the secret key on boot. If rebooted, the secret key will be regenerated and any previous keys will no longer work
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
Automatically setup port forwarding
mStream can try to automatically setup port forwarding via upnp. 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 100000