Andesite can be configured from 2 sources, from highest to lowest priority
- A HOCON file named
application.confin the application working directory - System environment variables (doesn't support arrays)
All andesite keys must be prefixed with andesite.. When using a HOCON file, they can be put inside a
block named andesite. Plugins may choose to use a different prefix.
An example config can be found here
| key | type | description | default |
|---|---|---|---|
| extra-plugins | string[] | array of paths to load plugins from, besides the default path | [] |
| password | string | password to use for http/websocket access. No filtering is done if null | null |
| debug-password | string | password to use for debug routes. If missing or null, the regular password is used instead. | null |
| log-level | string | lowest level to log | INFO |
| auto-ytsearch | boolean | whether or not andesite should automatically prepend ytsearch: to identifiers that don't match known prefixes when loading tracks |
true |
| audio-handler | string | audio handler implementation to use. By default, magma and koe are supported. Plugins may add more implementations, in which case the fully qualified class name must be used |
koe |
| node.region | string | region of the node | "unknown" |
| node.id | string | id of the node | "unknown" |
| transport.http.bind-address | string | address to bind the http/websocket server. 0.0.0.0 means all network interfaces on the machine | 0.0.0.0 |
| transport.http.port | integer | port to run the http/websocket server | 5000 |
| transport.http.rest | boolean | whether or not to enable the http api | true |
| transport.http.ws | boolean | whether or not to enable the websocket api | true |
| prometheus.enabled | boolean | whether or not to enable prometheus metrics | false |
| prometheus.path | string | path to collect prometheus metrics, uses the http port | /metrics |
| prometheus.update-period | duration | interval for collecting periodic stats with JFR | 3s |
| sentry.enabled | boolean | whether or not to enable sentry | false |
| sentry.dsn | string | sentry dsn to report errors | null |
| sentry.tags | string | comma separated list of key:value pairs for sentry tags |
null |
| sentry.log-level | string | lowest level to send to sentry | WARN |
| lavaplayer.frame-buffer-duration | integer | duration of the frame buffer, in milliseconds. changes in filters/volume take at least this time to start applying | 5000 |
| lavaplayer.non-allocating | boolean | whether or not to use the non allocating frame buffer | true |
| lavaplayer.youtube.max-playlist-page-count | int | maximum number of pages loaded from one playlist. There are 100 tracks per page. | 6 |
| lavaplayer.youtube.rotation.ips | string[] | IP blocks to use for rotation. IP rotation is disabled if empty | [] |
| lavaplayer.youtube.rotation.excluded-ips | string[] | IP addresses to exclude from rotation | [] |
| lavaplayer.youtube.rotation.strategy | string | strategy to use for rotation. Valid options are RotateOnBan, LoadBalance, NanoSwitch, RotatingNanoSwitch |
RotateOnBan |
| lavaplayer.youtube.rotation.search-triggers-fail | boolean | whether a search 429 should trigger marking the IP as failing | true |
| lavaplayer.youtube.rotation.retry-limit | int | -1 = use default lavaplayer value, 0 = infinity, >0 = retry will happen this numbers times | -1 |
| source.bandcamp | boolean | whether or not to enable playing and resolving tracks from bandcamp | true |
| source.beam | boolean | whether or not to enable playing and resolving tracks from beam | true |
| source.http | boolean | whether or not to enable playing and resolving tracks from http urls | false |
| source.local | boolean | whether or not to enable playing and resolving tracks from local files | false |
| source.soundcloud | boolean | whether or not to enable playing and resolving tracks from soundcloud | true |
| source.twitch | boolean | whether or not to enable playing and resolving tracks from twitch | true |
| source.vimeo | boolean | whether or not to enable playing and resolving tracks from vimeo | true |
| source.youtube | boolean | whether or not to enable playing and resolving tracks from youtube | true |
| lavalink.ws-path | string | route to run the lavalink websocket on. | / |
| magma.send-system.type* | string | type of send system to use. Valid options are nio, jda and nas |
nas on supported environments, nio otherwise |
| magma.send-system.nas-buffer | integer | buffer duration, in milliseconds, to keep in native code. Ignored if type isn't nas |
400 |
| koe.gateway | string | version of the gateway to use. Valid options are v4 and v5 |
v4 |
| koe.transport | string | transport to use. Valid options are epoll, kqueue, nio and default |
first one available of epoll, kqueue, nio (always available) |
| koe.byte-buf-allocator | string | ByteBufAllocator to use. Valid options are default (aka pooled), netty-default, unpooled |
netty-default |
| koe.high-packet-priority | boolean | whether or not sent packets should be marked as high priority | true |
| koe.udp-queue.enabled* | boolean | whether or not the native UDP queue should be enabled | true if udp queue is available, false otherwise |
| koe.udp-queue.buffer | integer | buffer duration, in milliseconds, to keep in native code | 400 |
| koe.udp-queue.threads | integer | number of threads for the native sending pool. If negative, the value is set to the number of CPU cores available | -1 |
* When running on architectures not supported by jda-nas, such as
ARM or Darwin devices, you must use either jda or nio for the send system. For production, nio is preferred
as it doesn't spawn a thread per voice connection. The default is changed to nio when running on unsupported
architectures. Note that lavaplayer has no arm natives, so you may encounter errors on some tracks. Most
youtube tracks won't have issues, but YMMV.