Skip to content

Commit

Permalink
Added some doc about the first launch
Browse files Browse the repository at this point in the history
  • Loading branch information
epoupon committed Oct 30, 2024
1 parent 0ad2a1c commit b7af040
Showing 1 changed file with 10 additions and 2 deletions.
12 changes: 10 additions & 2 deletions INSTALL.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,11 @@
+ [Upgrade](#upgrade)
- [Deployment](#deployment)
* [Configuration](#configuration)
* [Authentication backend](#authentication-backend)
* [Authentication backends](#authentication-backends)
* [Deploy on non root path](#deploy-on-non-root-path)
* [Reverse proxy settings](#reverse-proxy-settings)
- [Run](#run)
- [First launch](#first-launch)
# Installation
## Docker
_Docker_ images are available, please see detailed instructions on https://hub.docker.com/r/epoupon/lms.
Expand Down Expand Up @@ -100,7 +101,7 @@ __Note__: don't forget to give the _lms_ user read access to the music directory
_LMS_ uses a configuration file, installed by default in `/etc/lms.conf`. It is recommended to edit this file and change relevant settings (listen address, listen port, working directory, Subsonic API activation, deployment path, ...).
All other settings are set using the web interface (user management, scan settings, transcode settings, ...).
If a setting is not present in the configuration file, a hardcoded default value is used (the same as in the [default configuration file](conf/lms.conf))
## Authentication backend
## Authentication backends
You can define which authentication backend to be used thanks to the `authentication-backend` option:
* `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).
Expand Down Expand Up @@ -170,3 +171,10 @@ Log traces can be accessed using journactl:
journalctl -u lms.service
```
To connect to _LMS_, just open your favorite browser and go to `http://localhost:5082`
# First launch
At the first launch, a setup assistant will guide you through creating the administrator account (username and password). Once this information is saved, you can refresh the page to access the LMS login screen.
__Note__: If you are using PAM authentication via HTTP header, this setup assistant will not appear (see [Authentication backend](#authentication-backends)).

Once logged in as an administrator, you will need to define your libraries—that is, select the music folders you want to scan. Then, check that the scan settings meet your needs (scan frequency, delimiter application, etc.).

You can now initiate the initial scan to import your music into LMS.

0 comments on commit b7af040

Please sign in to comment.