OpenSimulator · EN

Browse INI sections

Dedicated section search, alphabetical index and detailed settings from the catalog.

This index only includes entries with an explicit INI-file reference in the catalog. Optional modules and example templates may still appear: always verify the source file before adding settings.

← Back to all sections

[AssetCache] (16 settings)

The settings below are listed in the catalog. Availability depends on OpenSimulator version and installed modules.

16 settings

CacheDirectory string

Catalog value : code: assetcache / ini: ./assetcache, /directory/writable/by/OpenSim/instance

Technical description (original English : cache directory can be shared by multiple instances

Source code : OpenSim/Region/CoreModules/Asset/FlotsamAssetCache.cs:161

Template / example / testIncluded configuration

Referenced files:

  • bin/config-include/FlotsamCache.ini.example — Template / example / test
  • bin/config-include/FlotsamCache.ini — Included configuration

This is provenance, not active configuration. Edit only files loaded by your architecture. On a simulator check effective values with config show. .example files must be copied and customized before use.

CacheDirectoryTierLength int

Catalog value : 3

Technical description (original English : Number of letters per path tier, 1 will create 16 directories per tier, 2 - 256, 3 - 4096 and 4 - 65K

Source code : OpenSim/Region/CoreModules/Asset/FlotsamAssetCache.cs:182

Template / example / testIncluded configuration

Referenced files:

  • bin/config-include/FlotsamCache.ini.example — Template / example / test
  • bin/config-include/FlotsamCache.ini — Included configuration

This is provenance, not active configuration. Edit only files loaded by your architecture. On a simulator check effective values with config show. .example files must be copied and customized before use.

CacheDirectoryTiers int

Catalog value : 1

Technical description (original English : Number of tiers to use for cache directories (current valid range 1 to 3)

Source code : OpenSim/Region/CoreModules/Asset/FlotsamAssetCache.cs:181

Template / example / testIncluded configuration

Referenced files:

  • bin/config-include/FlotsamCache.ini.example — Template / example / test
  • bin/config-include/FlotsamCache.ini — Included configuration

This is provenance, not active configuration. Edit only files loaded by your architecture. On a simulator check effective values with config show. .example files must be copied and customized before use.

CacheWarnAt int

Catalog value : 30000

Technical description (original English : Warning level for cache directory size

Source code : OpenSim/Region/CoreModules/Asset/FlotsamAssetCache.cs:184

Template / example / testIncluded configuration

Referenced files:

  • bin/config-include/FlotsamCache.ini.example — Template / example / test
  • bin/config-include/FlotsamCache.ini — Included configuration

This is provenance, not active configuration. Edit only files loaded by your architecture. On a simulator check effective values with config show. .example files must be copied and customized before use.

FileCacheEnabled bool

Catalog value : true

Technical description (original English : Set to false for no file cache

Source code : OpenSim/Region/CoreModules/Asset/FlotsamAssetCache.cs:160

Template / example / testIncluded configuration

Referenced files:

  • bin/config-include/FlotsamCache.ini.example — Template / example / test
  • bin/config-include/FlotsamCache.ini — Included configuration

This is provenance, not active configuration. Edit only files loaded by your architecture. On a simulator check effective values with config show. .example files must be copied and customized before use.

FileCacheTimeout double

Catalog value : 48

Technical description (original English : How long {in hours} to keep assets cached on disk, .5 == 30 minutes Specify 0 if you do not want your disk cache to expire

Source code : OpenSim/Region/CoreModules/Asset/FlotsamAssetCache.cs:177

Template / example / testIncluded configuration

Referenced files:

  • bin/config-include/FlotsamCache.ini.example — Template / example / test
  • bin/config-include/FlotsamCache.ini — Included configuration

This is provenance, not active configuration. Edit only files loaded by your architecture. On a simulator check effective values with config show. .example files must be copied and customized before use.

FileCleanupTimer double

Catalog value : ini: 0.0 (code: m_FileExpirationCleanupTimer.TotalHours)

Technical description (original English : How often {in hours} should the disk be checked for expired files Specify 0 to disable expiration checking

Source code : OpenSim/Region/CoreModules/Asset/FlotsamAssetCache.cs:179

Template / example / testIncluded configuration

Referenced files:

  • bin/config-include/FlotsamCache.ini.example — Template / example / test
  • bin/config-include/FlotsamCache.ini — Included configuration

This is provenance, not active configuration. Edit only files loaded by your architecture. On a simulator check effective values with config show. .example files must be copied and customized before use.

HitRateDisplay long

Catalog value : ini: 100 (code: (long)m_HitRateDisplay)

Technical description (original English : How often should hit rates be displayed (given in AssetRequests) 0 to disable

Source code : OpenSim/Region/CoreModules/Asset/FlotsamAssetCache.cs:175

Template / example / testIncluded configuration

Referenced files:

  • bin/config-include/FlotsamCache.ini.example — Template / example / test
  • bin/config-include/FlotsamCache.ini — Included configuration

This is provenance, not active configuration. Edit only files loaded by your architecture. On a simulator check effective values with config show. .example files must be copied and customized before use.

LogLevel int

Catalog value : 0

Technical description (original English : Log level 0 - (Error) Errors only 1 - (Info) Hit Rate Stats + Level 0 2 - (Debug) Cache Activity (Reads/Writes) + Level 1

Source code : OpenSim/Region/CoreModules/Asset/FlotsamAssetCache.cs:174

Template / example / testIncluded configuration

Referenced files:

  • bin/config-include/FlotsamCache.ini.example — Template / example / test
  • bin/config-include/FlotsamCache.ini — Included configuration

This is provenance, not active configuration. Edit only files loaded by your architecture. On a simulator check effective values with config show. .example files must be copied and customized before use.

MemoryCacheEnabled bool

Catalog value : false

Technical description (original English : Set to false for no memory cache assets can be requested several times in short periods so even a small memory cache is useful

Source code : OpenSim/Region/CoreModules/Asset/FlotsamAssetCache.cs:164

Template / example / testIncluded configuration

Referenced files:

  • bin/config-include/FlotsamCache.ini.example — Template / example / test
  • bin/config-include/FlotsamCache.ini — Included configuration

This is provenance, not active configuration. Edit only files loaded by your architecture. On a simulator check effective values with config show. .example files must be copied and customized before use.

MemoryCacheTimeout double

Catalog value : code: 0.016 / ini: .016

Technical description (original English : How long {in hours} to keep assets cached in memory, .5 == 30 minutes even a few minutes may mean many assets loaded to memory, if not all. this is good if memory is not a problem. if memory is a problem then a few seconds may actually save same. see hit rates with console comand: fcache status

Source code : OpenSim/Region/CoreModules/Asset/FlotsamAssetCache.cs:165

Template / example / testIncluded configuration

Referenced files:

  • bin/config-include/FlotsamCache.ini.example — Template / example / test
  • bin/config-include/FlotsamCache.ini — Included configuration

This is provenance, not active configuration. Edit only files loaded by your architecture. On a simulator check effective values with config show. .example files must be copied and customized before use.

NegativeCacheEnabled bool

Catalog value : true

Technical description (original English : Enabling this will cache negative fetches. If an asset is negative-cached it will not be re-requested from the asset server again for a while. Generally, this is a good thing. Regular expiration settings (non-sliding) mean that the asset will be retried after the time has expired. Sliding expiration means that the time the negative cache will keep the asset is refreshed each time a fetch is attempted. Use sliding expiration if you have rogue scripts hammering the asset server with requests for nonexistent assets. There are two cases where negative caching may cause issues: 1 - If an invalid asset is repeatedly requested by a script and that asset is subsequently created, it will not be seen until fcache clear is used. This is a very theoretical scenario since UUID collisions are deemed to be not occuring in practice. This can only become an issue with sliding expiration time. 2 - If the asset service is clustered, an asset may not have propagated to all cluster members when it is first attempted to fetch it. This may theoretically occur with networked vendor systems and would lead to an asset not found message. However, after the expiration time has elapsed, the asset will then be fetchable. The defaults below are suitable for all small to medium installations including grids.

Source code : OpenSim/Region/CoreModules/Asset/FlotsamAssetCache.cs:168

Template / example / testIncluded configuration

Referenced files:

  • bin/config-include/FlotsamCache.ini.example — Template / example / test
  • bin/config-include/FlotsamCache.ini — Included configuration

This is provenance, not active configuration. Edit only files loaded by your architecture. On a simulator check effective values with config show. .example files must be copied and customized before use.

NegativeCacheSliding

Catalog value : false

Technical description (original English : Enabling this will cache negative fetches. If an asset is negative-cached it will not be re-requested from the asset server again for a while. Generally, this is a good thing. Regular expiration settings (non-sliding) mean that the asset will be retried after the time has expired. Sliding expiration means that the time the negative cache will keep the asset is refreshed each time a fetch is attempted. Use sliding expiration if you have rogue scripts hammering the asset server with requests for nonexistent assets. There are two cases where negative caching may cause issues: 1 - If an invalid asset is repeatedly requested by a script and that asset is subsequently created, it will not be seen until fcache clear is used. This is a very theoretical scenario since UUID collisions are deemed to be not occuring in practice. This can only become an issue with sliding expiration time. 2 - If the asset service is clustered, an asset may not have propagated to all cluster members when it is first attempted to fetch it. This may theoretically occur with networked vendor systems and would lead to an asset not found message. However, after the expiration time has elapsed, the asset will then be fetchable. The defaults below are suitable for all small to medium installations including grids. [Appears only in INI files; no literal read found in C# (may be read via a dynamic key, by another program, or obsolete).]

Source code :

Template / example / testIncluded configuration

Referenced files:

  • bin/config-include/FlotsamCache.ini.example — Template / example / test
  • bin/config-include/FlotsamCache.ini — Included configuration

This is provenance, not active configuration. Edit only files loaded by your architecture. On a simulator check effective values with config show. .example files must be copied and customized before use.

NegativeCacheTimeout int

Catalog value : 120

Technical description (original English : Enabling this will cache negative fetches. If an asset is negative-cached it will not be re-requested from the asset server again for a while. Generally, this is a good thing. Regular expiration settings (non-sliding) mean that the asset will be retried after the time has expired. Sliding expiration means that the time the negative cache will keep the asset is refreshed each time a fetch is attempted. Use sliding expiration if you have rogue scripts hammering the asset server with requests for nonexistent assets. There are two cases where negative caching may cause issues: 1 - If an invalid asset is repeatedly requested by a script and that asset is subsequently created, it will not be seen until fcache clear is used. This is a very theoretical scenario since UUID collisions are deemed to be not occuring in practice. This can only become an issue with sliding expiration time. 2 - If the asset service is clustered, an asset may not have propagated to all cluster members when it is first attempted to fetch it. This may theoretically occur with networked vendor systems and would lead to an asset not found message. However, after the expiration time has elapsed, the asset will then be fetchable. The defaults below are suitable for all small to medium installations including grids.

Source code : OpenSim/Region/CoreModules/Asset/FlotsamAssetCache.cs:169

Template / example / testIncluded configuration

Referenced files:

  • bin/config-include/FlotsamCache.ini.example — Template / example / test
  • bin/config-include/FlotsamCache.ini — Included configuration

This is provenance, not active configuration. Edit only files loaded by your architecture. On a simulator check effective values with config show. .example files must be copied and customized before use.

UpdateFileTimeOnCacheHit bool

Catalog value : false

Technical description (original English : If a memory cache hit happens, or the asset is still in memory due to other causes, update the timestamp on the disk file anyway. Don't turn this on unless you share your asset cache between simulators AND use an external process, e.g. cron job, to clean it up.

Source code : OpenSim/Region/CoreModules/Asset/FlotsamAssetCache.cs:171

Template / example / testIncluded configuration

Referenced files:

  • bin/config-include/FlotsamCache.ini.example — Template / example / test
  • bin/config-include/FlotsamCache.ini — Included configuration

This is provenance, not active configuration. Edit only files loaded by your architecture. On a simulator check effective values with config show. .example files must be copied and customized before use.

WaitOnInprogressTimeout

Catalog value : 3000

Technical description (original English : If WAIT_ON_INPROGRESS_REQUESTS has been defined then this specifies how long (in miliseconds) to block a request thread while trying to complete an existing write to disk. NOTE: THIS PARAMETER IS NOT CURRENTLY USED BY THE CACHE [Appears only in INI files; no literal read found in C# (may be read via a dynamic key, by another program, or obsolete).]

Source code :

Template / example / testIncluded configuration

Referenced files:

  • bin/config-include/FlotsamCache.ini.example — Template / example / test
  • bin/config-include/FlotsamCache.ini — Included configuration

This is provenance, not active configuration. Edit only files loaded by your architecture. On a simulator check effective values with config show. .example files must be copied and customized before use.