Kodi data folder

2024-04-10T22:54:35Z

Bramp: /* Location */ Added data location when using flatpak

{{mininav||[[Settings]]}}

= Introduction =
<section begin="KodiDataFolder" />Once {{Kodi}} is installed, all subsequent changes and usage data are saved in the [[Kodi data folder]] which is the parent folder of the '''[[Userdata]]''' folder. When you install a new skin or an add-on it is installed in this folder. Playlists and edits to Nodes are stored here, and the library databases are created here along with the artwork cache and any other changes you make during your travels with {{kodi}}.

Basically anything you add or modify, after installation, occurs in this folder and sub-folders.<section end="KodiDataFolder" />

:{{see also|Backup}}

= Location =
The location of this folder varies between operating systems and the table below lists their locations.
<section begin="KodiDataFolderLocation" />
{| class="prettytable"
! scope="row" ! style="width:150px; background-color:#a1f5e4; | Operating system
! scope="row" ! style="width:700px; background-color:#a1f5e4; | Kodi Data folder path
|-
| '''Android''' || Android/data/org.xbmc.kodi/files/.kodi
|-
| '''iOS''' || /private/var/mobile/Library/Preferences/Kodi
|-
| '''LibreELEC''' || /storage/.kodi
|-
| '''Linux''' || ~/.kodi
|-
| '''Linux (Flatpak)''' || ~/.var/app/tv.kodi.Kodi
|-
| '''macOS''' || /Users/<your_user_name>/Library/Application Support/Kodi
|-
| '''Nvidia Shield (SMB)''' || smb://<nvidiashieldurl>/internal/Android/data/org.xbmc.kodi/files/.kodi
|-
| '''OSMC''' || /home/osmc/.kodi
|-
| '''tvOS''' || /private/var/mobile/Library/Preferences/Kodi
|-
| '''WebOS''' || /media/developer/apps/usr/palm/applications/org.xbmc.kodi/.kodi
|-
| '''Windows''' || C:\Users\<''YourUsername''>\AppData\Roaming\Kodi
|-
| '''Windows Portable''' || <''Install location chosen by you''>\portable_data
|-
| '''Windows Xbox''' || %LOCALAPPDATA%\Packages\XBMCFoundation.Kodi_4n2hpmxwrvr6p\LocalCache\Roaming\Kodi\
|}

:'''Note:''' In some Android setups the path may be slightly different to the one stated above.
<section end="KodiDataFolderLocation" />

= Folders =
The following are the sub-folders in the Kodi Data folder. Forks of {{kodi}} may have additional folders not covered here.

== addons ==
Any add-on installed in {{kodi}} is installed in this folder along with any subsequent updates.

Many add-ons have an additional folder located in '''\userdata\addon_data'''. This folder contains data created due to user preference or usage. eg, changed settings, channel line-up, etc

{{kodi}} comes pre-installed with a series of default add-ons that are required for basic functioning, such as language add-ons, scrapers, default skins etc. These pre-installed add-ons are located in the Programs folder along with the remainder of the Kodi program files. When these pre-installed add-ons receive a subsequent update, the update is saved in this folder and the original add-on remains but is ignored.

{{see|Add-ons}}

== cache ==
The cache folder and its subfolders are used as temporary storage for some {{kodi}} functions. They can be used by:
* Scrapers to cache results and reduce API calls to remote sites.
* Caching navigation nodes that are slow to load in larger libraries
* File view of non-library items that entails tag reading which can be slow

This folder is self-cleaning with items generally kept for 3 hours for the python Pickle cache, and 24 hours or more for scraper caches.

== media ==
The media folder may contain other sub-folders that may need to be created manually.

=== Fonts ===
The ''Fonts'' sub-folder, can be used to add additionals subtitle fonts, which can be used as alternative to the default Kodi font.
We strongly suggest to avoid adding more than 100 fonts in this folder, otherwise you may experience of playback slowdowns and system instability.

If your intent is to provide a big library of fonts as support to subtitles format type like ASS/SSA,
we suggest you to install these fonts in your operative system and avoid to use this folder to store them,
some Kodi distributions could provide a special folder, where you can place your own font library.

{{note|On Kodi 20 - At each startup Kodi will check if files have been added and/or removed in this folder, and then rebuilds the font cache if necessary.
When the font cache has been builded will be saved a <code>fontcache.xml</code> file in this folder. To optimise Kodi startup, please do not delete this file.}}

== system ==
Not used.

== userdata ==
{{see|Userdata}}

= Files =
For {{kodi}} installations on Windows, the log files are saved in this folder. (For location of log files in other platforms, see: ''[[Template:LogfilePath|Log file Paths]]'')

; \kodi.log
; \kodi.old.log

{{#lst:Log_file|WhichLog}}

:See '''[[Log_file|Debug Log]]'''

{{top}}
{{updated|20}}

[[Category:Karellen]]
[[Category:Settings]]

Webserver

2022-01-27T22:29:13Z

Bramp: /* Hints */ Fix up the formatting of the example Apache config.

<section begin="intro" />{{kodi}} comes with a builtin webserver based on [http://www.gnu.org/software/libmicrohttpd/ libmicrohttpd] which provides several services accessible through [http://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol HTTP].<section end="intro" />

== Enabling the webserver ==
The webserver is disabled by default and has to be manually enabled by the user. This can be done in {{highlight|bordered=yes|[[Settings/Services#Webserver|Settings → Services → Webserver → Allow control of {{Kodi}} via HTTP]]}}. The settings allow to specify a custom port number and an optional username and password for HTTP's [http://en.wikipedia.org/wiki/Basic_access_authentication Basic Access Authentication]. Furthermore a [[Web interface]] can be chosen which will be used when accessing the webserver without any specific path.

=== Hints ===
* If the webserver fails to start make sure you use a port that is not blocked by your firewall and is not used by any other process running on the same machine. If there is another webserver like Apache running on the same machine it is very likely that port 80 (HTTP default port) is already used.
* On Linux, ports below 1024 require super-user privileges and are therefore not available to {{kodi}}. For Linux, you must change the port number to a port number above 1024 that's not in use on your computer, like 1485, 1588 or 1066 for example. Those 3 port numbers have no popular uses registered with IANA, the Internet Assigned Numbers Authority. Remote control via HTTP will see the web server with whatever port you choose.
* For use in a virtual hosts environment in Apache, the following directives can be used:

<syntaxhighlight lang="apache">
# Kodi configuration
# Replace kodiserver with actual names.

ServerName kodiserver
DocumentRoot /
LogLevel emerg
ErrorLog /var/log/apache2/kodiserver_error.log
CustomLog /var/log/apache2/kodiserver_access.log "vhost_combined"
ProxyPass / http://kodiserver:8080/ nocanon
ProxyPassReverse / http://kodiserver:8080/
<Directory "/">
allow from all
Options +Indexes
</Directory>
AllowEncodedSlashes On
</syntaxhighlight>

AllowEncodedSlashes is necessary to have webpages work properly.

nocanon is used to disable url encoding use this if images are not showing in the webbrowser.

== Services ==
The webserver offers several services which can be accessed based on the path specified in the HTTP request. The webserver is accessible through HTTP using the following URL
<pre>http://<your ip>:<configured port>/</pre>

=== Webinterface ===
When no path is specified or the specified path does not correspond to any of the available services the webserver will try to locate the requested path/file in the configured [[Web interface]].

=== Webinterface addons /addons ===
Requesting the /addons path will show a HTML page with a list of all installed and available webinterface addons. By appending the identifier of one of the webinterface addons to the /addons path it is possible to access all the available webinterfaces without configuring them in the settings.

=== Image cache /image ===
The image cache service provides access to cached images (thumbnails, fanart, ...) of media items. The image URL (image://) returned by JSON-RPC has to be URL encoded before appending it:
<pre>http://<your ip>:<configured port>/image/<url encoded image:// path></pre>

=== JSON-RPC API /jsonrpc ===
The JSON-RPC API service provides access to the [[JSON-RPC API]] using [http://en.wikipedia.org/wiki/POST_(HTTP) HTTP POST] or GET. Requesting the /jsonrpc path without any additional POST or GET data will return the full [[JSON-RPC API#Documentation|documentation]] of the JSON-RPC API in JSON schema format.

=== Virtual File System /vfs ===
The Virtual File System (VFS) service provides access to files accessible to {{kodi}} through its VFS. The VFS path has to be URL encoded before appending it:
<pre>http://<your ip>:<configured port>/vfs/<url encoded vfs path></pre>

As of XBMC v12 Frodo, in an effort to make the Virtual File System service more secure (in Eden and before it allowed access to literally any file on the local hard disc and on network shares accessible to {{kodi}}) the access has been limited to files within directories that have been specified by the user as sources (video, music, files, programs) in {{kodi}}.

{{Updated|16}}

Official Kodi Wiki - User contributions [en]

Kodi data folder

Webserver