docs/content/1.self-hosting/3.about-pwa.md

24 lines
2.0 KiB
Markdown
Raw Normal View History

2023-12-12 18:36:07 +00:00
---
title: 'PWA vs no-PWA'
---
2023-12-31 14:39:55 +00:00
# About Self-hosting PWA
2023-12-12 18:28:16 +00:00
So that clients can have a more native app-like experience on mobile, movie-web has a function to support Progressive Web Apps (PWA). You can learn more about what a PWA is [here](https://developer.mozilla.org/en-US/docs/Web/Progressive_web_apps/Guides/What_is_a_progressive_web_app).
2023-12-12 18:28:16 +00:00
2023-12-12 21:27:15 +00:00
In movie-web version 3, PWAs were enabled by default. Unfortunately, PWAs tend to come with caching complications that can be tricky to resolve. That's why we have **disabled** PWAs by default in movie-web version 4. If you are upgrading from version 3, please [read our upgrade guide](../3.client/5.upgrade.md) for more information.
::alert{type="warning"}
Enabling PWAs means that you cannot disable it again - Please only proceed if you know what you are doing!
::
## If you are running movie-web on a hosting platform such as Vercel
2023-12-12 21:27:15 +00:00
If your hosting is building movie-web from the source, you can enable PWAs using the [`VITE_PWA_ENABLED`](../3.client/3.configuration.md#vite_pwa_enabled) environment variable.
2023-12-31 14:39:55 +00:00
Setting [`VITE_PWA_ENABLED`](../3.client/3.configuration.md#vite_pwa_enabled) to `true` will generate a [service worker file](https://developer.mozilla.org/en-US/docs/Web/Progressive_web_apps/Guides/Making_PWAs_installable#service_worker) and a [web app manifest](https://developer.mozilla.org/en-US/docs/Web/Progressive_web_apps/Guides/Making_PWAs_installable#the_web_app_manifest) which enable the website to be installed from a [web browser both on Desktop and on Mobile](https://developer.mozilla.org/en-US/docs/Web/Progressive_web_apps/Guides/Making_PWAs_installable#installation_from_the_web).
2023-12-12 21:27:15 +00:00
## If you are running movie-web using the .zip files
2023-12-31 14:39:55 +00:00
If you are downloading the movie-web `zip` files from our GitHub and installing them on a static website host, then all you need to do is to make sure to download the [`movie-web.pwa.zip`](https://github.com/movie-web/movie-web/releases/latest/download/movie-web.pwa.zip) file instead of the `movie-web.zip` file!