Difference between revisions of "Template:Appdata Directory"

From Servarr
 
(11 intermediate revisions by 4 users not shown)
Line 1: Line 1:
 +
<noinclude>
 +
<templatedata>
 +
{
 +
"params": {
 +
"ARRNAME": {
 +
"description": "ARR Name",
 +
"example": "Sonarr, Radarr, Lidarr, Readarr",
 +
"type": "string",
 +
"default": "Radarr"
 +
},
 +
"ARRNAME2": {
 +
"description": "This variable is used to insert lowercase ARR names ",
 +
"example": "radarr, sonarr, lidarr, or readarr",
 +
"required": true
 +
}
 +
},
 +
"description": "This template is designed to house all the locations for the ARR's application data directory"
 +
}
 +
</templatedata>
 +
</noinclude>
 +
 
{{{ARRNAME}}}’s AppData folder contains the databases for logs and general app information, log files and the config file that contains settings required to start the web server. This path is listed on the System Status page in {{{ARRNAME}}}, but if you are unable to access it, here are some common locations for it:
 
{{{ARRNAME}}}’s AppData folder contains the databases for logs and general app information, log files and the config file that contains settings required to start the web server. This path is listed on the System Status page in {{{ARRNAME}}}, but if you are unable to access it, here are some common locations for it:
  
 
=== Windows ===
 
=== Windows ===
 
<code>C:\ProgramData\NzbDrone</code>
 
  
 
<code>C:\ProgramData\{{{ARRNAME}}}</code>
 
<code>C:\ProgramData\{{{ARRNAME}}}</code>
Line 9: Line 28:
 
=== Linux ===
 
=== Linux ===
  
<code>/home/$USER/.config/NzbDrone</code> (<code>~$USER/.config/NzbDrone</code>)
+
Unless otherwise specified {{{ARRNAME}}} will store it's application data in the home folder of the user {{{ARRNAME}}} is running under
 +
<code>/home/$USER/.config/{{{ARRNAME}}}</code> (<code>~/.config/{{{ARRNAME}}}</code>)
  
<code>/home/$USER/.config/{{{ARRNAME}}}</code> (<code>~$USER/.config/{{{ARRNAME}}}</code>)
+
<code>/var/lib/{{{ARRNAME}}}</code>
  
<code>/var/lib/{{{ARRNAME}}}</code>
 
  
 
=== OS X ===
 
=== OS X ===
  
<code>/Users/$USER/.config/NzbDrone</code> (<code>~/.config/NzbDrone</code>)
+
<code>/Users/$USER/.config/{{{ARRNAME}}}</code> (<code>~/.config/{{{ARRNAME}}}</code>)
  
 
=== Synology ===
 
=== Synology ===
  
<code>/usr/local/nzbdrone/var/.config/NzbDrone</code>
+
<code>/usr/local/{{{ARRNAME}}}/var/.config/{{{ARRNAME}}}</code>
  
<code>/volume1/@appstore/nzbdrone/var/.config/NzbDrone</code>
+
<code>/volume1/@appstore/{{{ARRNAME}}}/var/.config/{{{ARRNAME}}}</code>
  
 
=== QNAP ===
 
=== QNAP ===
  
<code>/share/MD0_DATA/homes/admin/.config/NzbDrone</code>
+
<code>/share/MD0_DATA/homes/admin/.config/{{{ARRNAME}}}</code>
  
 
<code>/share/CACHEDEV1_DATA/{{{ARRNAME}}}_CONFIG</code>
 
<code>/share/CACHEDEV1_DATA/{{{ARRNAME}}}_CONFIG</code>
Line 33: Line 52:
 
=== Argument ===
 
=== Argument ===
  
The <code>-data</code> argument forces the location of the AppData folder, so your startup command may be forcing a specific location. This is especially useful when trying to run multiple instances.
+
{{#lst::Appdata Directory Misc|{{{ARRNAME2}}}_appdata_directory_arguments}}
 
 
<pre>user@host ~ $ ps aux | grep -i {{{ARRNAME}}}
 
{{{ARRNAME}}}    15522 28.3  1.5 3596376 1037600 ?    Ssl  Nov11 291:03 /usr/bin/mono --debug /usr/lib/{{{ARRNAME}}}/{{{ARRNAME}}}.exe -nobrowser -data=/var/lib/{{{ARRNAME}}}</pre>
 
<pre>user@host ~ $ sudo systemctl cat {{{ARRNAME}}}
 
...
 
ExecStart=/usr/bin/mono --debug /usr/lib/{{{ARRNAME}}}/{{{ARRNAME}}}.exe -nobrowser -data=/var/lib/{{{ARRNAME}}}
 
...</pre>
 

Latest revision as of 22:22, 26 April 2021

This template is designed to house all the locations for the ARR's application data directory

Template parameters

ParameterDescriptionTypeStatus
ARRNAMEARRNAME

ARR Name

Default
Radarr
Example
Sonarr, Radarr, Lidarr, Readarr
Stringoptional
ARRNAME2ARRNAME2

This variable is used to insert lowercase ARR names

Example
radarr, sonarr, lidarr, or readarr
Unknownrequired


{{{ARRNAME}}}’s AppData folder contains the databases for logs and general app information, log files and the config file that contains settings required to start the web server. This path is listed on the System Status page in {{{ARRNAME}}}, but if you are unable to access it, here are some common locations for it:

Windows

C:\ProgramData\{{{ARRNAME}}}

Linux

Unless otherwise specified {{{ARRNAME}}} will store it's application data in the home folder of the user {{{ARRNAME}}} is running under /home/$USER/.config/{{{ARRNAME}}} (~/.config/{{{ARRNAME}}})

/var/lib/{{{ARRNAME}}}


OS X

/Users/$USER/.config/{{{ARRNAME}}} (~/.config/{{{ARRNAME}}})

Synology

/usr/local/{{{ARRNAME}}}/var/.config/{{{ARRNAME}}}

/volume1/@appstore/{{{ARRNAME}}}/var/.config/{{{ARRNAME}}}

QNAP

/share/MD0_DATA/homes/admin/.config/{{{ARRNAME}}}

/share/CACHEDEV1_DATA/{{{ARRNAME}}}_CONFIG

Argument