MightyPork/airsonic-custom
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Added some notes about spring boot parameters

Browse Source
This commit is contained in:
Andrew DeMaria
2017-04-06 16:38:52 -05:00
committed by GitHub
parent 0902a6c846
commit c579837595
1 changed files with 19 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files
documentation/CONFIGURATION.md
+19 -7
View File
@@ -1,17 +1,16 @@
# Startup Configuration Guide # Startup Configuration Guide
Libresonic has some system-wide configuration. These configurations are stored in the Libresonic has some system-wide configuration. These configurations are stored in the
`libresonic.properties` file. There is one exception, which is the `libresonic.home` parameter which `libresonic.properties` file. There are some exceptions, such as the `libresonic.home` parameter, which
is supplied as a Java System Property. are supplied as a Java System Property.
## `libresonic.properties` ## libresonic.properties Parameters
These parameters are simple key-value pairs stored in a list. It is recommended that these 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 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. your server first, modify, then start it for changes to take effect.
## Java Parameters ## Java Parameters
The `libresonic.home` parameter is a Java System Property that is not modifiable through the web interface. These parameters are not modifiable through the web interface. See below for steps for setting Java Parameters.
It must be configured via Java startup parameters. See below for steps to do this.
#### `libresonic.home` #### `libresonic.home`
This parameter dictates the folder where Libresonic will store its logs, This parameter dictates the folder where Libresonic will store its logs,
@@ -20,7 +19,20 @@ database. As such it is recommended to backup this folder.
*default: `/var/libresonic` or `C:\\music`* *default: `/var/libresonic` or `C:\\music`*
#### Setting Java Parameters on Tomcat ### 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, 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 you can create a file named `setenv.sh` or for windows `setenv.bat` in the Tomcat home `bin` folder to modify the
java args. java args.
@@ -30,7 +42,7 @@ Here is an example of a `setenv.sh` file (`setenv.bat` has slightly different sy
export JAVA_OPTS="$JAVA_OPTS -Dlibresonic.home=/home/andrew/.cache/libresonic-test" export JAVA_OPTS="$JAVA_OPTS -Dlibresonic.home=/home/andrew/.cache/libresonic-test"
``` ```
#### Setting Java Parameters for Standalone Package (SpringBoot) ### 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 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. `-jar` argument. Here is an example for linux (windows users will want to use their OS specific path syntax i.e.
`C:\\your\path`) `C:\\your\path`)