diff --git a/README.md b/README.md index 6cfc962..c788631 100644 --- a/README.md +++ b/README.md @@ -29,7 +29,7 @@ mStrean is also available as a pre-compiled EXE for Windows. This version is ca mStream can be run with command `mstream`. This will boot an mStream server on port 3000 and will use the current working directory as your music directory. -#### Configure with CLI Flags +### Configure with CLI Flags The quickest way to setup mStream is to use command line flags. [A full list of command line settings can be seen here.](docs/cli_arguments.md) These config options should be enough for most users. More advanced configurations can be made by using a JSON config file @@ -49,7 +49,7 @@ mstream -m /path/to/music mstream -l username -z password ``` -#### Configure mStream with a JSON file +### Configure mStream with a JSON file mStream can also be booted using a JSON file using the `-j` flag. Using a JSON config file allows for more advanced configuration options, such as multiple users and folders. diff --git a/docs/json_config.md b/docs/json_config.md index 51b7a5b..4f3373f 100644 --- a/docs/json_config.md +++ b/docs/json_config.md @@ -41,19 +41,19 @@ All these params have default values. Technically, an empty objects would be val { } ``` -### Port +## Port Sets the port. Defaults to 3000 if not set -### UI +## UI Folder that contains the frontend for mStream. Defaults to `public` if not set -### Secret +## Secret Sets the secret key used for the login system. If this is not set, mStream will generate a random secret key on boot and previous login sessions will be voided -### Database +## Database This option is a relic of the past when mStream also supported SQLite. Right now only the path can be set. This defaults to the current working directory @@ -63,7 +63,7 @@ This option is a relic of the past when mStream also supported SQLite. Right now }, ``` -### Folders +## Folders Folders are set by key value pairs. The key is used later to give access to folders on a per user basis. (more info in the users section) @@ -78,7 +78,7 @@ There are two valid syntaxes for folders For now, these are identical. In the future, mStream will be able to offer different frontend features based on the directory type. -### Users +## Users A basic user example. @@ -147,7 +147,7 @@ If there is no users object, the login system will not be enabled and anyone wil } ``` -### SSL` +## SSL mStream comes with SSL support built in. Jsut add your key and cert and the server wil ltake care of the rest @@ -158,7 +158,7 @@ mStream comes with SSL support built in. Jsut add your key and cert and the ser } ``` -### Album Art +## Album Art Sets the path where album art will be saved. Defaults to the `image-cache` folder in the mStream directory @@ -166,7 +166,7 @@ Sets the path where album art will be saved. Defaults to the `image-cache` folde "albumArtDir": "/media/album-art" ``` -### LastFM Scrobbling +## LastFM Scrobbling Each user can have their own lastFM credentails @@ -207,7 +207,7 @@ If you want to use LastFM scrobbling without a user system, you can do the follo } ``` -### Port Forwarding +## Port Forwarding Set tunnel to true if you want mStream to try to auto configure port forwarding via uPNP