summaryrefslogtreecommitdiff
path: root/files/cherrymusic.conf
blob: 524c2e207db41990c5c5279aa75847033dec3794 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
[media]

; BASEDIR specifies where the media that should be served is located. It must be
; an absolute path, e.g. BASEDIR=/absolute/path/to/media.
; 
; Links: If your operating system supports them, you can use symlinks directly in
; BASEDIR. Links to directories which contain BASEDIR will be ignored, just like
; all links not directly in, but in sublevels of BASEDIR. This is to guard against
; the adverse effects of link cycles.
; 
basedir = /var/cache/media/noise

; TRANSCODE (experimental!) enables automatic live transcoding of the media to be
; able to listen to every format on every device. This requires you to have the
; appropriate codecs installed. Please note that transcoding will significantly
; increase the stress on the CPU!
; 
transcode = True

; Tries to fetch the album cover from various locations in the web, if no image is
; found locally. By default it will be fetched from iTunes. They will be shown
; next to folders that qualify as a possible album.
; 
fetch_album_art = True

; Show the number of sub-folders and tracks contained in any folder. This will
; increase the stress for the server, so if you're running CherryMusic on a 386DX
; II or similar, it is recommended to deactivate this feature.
; 
show_subfolder_count = True

; Maximum size in bytes of all files to be downloaded in one zipfile. Defaults to
; 250 megabytes.
; 
maximum_download_size = 262144000

[search]

; MAXRESULTS sets the maximum amount of search results to be displayed. If
; MAXRESULTS is set to a higher value, the search will take longer, but will also
; be more accurate.
; 
maxresults = 20

; This will load parts of the database into memory for improved performance. This
; option should only be used on systems with sufficient memory, because it will
; hurt the performance otherwise.
; 
load_file_db_into_memory = False

[browser]

; MAXSHOWFILES specifies how many files and folders should be shown at the same
; time. E.g. if you open a folder with more than MAXSHOWFILES, the files will be
; grouped according to the first letter in their name. 100 is a good value, as a
; CD can have up to 99 tracks.
; 
maxshowfiles = 100

; Only use the media database, never the filesystem, for content lookups in
; browser and search. Useful if the media files reside on an external hard drive
; or behind a slow network connection.
; 
pure_database_lookup = False

[server]

; The port the server will listen to.
; 
port = 8100

; When set to true, the server will listen on a IPv6 socket instead of IPv4
; 
ipv6_enabled = False

; When localhost_only is set to true, the server will not be visible in the
; network and only play music on the same computer it is running on.
; 
; Activating this option binds the server to IP 127.0.0.1 or [::1], depending on
; whether server.ipv6_enabled is true. The server should also be reachable as
; "localhost" in any case.
; 
localhost_only = False

; The path cherrymusic will be available on. Normally you'll want to leave it as
; '/', so that CherryMusic is available under e.g. localhost:8080. You might want
; to change the path if CherryMusic runs behind a reverse proxy. Changing it to
; '/cherrymusic' will make it available under e.g. localhost:8080/cherrymusic
; 
rootpath = /

; When localhost_auto_login is set to "True", the server will not ask for
; credentials when using it locally. The user will be automatically logged in as
; admin.
; 
localhost_auto_login = False

; When permit_remote_admin_login is set to "False", admin users may only log in
; from the computer cherrymusic is currently running on. This can improve
; security.
; 
permit_remote_admin_login = True

; Will keep the user sessions in RAM instead of a file in the configuration
; directory. This means, that any unsaved playlists will be lost when the server
; is restarted.
; 
keep_session_in_ram = False

; Duration in minutes of the user sessions. Note that this will not affect auto
; logged-in users.
; 
session_duration = 1440

; The following options allow you to use cherrymusic with https encryption. If
; ssl_enabled is set to "False", all other ssl options will be ommited.
; 
ssl_enabled = False

; The port that will listen to SSL encrypted requests. If ssl_enabled is set to
; "True", all unencrypted HTTP requests will be redirected to this port.
; 
ssl_port = 8443

; The SSL certiticate sent to the client to verify the server's authenticity. A
; relative path is relative to the location of the CherryMusic configuration file.
; 
ssl_certificate = certs/server.crt

; SSL private key file used by the server to decrypt and sign secure
; communications. Keep this one secret! A relative path is relative to the
; location of the CherryMusic configuration file.
; 
ssl_private_key = certs/server.key

[general]

; Notify admins about available security and feature updates.
; 
update_notification = True