mirrors/mStream
3
0
Fork 0
mirror of https://github.com/IrosTheBeggar/mStream.git synced 2025-10-27 07:31:02 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'master' of github.com:IrosTheBeggar/mStream into master

Browse Source
This commit is contained in:
IrosTheBeggar 2021-01-21 00:34:44 -05:00
commit 505019d7dc
2 changed files with 12 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/cli_arguments.md
View File

@ -1,10 +1,10 @@
As of v5-alpha there are only two arguments:
As of v4.7.0 there is only one cli parameter:
`--wizard` && `--json`
`--json` || `-j`
These both accept an argument of a config file
It accepts an argument of a json config file path
```
mstream -j /path/to/config.json
```
NOTE: v5 aims to simplify the setup process of mstream as much as possible. I might remove the wizard in favor of Admin UI later in the development of v5. If you have any opinions, let me know in the discord channel or on github.
NOTE: v5 aims to simplify the setup process of mstream as much as possible. The `--wizard` argument was removed in favor of Admin UI. If you have any opinions, let me know in the discord channel or on github.

19
docs/json_config.md
View File

@ -1,11 +1,3 @@
# Use The Wizard
Editing JSON by hand is tedious. All the json config options can be edited by using the cli wizard. To use it:
```
mstream --wizard /path/to/config.json
```
# JSON config
Using a JSON config with mStream allows for more advanced configurations. This example contains all configurable params for reference purposes.
@ -35,11 +27,13 @@ Using a JSON config with mStream allows for more advanced configurations. This
},
"users": {
"paul": {
"password":"p@ssword",
"password": "bKD6We4x40qcA2sDqVV0EHz1yiu5XDhnFlL6+JRrvMw=",
"salt": "PMsisJwG3F3m7atHtny40Q==",
"vpaths": ["blues", "rock"]
},
"james": {
"password": "qwerty",
"password": "qBg8vlOcqrhFpgVDd/2jVHgHamvb6xspjhxrpl5m3Is=",
"salt": "6cm1jPJ1Xl/ocLbaNijpJg==",
"vpaths": "rock",
"lastfm-user": "username",
"lastfm-password": "password"
@ -88,6 +82,8 @@ If there is no users object, the login system will not be enabled and anyone wil
A basic user example.
Note that the hashed password and salt can be generated automatically by creating a new user via the admin ui.
```json
{
"folders": {
@ -95,7 +91,8 @@ A basic user example.
},
"users": {
"paul": {
"password":"p@ssword",
"password": "bKD6We4x40qcA2sDqVV0EHz1yiu5XDhnFlL6+JRrvMw=",
"salt": "PMsisJwG3F3m7atHtny40Q==",
"vpaths": "media"
}
}