Accessing Assets
Find out how to use the asset_url filter to generate a path to your assets and understand the benefits of hosting assets on our CDN.
Introduction
Assets are stored directly on an Amazon Web Services (AWS) server, separate to the website you are building on. They can be accessed using a Content Delivery Network (CDN) from your website.
Benefits
The use of this method offers automatic Caching control, which decreases the likelihood that someone views your website with anything other than the most up-to-date versions of your files. The CDN also reduces page load times, as the assets are not stored on your site, but instead are distributed to over 100 edge locations around the world.
Linking to assets
If you have uploaded an image to the images folder using File Manager, it will have a file path like this in the database: images/SG-Logo-White.svg
You would add the following liquid to your page, so that the server automatically appends the CDN URL: {{ 'images/SG-Logo-White.svg' | asset_url }}
You will see that the asset will render on the page with a similar path to this: https://uploads.prod01.oregon.platform-os.com/instances/283/assets/images/SG-Logo-White.svg?updated=1549914206
Each site has a unique CDN path, you can find out what yours is by rendering an image on the page and inspecting on it. ?updated= is a parameter automatically included that time stamps your files, helping with cache control.
Correct Examples:
HTML - Stylesheets:
<link rel="stylesheet" type="text/css" href="{{ 'css/styles.css' | asset_url }}" />
HTML - JavaScript files:
<script src="{{ 'js/myfile.js' | asset_url }}"></script>
HTML - Images:
{{ 'images/SG-Logo-White.svg' | asset_url }}
WebApp Asset Field:
{{ this['my_field'] | asset_url }}
CSS - Images:
Using ../ automatically appends the URL to your asset within CSS files:
background-image: url('../images/SG-Logo-White.svg');
../ is relative to the location of your stylesheet. This is especially useful for background images. You can look up CSS relative paths online for more information.
Vanity URL
In some cases you may wish to hide the AWS CDN (https://uploads.prod01.oregon.platform-os.com) and only refer to the vanity domain of the site (https://www.mydomain.com). To dynamically achieve this, you can use the liquid parameter asset_path rather than asset_url when calling an asset to a page. Any of the above examples are also applicable with this method.
HTML - Image Example:
{{ 'images/SG-Logo-White.svg' | asset_path }}
You will see that the asset will render on the page with your vanity domain in it's path, similar to this: https://www.mydomain.com/assets/images/SG-Logo-White.svg?updated=1549914206
Diagnosing issues
If you cannot see the asset on your page then you can check the following common issues:
- Check the string you used for a path does not start with a forward slash or "assets".
e.g. these will fail because the "/" or "assets/" beginning of the path will end up being added twice.
- Check the file manager or code editor shows the correct path for your asset, including any folders.
- You should include the file extension for your asset in the path e.g. ".jpg"
e.g. this will fail because an asset's full name has not been included:
{{'images/SG-Logo-White' | asset_url }}
- Make sure you wrap your path in quotes as it is a string:
e.g. here a string was forgotten and validation on Admin or Siteglide CLI should not accept it:
{{images/SG-Logo-White | asset_url }}