From 3d759542358512c19cb22e81b1597cb301e6e3da Mon Sep 17 00:00:00 2001 From: mrjvs Date: Tue, 12 Dec 2023 22:27:15 +0100 Subject: [PATCH] Add update information --- content/1.self-hosting/2.use-backend.md | 11 ++++++- content/1.self-hosting/3.about-pwa.md | 17 +++++++++-- content/3.client/0.introduction.md | 12 +++++++- content/3.client/4.changelog.md | 39 ++++++++++++++++++++++++- content/3.client/5.upgrade.md | 10 +++++-- 5 files changed, 82 insertions(+), 7 deletions(-) diff --git a/content/1.self-hosting/2.use-backend.md b/content/1.self-hosting/2.use-backend.md index ebc9701..457100f 100644 --- a/content/1.self-hosting/2.use-backend.md +++ b/content/1.self-hosting/2.use-backend.md @@ -3,4 +3,13 @@ title: 'Configure backend' --- # Configure your client with the backend -// CONFIGURE IT HERE \ No newline at end of file +If you would like to use an alternative backend server (The server responsible for saving user data across devices) then you can specify your own URL **without needing to host your own movie-web frontend!** + +::alert{type="danger"} +Changing your backend server will log you out of your account - make sure you have a copy of your 12-word passphrase saved safely in case you need to go back! +:: + +1. On movie-web, got to your settings page by click the menu icon at the top right and then `Settings`. +1. Scroll down the page to the section named `Connections` where there is a toggle named `Custom server`. +1. Enable the `Custom server` toggle and enter your backend URL in the input box named `Custom server URL`. +1. Click `Save` at the bottom right corner of your screen. diff --git a/content/1.self-hosting/3.about-pwa.md b/content/1.self-hosting/3.about-pwa.md index 290e163..fdebfd2 100644 --- a/content/1.self-hosting/3.about-pwa.md +++ b/content/1.self-hosting/3.about-pwa.md @@ -1,7 +1,20 @@ --- title: 'PWA vs no-PWA' --- -# About selfhosting PWA +# About Selfhosting PWA -// EXPLAIN WHY ITS A BAD IDEA, BUT ALSO HOW TO DO IT +So that clients can have a more native app-like experience on mobile, movie-web has a function to support Progessive 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). +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 hoster such as Vercel +If your hosting is building movie-web from the source, you can enable PWAs using environment variables. The full environment variable reference can be found [here](../3.client/3.configuration.md) but for PWAs we are only interested in `VITE_PWA_ENABLED`. + +Setting `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). + +## If you are running movie-web using the .zip files +If you are downloading the movie-web `zip` files from our GitHub and installing them on a static website hoster, 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! \ No newline at end of file diff --git a/content/3.client/0.introduction.md b/content/3.client/0.introduction.md index f93a948..40fdb02 100644 --- a/content/3.client/0.introduction.md +++ b/content/3.client/0.introduction.md @@ -3,4 +3,14 @@ title: 'Introduction' --- # Introduction to the client -// EXPLAIN WHAT THE CLIENT DOES \ No newline at end of file +The client is what the main part of the application, it houses the interface and all of the scraping logic. + +## PWA + +The client can be optionally ran as a PWA. This can be hard to do correctly and really hard to reverse, so it's generally not recommended to do so if you don't have experience hosting PWA's. + +You can read more about it [here](../1.self-hosting/3.about-pwa.md). + +## Configuration + +The client has a decent amount of configuration options. You can view them all [here](./3.configuration.md). diff --git a/content/3.client/4.changelog.md b/content/3.client/4.changelog.md index 4a61910..8eb3543 100644 --- a/content/3.client/4.changelog.md +++ b/content/3.client/4.changelog.md @@ -3,4 +3,41 @@ title: 'Changelog' --- # Version 4.0.0 -// CHANGELOG GOES HERE +::alert{type="info"} +If you are upgrading from a previous version, make sure to read [the upgrade guide](5.upgrade.md). +:: + +### Bug fixes +- Fixed bug where video player overlays the controls on IOS. +- Fixed bug where you are kicked out of the fullscreen when switching episode. +- Fixed bug where you cannot select a different episode if first episode fails to load. + +### Enhancements +- Completely redesigned look and feel for the entire website. +- Added FAQ and DMCA pages. +- Source loading page is more detailed. +- Video player has been remade from scratch, all internal workings are brand new. +- You can now input numbers manually into the subtitle customization menu. +- Subtitle delay can now be increased outside of the slider range by inputting manual numbers. +- Movie and show URL's now include the name of the media in the link, makes it easier at a glance to see what a link is about. +- Instructions on how to download are now given inside the app. +- Chromecasting no longer shows captions on the web player (still doesnt show on cast receiver) +- Chromecasting now supports HLS + +### New features +- Quality selector! You can now switch qualities. +- Search bar no longer requires you to choose between shows or movies. +- Visit `/s/:term` to quickly watch something. For example `https://movie-web.app/s/hamilton`. +- You can now add movie-web as a search provider in your browser. +- Safari now has subtitles when fullscreening. +- A next episode button will appear when close to the end of an episode, allowing quick switching to next episode. +- When seeking and hovering over progress bar, you will now see a thumbnail for the place you're hovering. +- Subtitles now have language flag next to them. +- Your subtitle preference gets saved. +- Turn on subtitles using keyboard shortcut `C`. +- Self-hosters can now test their configurations at the `/admin` page. +- Subtitles can now be downloaded. +- Sync your data through online accounts (using passphrases for maximum privacy) +- You can now choose your own worker URL set in the settings page. +- A custom backend server URL can be set on the settings page. +- On the settings page, you can now choose between multiple themes. diff --git a/content/3.client/5.upgrade.md b/content/3.client/5.upgrade.md index b95c51b..33cc0c6 100644 --- a/content/3.client/5.upgrade.md +++ b/content/3.client/5.upgrade.md @@ -1,6 +1,12 @@ --- title: 'Upgrade guide' --- -## Upgrade guide +# Upgrade guide -// UPGRADE GUIDE HERE +## From `3.X` to `4.0.0` + +You will need the latest version of the proxy worker. Redeploy a new worker using [our self-hosting guide](../2.proxy/1.deploy.md). + +After you have the new worker, you will need to [get the new movie-web deployment files](https://github.com/movie-web/movie-web/releases/latest). **You CANNOT use the non-PWA version**. To upgrade safely without any complications, you need to update with `movie-web.pwa.zip`, Not the non-PWA version. + +In the future, you will **ALWAYS** need to go with the PWA option. You cannot downgrade to non-PWA version without facing many caching complications.