Skip to content

Commit 635a53b

Browse files
committed
update docs
1 parent 68c417c commit 635a53b

File tree

3 files changed

+8
-9
lines changed

3 files changed

+8
-9
lines changed

docs/Changelog.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,8 @@
3838
### Removed: <!-- {docsify-ignore} -->
3939

4040
+ Balance control;
41-
+ `mediaPanel` URL parameter and config.json attribute has been deprecated - [use `frontPanel` instead](server.md#configjson-file);
41+
+ `config.json` configuration file converted to YAML - see [Self-hosting > config.yaml file](server.md#configyaml-file) (props to [**@Borewit**](https://github.com/hvianna/audioMotion.js/pull/94)).
42+
+ `mediaPanel` URL parameter has been deprecated - use [`frontPanel`](server.md#url-parameters) instead;
4243
+ Custom file server module (just use `npm start`);
4344
+ Code from the unfinished Electron version;
4445
+ Support for legacy `playlists.cfg` file.

docs/server.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -19,18 +19,16 @@ The storage is also tied to the server **address and port**, so if any of those
1919
A **config.yaml** file in the same directory as audioMotion's _index.html_ allows you to configure some server options.
2020

2121
```yaml
22-
{
23-
defaultAccessMode: local
24-
enableLocalAccess: true
25-
frontPanel: open
26-
}
22+
defaultAccessMode: local
23+
enableLocalAccess: true
24+
frontPanel: open
2725
```
2826
2927
| option | values (default in bold) | description |
3028
|--------|--------------------------|-------------|
31-
| **defaultAccessMode** | **`"local"`** \| `"server"` | Initial (first run) file access mode - user's device or /music directory on server
29+
| **defaultAccessMode** | **`local`** \| `server` | Initial (first run) file access mode - user's device or /music directory on server
3230
| **enableLocalAccess** | **`true`** \| `false` | Whether or not to enable access to local device (*true* allows user to switch between local or server)
33-
| **frontPanel** | **`"open"`** \| `"close"` | Initial state of the Front Panel - behaves like the [collapse/expand front panel button](users-manual.md#collapseexpand-front-panel)
31+
| **frontPanel** | **`open`** \| `close` | Initial state of the Front Panel - behaves like the [collapse/expand front panel button](users-manual.md#collapseexpand-front-panel)
3432

3533
## URL parameters
3634

public/config.yaml.example

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Initial (first run) file access mode - user’s device or /music directory on serve
1+
# Initial (first run) file access mode - user’s device or /music directory on server
22
# local | server
33
defaultAccessMode: local
44

0 commit comments

Comments
 (0)