You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
52 lines
2.6 KiB
52 lines
2.6 KiB
# Startup Configuration Guide
|
|
|
|
Libresonic has some system-wide configuration. These configurations are stored in the
|
|
`libresonic.properties` file. There are some exceptions, such as the `libresonic.home` parameter, which
|
|
are supplied as a Java System Property.
|
|
|
|
## libresonic.properties Parameters
|
|
These parameters are simple key-value pairs stored in a list. It is recommended that these parameters
|
|
are changed through the web interface settings page. However, they can also be modified directly. Shutdown
|
|
your server first, modify, then start it for changes to take effect.
|
|
|
|
## Java Parameters
|
|
These parameters are not modifiable through the web interface. See below for steps for setting Java Parameters.
|
|
|
|
#### `libresonic.home`
|
|
This parameter dictates the folder where Libresonic will store its logs,
|
|
settings, transcode binaries, index and database if using the default H2
|
|
database. As such it is recommended to backup this folder.
|
|
|
|
*default: `/var/libresonic` or `C:\\music`*
|
|
|
|
### Spring Boot/Standlone Specific Configs
|
|
The following configs only apply when running libresonic as a standalone package (i.e. without Tomcat or Jetty). These are only a subset of the connfigurations for spring-boot, the full list can be found [here](https://docs.spring.io/spring-boot/docs/1.4.5.RELEASE/reference/htmlsingle/#common-application-properties). Not that not all configurations apply to libresonic, but the important section is the `# EMBEDDED SERVER CONFIGURATION` section.
|
|
|
|
#### `server.port`
|
|
This property only applies for spring boot/standalone config. It changes the port that the standalone package listens on.
|
|
|
|
*default: 8080*
|
|
|
|
#### `server.address`
|
|
This property only applies for spring boot/standalone config. It changes the address that the standalone package listens on.
|
|
|
|
*default: not set and listens to all addresses*
|
|
|
|
### Setting Java Parameters on Tomcat
|
|
As described in the [RUNNING.txt](http://tomcat.apache.org/tomcat-8.0-doc/RUNNING.txt) doc provided by tomcat,
|
|
you can create a file named `setenv.sh` or for windows `setenv.bat` in the Tomcat home `bin` folder to modify the
|
|
java args.
|
|
|
|
Here is an example of a `setenv.sh` file (`setenv.bat` has slightly different syntax):
|
|
```
|
|
export JAVA_OPTS="$JAVA_OPTS -Dlibresonic.home=/home/andrew/.cache/libresonic-test"
|
|
```
|
|
|
|
### Setting Java Parameters for Standalone Package (SpringBoot)
|
|
When running the standalone package, add `-Dlibresonic.home=YOUR_PATH_HERE` to the `java` command line right before the
|
|
`-jar` argument. Here is an example for linux (windows users will want to use their OS specific path syntax i.e.
|
|
`C:\\your\path`)
|
|
|
|
```
|
|
java -Dlibresonic.home=/home/andrew/libresonichome -jar libresonic.war
|
|
```
|
|
|