From a119bed0de63aa2660db50e37e29423a43bda8a9 Mon Sep 17 00:00:00 2001 From: emeric Date: Sat, 21 Jan 2023 11:43:48 +0100 Subject: [PATCH] Simplified doc --- INSTALL.md | 3 ++- README.md | 11 ++--------- 2 files changed, 4 insertions(+), 10 deletions(-) diff --git a/INSTALL.md b/INSTALL.md index 4be9decd..4190eb08 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -105,7 +105,7 @@ You can define which authentication backend to be used thanks to the `authentica * `internal` (default): _LMS_ uses an internal database to store users and their associated passwords (salted and hashed using [Bcrypt](https://en.wikipedia.org/wiki/Bcrypt)). Only the admin user can create, edit or remove other users. * `PAM`: the user/password authentication request is forwarded to PAM (see the default [PAM configuration file](conf/pam/lms) provided). * `http-headers`: _LMS_ uses a configurable HTTP header field, typically set by a reverse proxy to handle [SSO](https://en.wikipedia.org/wiki/Single_sign-on), to extract the login name. You can customize the field to be used using the `http-headers-login-field` option. -__Note__: the first created user is the admin user +__Note__: the first created user is the admin user. #### `internal` backend: reset admin password Open the the database file located in `/var/lms/lms.db` using `sqlite3`: ```sh @@ -158,6 +158,7 @@ server { } } ``` +__Note__: to mitigate brute force login attempts, _LMS_ uses an internal login throttler based on the client IP address. The `Client-IP` or `X-Forwarded-For` headers are used to determine the real IP adress, so make sure to properly configure your reverse proxy to filter or even erase the values. # Run ```sh systemctl start lms diff --git a/README.md b/README.md index fc5600d2..a922f217 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ A [demo instance](http://lms-demo.poupon.dev) is available. Note the administrat ## Main features * Recommendation engine -* Audio transcode for maximum interoperability and low bandwith requirements +* Audio transcoding for maximum interoperability and reduced bandwith requirements * Multi-value tags: `genre`, `albumgenre`, `mood`, `albummood`, `albumgrouping`, ... * Artist relationships: `composer`, `conductor`, `lyricist`, `mixer`, `performer`, `producer`, `remixer` * [MusicBrainz Identifier](https://musicbrainz.org/doc/MusicBrainz_Identifier) support to handle duplicated artist and release names @@ -21,12 +21,11 @@ A [demo instance](http://lms-demo.poupon.dev) is available. Note the administrat ## Music discovery _LMS_ provides several ways to help you find the music you like: -* Tag-based filters (ex: _Rock_, _Metal_ and _Aggressive_, _Electronic_ and _Relaxed_, ...) +* Tag-based filters (ex: "_Rock_", "_Metal_ and _Aggressive_", "_Electronic_ and _Relaxed_", ...) * Recommendations for similar artists and albums * Radio mode, with endless filling of the play queue with tracks similar to what is there * Searches in album, artist and track names (including sort names) * Starred Albums/Artists/Tracks -* Various tags to help you filter your music: _mood_, _albummood_, _albumgenre_, _albumgrouping_, ... * Random/Starred/Most played/Recently played/Recently added for Artist/Albums/Tracks, allowing you to search for things like: * Recently added _Electronic_ artists * Random _Metal_ and _Aggressive_ albums @@ -64,12 +63,6 @@ $setmulti(albumartistssort,%_albumartists_sort%) * Previous track: Ctrl + Left * Next track: Ctrl + Right -## Security considerations -_Wt_ (the web framework used) has some [built-in security measures](https://www.webtoolkit.eu/wt/features#security), but _LMS_ also has some too: -* to mitigate brute force login attempts, _LMS_ uses an internal login throttler based on the client IP address. The `Client-IP` or `X-Forwarded-For` headers are used to determine the real IP adress, so make sure to properly configure your reverse proxy to filter or even erase the values (see example in [INSTALL.md](INSTALL.md)). -* all passwords are stored hashed and salted using [bcrypt](https://fr.wikipedia.org/wiki/Bcrypt) -* all the resources relative to the music collection (tracks, covers, etc.) are private to an anthenticated session - ## Installation See [INSTALL.md](INSTALL.md) file.