Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 40 additions & 0 deletions tutorials/export/exporting_for_web.rst
Original file line number Diff line number Diff line change
Expand Up @@ -453,6 +453,46 @@ the export menu.
* - Encryption / Encryption Key
- ``GODOT_SCRIPT_ENCRYPTION_KEY``

.. _doc_exporting_for_web_troubleshooting:

Troubleshooting
---------------

Running the export locally shows another project instead
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

If you use one-click deploy in multiple projects, you may notice that one
of the projects you've previously deployed is shown instead of the project
you're currently working on. This is due to service worker caching which
currently lacks an automated cache busting mechanism.

As a workaround, you can manually unregister the current service worker
so that the cache is reset. This also allows a new service worker to be registered.
In Chromium-based browsers, open the Developer Tools by pressing
:kbd:`F12` or :kbd:`Ctrl + Shift + I` (:kbd:`Cmd + Option + I` on macOS),
then click on the Application tab in DevTools (it may be hidden behind a chevron
icon if the devtools pane is narrow). You can either check
:button:`Update on reload` and reload the page, or click :button:`Unregister`
next to the service worker that is currently registered, then reload the page.

.. figure:: img/exporting_for_web_reset_unregister_service_worker_chromium.webp
:align: center
:alt: Unregistering the service worker in Chromium-based browsers' DevTools

Unregistering the service worker in Chromium-based browsers' DevTools

The procedure is similar in Firefox. Open developer tools by pressing
:kbd:`F12` or :kbd:`Ctrl + Shift + I` (:kbd:`Cmd + Option + I` on macOS),
click on the Application tab in DevTools (it may be hidden behind a chevron
icon if the devtools pane is narrow). Click :button:`Unregister` next to the
service worker that is currently registered, then reload the page.

.. figure:: img/exporting_for_web_reset_unregister_service_worker_firefox.webp
:align: center
:alt: Unregistering the service worker in Firefox's DevTools

Unregistering the service worker in Firefox's DevTools

Export options
--------------

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 8 additions & 0 deletions tutorials/export/one-click_deploy.rst
Original file line number Diff line number Diff line change
Expand Up @@ -157,3 +157,11 @@ Web > Use TLS**.
the paths to the key and certificate files in the **Export > Web > TLS Key**
and **Export > Web > TLS Certificate**. This will only work if the project
is accessed through a domain name that is part of the TLS certificate.

.. warning::

When using one-click deploy on different projects, it's possible that
a previously edited project is being shown instead. This is due to service
worker caching not being cleared automatically. See
:ref:`doc_exporting_for_web_troubleshooting` for instructions on unregistering
the service worker, which will effectively clear the cache and resolve the issue.