0% found this document useful (0 votes)
2 views1 page

Troubleshooting - WorkAdventure Documentation

This document provides guidance on building and troubleshooting maps using WorkAdventure, including publishing options and common issues related to embedding websites. It addresses CORS settings, iFrame restrictions, and cookie handling for embedded websites. Additionally, it encourages users to seek help through Discord or GitHub if they encounter difficulties.

Uploaded by

raziq.brown
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
2 views1 page

Troubleshooting - WorkAdventure Documentation

This document provides guidance on building and troubleshooting maps using WorkAdventure, including publishing options and common issues related to embedding websites. It addresses CORS settings, iFrame restrictions, and cookie handling for embedded websites. Additionally, it encourages users to seek help through Discord or GitHub if they encounter difficulties.

Uploaded by

raziq.brown
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 1

Map Building Admin User Developer Tutorials Login Get Started Search ctrl K

Megaphone
Build your Map with Tiled Troubleshooting
Look at the browser console
Entity collections file format
Check web server CORS settings
Build your Map with Tiled
Troubleshooting Issues embedding a website

Publishing your map Embedding an iFrame is forbidden

Upload your Map to I cannot log into my embedded website


WorkAdventure Look at the browser console Need some help?

Host your Map with GitHub


Pages If your map is not displayed correctly (most notably if you are getting a black screen), open your browser console. This is usually done
by pressing the F12 key and selecting the "console" tab.
Self-Hosting your Map

About WorkAdventure maps Scan the output. Towards the end, you might see a message explaining why your map cannot be loaded.

Entries and exits

Opening a website when walking Check web server CORS settings


on the map

Meeting rooms If you are hosting the map you built on your own web server and if the map does not load, please check that your webserver CORS
settings are correctly configured.
Special zones

Animations

Integrated websites
Issues embedding a website
Camera When you are embedding a website in WorkAdventure (whether it is using the openWebsite property or the integrated website in a

Writing text on a map map feature or the Scripting API), WorkAdventure will open your website using an iFrame.

Chat zones Browsers have various security measures in place, and website owners can use those measures to prevent websites from being used
Extra Features inside iFrames (either partially or completely).

Adding doors In the chapters below, we will list what can possibly prevent you from embedding a website, and see what are your options.
Bells / Knocking on a door

Map configuration screen Embedding an iFrame is forbidden


Binding Variables to Properties The worst that can happen is that the website you are trying to embed completely denies you the authorization. A website owner can
Action Layers do that using the X-Frame-Options HTTP header, or the newer Content-Security-Policy HTTP header.

Properties Reference Take a look at the headers of the page you are trying to load.
Troubleshooting
INFO
Invite People to your Map
You can view the headers of the web page you try to load in the developer tools of your browser (usually accessible using the F12
key of your keyboard), in the network tab. Click on the top-most request and check the "Response Headers".

Below is what you can see when opening a Youtube video page:

X-Frame-Options: DENY or X-Frame-Options: SAMEORIGIN will prevent WorkAdventure from loading the page. Content-
Security-Policy header have also the potential to prevent WorkAdventure from loading the page.

If the website you are trying to embed has one of these headers set, here are your options:

if you have control over the website or know the owner, you can contact the owner/administrator of the website and ask for an
exception
otherwise, you can look for an "embed" option. Some websites have special pages that can be embedded. For instance, YouTube
has special "embed" links that can be used to embed a video in your website. A lot of websites have the same feature (you can
usually find those links in the "share" section)

If none of these options are available to you, as a last resort, you can use the openTab property instead of the openWebsite property.
It will open your webpage in another tab instead of opening it in an iFrame.

I cannot log into my embedded website


When you log into a website, the website is issuing a "cookie". The cookie is a unique identifier that allows the website to recognize you
and to identify you. To improve the privacy of their users, browsers can sometimes treat cookies inside iFrames as "third-party
cookies" and discard them.

Cookies can come with a SameSite attribute.

The SameSite attribute can take these values: "Lax", "Strict" or "None". The only value that allows using the cookie inside an iFrame is
"None".

INFO

The SameSite attribute of your cookie MUST be set to "None" if you want to be able to use this cookie from an iFrame inside
WorkAdventure.

Default values:

If the "SameSite" attribute is not explicitly set, the behavior depends on the browser. Chrome, Edge and Opera will default to "Lax".
Firefox and Safari will default to "None" (as of 2022/04/25).

As a result, a website that does not set the SameSite attribute on cookies will work correctly in Firefox and Safari but login will fail on
Chrome, Edge and Opera.

If the website you are trying to embed has the SameSite attribute set to a value other than "None", here are your options:

if you have control over the website or know the owner, you can contact the owner/administrator of the website and ask the
owner/administrator to change the SameSite settings.
otherwise, you will have to use the openTab property instead of the openWebsite property. It will open your webpage in another
tab instead of in an iFrame.

Need some help?


WorkAdventure is a constantly evolving project and there is plenty of room for improvement regarding map editing. If you are facing
any troubles, do not hesitate to seek help in our Discord server or open an "issue" in the GitHub WorkAdventure account.

Edit this page

Previous Next
« Properties Reference Invite People to your Map »

Docs Need help ? Follow us

Map Building Book a demo Linkedin


Admin Discord Twitter

Developer GitHub Facebook

Copyright © 2024 workadventu.re - All Rights Reserved

You might also like