View source for Manual:$wgLocalFileRepo

<languages />
{{SettingSummary
|name=LocalFileRepo
|version_min=1.11.0
|rev_introduced=22580
|section=Uploads
|range=(<translate><!--T:1--> array</translate>)
|default=''<translate><!--T:2--> see below</translate>''
|summary=<translate><!--T:3--> A single repository structure for the local repository.</translate>
}}
<translate>
==Details== <!--T:4-->
</translate>
<translate><!--T:27--> This config is for customising the local (primary) file repo that MediaWiki uses.</translate>
<translate><!--T:28--> Most users will not want to customise this or will customise this indirectly via other variables such as <tvar name="1">{{ll|manual:$wgUploadDirectory|$wgUploadDirectory}}</tvar>.</translate>

<translate><!--T:29--> More complex setups may requiring customising this variable.</translate>
<translate><!--T:30--> For example, if you want to use a custom file backend, in order to replicate file storage amongst multiple data centers.</translate>

<translate>
===Properties required for all repos=== <!--T:5-->
</translate>
; class
: <translate><!--T:6--> The class name for the repository.</translate> <translate><!--T:7--> May come from the core or an extension.</translate> <translate><!--T:8--> The core repository classes are FileRepo, LocalRepo, ForeignDBRepo.</translate> <translate><!--T:9--> (FSRepo is also supported for backwards compatibility.)</translate>
; name
: <translate><!--T:11--> Should be set to <tvar name=local><code>'local'</code></tvar>.</translate>
; backend
: <translate><!--T:24--> A file backend name (see <tvar name=FileBackends>{{ll|Manual:$wgFileBackends|$wgFileBackends}}</tvar>).</translate> <translate><!--T:25--> For <tvar name=LocalFileRepo>$wgLocalFileRepo</tvar> and <tvar name=ForeignFileRepos>{{ll|Manual:$wgForeignFileRepos|$wgForeignFileRepos}}</tvar>, a name is automatically generated in <tvar name=Setup>{{ll|Manual:Setup.php|Setup.php}}</tvar> if not defined.</translate>

<translate>
===General parameters for LocalRepo class=== <!--T:26-->
</translate>
{| class="wikitable"
! <translate><!--T:51--> Name</translate>
! <translate><!--T:52--> Description</translate>
! <translate><!--T:53--> Default</translate>
|-
| zones
| <translate><!--T:31--> Config of where to store files (different zones like public vs deleted).</translate> <translate><!--T:32--> An array of zone descriptions containing: <tvar name=1>container, url, directory, urlsByExt</tvar>.</translate> <translate><!--T:33--> Some other config options may override this one in specific cases</translate>
|-
| url
| <translate><!--T:13--> Base public URL</translate>
|-
| hashLevels
| <translate><!--T:14--> The number of directory levels for hash-based division of files (see <tvar name=1>{{wg|HashedUploadDirectory}}</tvar> for info)</translate>
|-
| deletedHashLevels
| <translate><!--T:50--> <tvar name=1>{{phpi|'hashLevels'}}</tvar> override for the "deleted" zone.</translate>
|-
| thumbScriptUrl
| <translate><!--T:15--> The URL for <tvar name=1>thumb.php</tvar> (optional, not recommended)</translate>
|-
| transformVia404
| <translate><!--T:16--> Whether to skip media file transformation on parse and rely on a 404 handler instead.</translate>
|-
| thumbProxyUrl
| <translate><!--T:34--> URL of where to proxy <tvar name="1">thumb.php</tvar> requests to.</translate> <translate><!--T:35--> This is also used internally for remote thumbnailing of upload stash files.</translate> <translate><!--T:36--> Example:</translate> <nowiki>http://127.0.0.1:8888/wiki/dev/thumb/</nowiki>
|-
| thumbProxySecret
| <translate><!--T:37--> Optional value of the <tvar name="1"><code>X-Swift-Secret</code></tvar> header to use in requests to <tvar name="2">thumbProxyUrl</tvar></translate>
|-
| disableLocalTransform
| <translate><!--T:54--> Do not resize images on local machine, but instead use some other system to do so</translate>
|-
| initialCapital
| <translate><!--T:17--> Equivalent to <tvar name=CapitalLinks>{{ll|Manual:$wgCapitalLinks|$wgCapitalLinks}}</tvar>, determines whether filenames implicitly start with a capital letter.</translate> <translate><!--T:18--> The current implementation may give incorrect description page links when the local <tvar name=CapitalLinks>{{ll|Manual:$wgCapitalLinks|$wgCapitalLinks}}</tvar> and initialCapital are mismatched.</translate>
|-
| pathDisclosureProtection
| <translate><!--T:19--> May be 'paranoid' to remove all parameters from error messages, 'none' to leave the paths in unchanged, or 'simple' to replace paths with placeholders.</translate> <translate><!--T:20--> Default for LocalRepo is 'simple'.</translate>
|-
| fileMode
| <translate><!--T:38--> Used by <tvar name="1">FileBackend</tvar> to set the unix permissions on created files.</translate>
| 0644
|-
| directory
| <translate><!--T:39--> Used by <tvar name="1">FileBackend</tvar> to determine upload directory</translate>
|-
| thumbDir
| <translate><!--T:40--> The base thumbnail directory (if not overridden by zone directive)</translate>
|-
| thumbUrl
| <translate><!--T:41--> The base thumbnail URL (if not overridden by zone directive)</translate>
|-
| isPrivate
| <translate><!--T:42--> Is this repo private (E.g. its a private repo).</translate> <translate><!--T:43--> Steps are taken to prevent direct access, but may not be sufficient and you should still make sure the files aren't somewhere served by webserver.</translate>
|-
| useJsonMetadata
| <translate><!--T:44--> Store serialised metadata as JSON instead of php-serialised format.</translate>
| {{phpi|false}} ({{MW version-inline|1.38}})/<br/>{{phpi|true}} ({{MW version-inline|1.39+}})
|-
| useSplitMetadata
| <translate><!--T:45--> Store large chunks of FileMetadata in [[<tvar name="1">Special:MyLanguage/Manual:External storage</tvar>|external storage]].</translate> <translate><!--T:46--> Some files have their entire text layer as metadata, which can cause memory issues if stored directly on the file.</translate>
| {{phpi|false}}
|-
| splitMetadataThreshold
| <translate><!--T:47--> Threshold above which metadata items should be split into external storage.</translate>
| 1000
|-
| updateCompatibleMetadata
| <translate><!--T:48--> Automatically regenerate file metadata if it is detected metadata is out of date.</translate>
| {{phpi|false}}
|-
| reserializeMetadata
| <translate><!--T:49--> Automatically change metadata format (E.g. to <tvar name="1">JSON</tvar>) or split it to separate storage, if it is detected as needed.</translate>
| {{phpi|false}}
|}

<translate>

==Default value== <!--T:21-->

<!--T:22-->
This code, in Setup.php, generates a default value for <tvar name=LocalFileRepo>$wgLocalFileRepo</tvar> based on the values of other configuration settings:
</translate>

<code class="mw-code mw-highlight" style="display:block"><!--
-->if ( !{{#tag:span|$wgLocalFileRepo|class=nv}} ) {
	{{#tag:span|$wgLocalFileRepo|class=nv}} = [
		{{#tag:span|'class'|class=s1}} => LocalRepo::{{#tag:span|class|class=k}},
		{{#tag:span|'name'|class=s1}} => {{#tag:span|'local'|class=s1}},
		{{#tag:span|'directory'|class=s1}} => {{ll|Manual:$wgUploadDirectory|$wgUploadDirectory}},
		{{#tag:span|'scriptDirUrl'|class=s1}} => {{ll|Manual:$wgScriptPath|$wgScriptPath}},
		{{#tag:span|'url'|class=s1}} => {{ll|Manual:$wgUploadBaseUrl|$wgUploadBaseUrl}} ? {{#tag:span|$wgUploadBaseUrl|class=nv}} . {{ll|Manual:$wgUploadPath|$wgUploadPath}} : {{#tag:span|$wgUploadPath|class=nv}},
		{{#tag:span|'hashLevels'|class=s1}} => {{ll|Manual:$wgHashedUploadDirectory|$wgHashedUploadDirectory}} ? 2 : 0,
		{{#tag:span|'thumbScriptUrl'|class=s1}} => {{ll|Manual:$wgThumbnailScriptPath|$wgThumbnailScriptPath}},
		{{#tag:span|'transformVia404'|class=s1}} => !{{ll|Manual:$wgGenerateThumbnailOnParse|$wgGenerateThumbnailOnParse}},
		{{#tag:span|'deletedDir'|class=s1}} => {{ll|Manual:$wgDeletedDirectory|$wgDeletedDirectory}},
		{{#tag:span|'deletedHashLevels'|class=s1}} => {{#tag:span|$wgHashedUploadDirectory|class=nv}} ? 3 : 0
	];
}
</code>
<!-- to load syntaxhighlight css -->
<syntaxhighlight lang="php" style="display:none"></syntaxhighlight>

<translate>
== See also == <!--T:23-->
</translate>
* {{ll|Manual:$wgForeignFileRepos}}
* [[:Category:File repository extensions]]
* <span class="plainlinks">[https://noc.wikimedia.org/conf/filebackend.php.txt Wikimedia's file repo config]</span>