Files
Paradise/datum/configuration_section/asset_cache_configuration.html

17 lines
5.0 KiB
HTML

<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><base href="../../"><link rel="stylesheet" href="dmdoc.css"><title>/datum/configuration_section/asset_cache_configuration - Space Station 13</title></head><body><header><a href="index.html">Space Station 13</a> - <a href="index.html#modules">Modules</a> - <a href="index.html#types">Types</a><a href="datum/configuration_section/asset_cache_configuration.html#var">Var Details</a></header><main><h1>asset_cache_configuration <aside>/<a href="datum.html">datum</a>/<a href="datum/configuration_section.html">configuration_section</a>/<a href="datum/configuration_section/asset_cache_configuration.html">asset_cache_configuration</a></aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/controllers/configuration/sections/asset_cache_configuration.dm#L1"><img src="git.png" width="16" height="16" title="code/controllers/configuration/sections/asset_cache_configuration.dm 1"></a></h1><table class="summary" cellspacing="0"><tr><td colspan="2"><h2>Vars</h2></td></tr><tr><th><a href="datum/configuration_section/asset_cache_configuration.html#var/asset_cdn_url">asset_cdn_url</a></th><td>URL the <code>asset_cdn_webroot</code> can be accessed from.
For best results the webserver powering this should return a long cache validity time,
as all assets sent via this transport use hash based urls
if you want to test this locally, you simpily run the <code>localhost-asset-webroot-server.py</code> python3 script
to host assets stored in <code>data/asset-store/</code> via http://localhost:58715/</td></tr><tr><th><a href="datum/configuration_section/asset_cache_configuration.html#var/asset_cdn_webroot">asset_cdn_webroot</a></th><td>Local folder to save assets to.
Assets will be saved in the format of asset.MD5HASH.EXT or in namespaces/hash/
as ASSET_FILE_NAME or asset.MD5HASH.EXT</td></tr><tr><th><a href="datum/configuration_section/asset_cache_configuration.html#var/asset_simple_preload">asset_simple_preload</a></th><td>Whether to make server passively send all browser assets to each client in the background
(instead of waiting for them to be needed)</td></tr><tr><th><a href="datum/configuration_section/asset_cache_configuration.html#var/asset_transport">asset_transport</a></th><td>Type of asset transport that will be used for asset delivery.
Available options are &quot;simple&quot; or &quot;webroot&quot;.</td></tr></table><h2 id="var">Var Details</h2><h3 id="var/asset_cdn_url"><aside class="declaration">var </aside>asset_cdn_url <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/controllers/configuration/sections/asset_cache_configuration.dm#L17"><img src="git.png" width="16" height="16" title="code/controllers/configuration/sections/asset_cache_configuration.dm 17"></a></h3><p>URL the <code>asset_cdn_webroot</code> can be accessed from.
For best results the webserver powering this should return a long cache validity time,
as all assets sent via this transport use hash based urls
if you want to test this locally, you simpily run the <code>localhost-asset-webroot-server.py</code> python3 script
to host assets stored in <code>data/asset-store/</code> via http://localhost:58715/</p><h3 id="var/asset_cdn_webroot"><aside class="declaration">var </aside>asset_cdn_webroot <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/controllers/configuration/sections/asset_cache_configuration.dm#L11"><img src="git.png" width="16" height="16" title="code/controllers/configuration/sections/asset_cache_configuration.dm 11"></a></h3><p>Local folder to save assets to.
Assets will be saved in the format of asset.MD5HASH.EXT or in namespaces/hash/
as ASSET_FILE_NAME or asset.MD5HASH.EXT</p><h3 id="var/asset_simple_preload"><aside class="declaration">var </aside>asset_simple_preload <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/controllers/configuration/sections/asset_cache_configuration.dm#L7"><img src="git.png" width="16" height="16" title="code/controllers/configuration/sections/asset_cache_configuration.dm 7"></a></h3><p>Whether to make server passively send all browser assets to each client in the background
(instead of waiting for them to be needed)</p><h3 id="var/asset_transport"><aside class="declaration">var </aside>asset_transport <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/controllers/configuration/sections/asset_cache_configuration.dm#L4"><img src="git.png" width="16" height="16" title="code/controllers/configuration/sections/asset_cache_configuration.dm 4"></a></h3><p>Type of asset transport that will be used for asset delivery.
Available options are &quot;simple&quot; or &quot;webroot&quot;.</p></main><footer>paradise.dme <a href="https://github.com/ParadiseSS13/Paradise/tree/8a8a00a2a9bec485351e5f219982b7315d3504fa">8a8a00a</a> (master) — <a href="https://github.com/SpaceManiac/SpacemanDMM/blob/master/crates/dmdoc/README.md">dmdoc 1.11.0</a></footer></body></html>