• Using a custom domain

  • DNS setup

  • Domain configuration

  • URL structure

  • Common questions

• Customize graphical assets

Rebranding / White labeling your world (beta)¶

This feature is currently in beta version. We are looking for your feedback.

You can customize WorkAdventure to put your own brand in value. Use the rebranding (or white label) features to:

• Replace WorkAdventure logos with your own logos
• Use your own domain name (instead of play.workadventu.re)

Rebranding settings are located in the World edition pop-up.

Using a custom domain¶

DNS setup¶

In order to use a custom domain for your WorkAdventure world, you will first need to have a dedicated domain or sub-domain for WorkAdventure.

You need administrator access to your registrar's DNS settings to configure the domain name properly.

Log into your registrar account.

Assuming your domain name is example.com and you want to create a world.example.com, you will need to create a new CNAME record, whose value will be whitelabel.workadventu.re..

Your settings will probably look like this:

Host name	Type	TTL	Data
world	CNAME	1H	whitelabel.workadventu.re.

The final dot in whitelabel.workadventu.re. is important. Do not forget it!

Domain configuration¶

When the DNS configuration is done, go to your WorkAdventure account, in the world edition page, and head to the "White Label / Rebranding" section.

URL structure¶

When your custom domain is configured, the URL of your rooms will look like this:

https://world.example.com/@/[anything you want]

The /@/ part in the URL is compulsory. The rest of the path can be configured freely in the "slug" field of the room. The slug can contain "/" characters.

Pro tip: in order to have the same exits in your test setup and your production setup, we advise you to use the name of the map file as the slug. So if your map file name is castle.json, you can use castle.json as the slug of your room to have the same exitUrl in testing and in production.

Common questions¶

Can I host WorkAdventure in a path of an existing domain?

No, you cannot host your world in a sub-path of an existing domain. For instance, if your website is hosted at https://www.example.com, you cannot host your world at https://www.example.com/world/. You can however create a dedicated domain at https://world.example.com

Can I link a domain to several worlds?

Only one world can be linked to one domain, and conversely, only one domain can be used for one world.

Customize graphical assets¶

Most graphical assets (images) of WorkAdventure can be modified from the World edition pop-up in the admin dashboard.

Next to your world name, click on the pencil icon. A popup will open. Go to the "Graphical assets" section:

You can replace the following assets: