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.
90 lines
3.7 KiB
90 lines
3.7 KiB
# Database Selection
|
|
|
|
Libresonic is built with generic ANSI SQL (for the most part) and uses [Liquibase](http://www.liquibase.org/)
|
|
for database migrations in a database agnostic way and should be
|
|
able to run against a variety of databases. However, not all databases have been verified to
|
|
work and you may run into issues with the liquibase migrations or runtime SQL issues. Here is
|
|
a list of community tested setups:
|
|
|
|
| Database | Version | Liquibase | Runtime | Notes |
|
|
|:----------:|:-------:|:---------:|:-------:|:------:|
|
|
| HyperSQL | 1.8 | ✔ | ✔ | Default|
|
|
| HyperSQL | 2.X | ✕ | ✕ | No curent plans to support, look into SQLite instead? |
|
|
| PostgreSQL | 9.5 | ✔ | ✔ | |
|
|
| MariaDB | 10.2 | ✔ | ✔ | |
|
|
| MySQL | 5.7.17 | ✔ | ✕ | WIP |
|
|
|
|
If you wish to continue using the current hsql 1.8 database driver, no action is needed. If you wish to use another
|
|
database, read on.
|
|
|
|
# Database Configuration
|
|
|
|
*Before doing anything, make sure your database is properly backed up. Ensure your server is shutdown*
|
|
|
|
For those that wish to change their database, instructions differ based on
|
|
whether you wish for your database connection to be managed by your container (tomcat),
|
|
or whether you wish Libresonic to manage it for you. The former may offer some performance
|
|
gains in the case of many concurrent users with connection pooling while the latter is easiest.
|
|
|
|
We will refer to container managed configuration as jndi and libresonic managed configuration as embedded.
|
|
|
|
## Embedded
|
|
*Before doing anything, make sure your database is properly backed up. Ensure your server is shutdown*
|
|
|
|
In your libresonic.properties file, you will need to add the following settings (this is just an example):
|
|
|
|
```
|
|
DatabaseConfigType=embed
|
|
DatabaseConfigEmbedDriver=org.hsqldb.jdbcDriver
|
|
DatabaseConfigEmbedUrl=jdbc:hsqldb:file:/tmp/libre/db/libresonic
|
|
DatabaseConfigEmbedUsername=sa
|
|
DatabaseConfigEmbedPassword=
|
|
```
|
|
|
|
In addition, you will need to ensure that a jdbc driver suitable for your
|
|
database is on the
|
|
[classpath](https://docs.oracle.com/javase/8/docs/technotes/tools/windows/classpath.html).
|
|
|
|
*Note adding to the classpath is currently pretty difficult for spring-boot. Tomcat is easy, just copy into tomcat home
|
|
/lib. TODO: provide prebuilt artifacts with tested databases built in?*
|
|
|
|
## JNDI
|
|
*Before doing anything, make sure your database is properly backed up. Ensure your server is shutdown*
|
|
|
|
In your libresonic.properties file, you will need to add the following settings (this is just an example):
|
|
|
|
```
|
|
DatabaseConfigType=jndi
|
|
DatabaseConfigJNDIName=jdbc/libresonicDB
|
|
```
|
|
|
|
Then in your context.xml in your tomcat directory, add the jndi config:
|
|
|
|
```
|
|
<Resource name="jdbc/libresonicDB" auth="Container"
|
|
type="javax.sql.DataSource"
|
|
maxActive="20"
|
|
maxIdle="30"
|
|
maxWait="10000"
|
|
username="libresonic"
|
|
password="REDACTED"
|
|
driverClassName="com.mysql.jdbc.Driver"
|
|
url="jdbc:mysql://hostname/libresonic?sessionVariables=sql_mode=ANSI_QUOTES"/>
|
|
|
|
```
|
|
|
|
Finally, copy the jdbc driver from the database vendor website to the `lib` directory in your tomcat folder.
|
|
|
|
## Database Vendor Specific Notes
|
|
|
|
### PostgreSQL
|
|
|
|
`stringtype=unspecified` on your jdbc url string is necessary.
|
|
|
|
You will also need to add `DatabaseUsertableQuote=\"` to your properties
|
|
file. This is due to the fact that our `user` table is a keyword for postgres.
|
|
|
|
## Troubleshooting
|
|
|
|
In the event that you change these settings, restart your server and it fails to start, you can remedy this by reverting
|
|
to the LEGACY config by removing all `Database*` settings from your `libresonic.properties` file.
|
|
|