movie-web/docs
1
0
Fork 0
mirror of https://github.com/movie-web/docs.git synced 2025-09-13 05:43:26 +00:00
Code Issues Packages Projects Releases Wiki Activity

Port all documents to MDX

Browse Source
This commit is contained in:
mrjvs
2024-03-30 20:34:50 +01:00
parent c06bedc93c
commit 268014552c
30 changed files with 62 additions and 120 deletions
Download Patch File Download Diff File Expand all files Collapse all files

36
pages/backend/changelog.mdx Normal file
View File

@@ -0,0 +1,36 @@
---
title: 'Changelog'
---
# Version 1.3.1
- Fixed bug where "false" env variables weren't treated as false for booleans
- Added ARM support for hosted docker container
- Stopped using JSON for recaptcha verifications.
# Version 1.3.0
For this update, you will need to run migrations.
- proxy url syncing
- remove npm usage, replace with pnpm
- add postgresql ssl support
# Version 1.2.0
::alert{type="warning"}
For this update, you will need to run migrations.
::
- [Added option to trust Cloudflare IP headers for ratelimits](2.configuration.md#servertrustcloudflare)
- Removed unused table
- Optimized prometheus metrics, should make less indexes
# Version 1.1.5
- Prometheus metrics endpoint
- Account creation/deletion endpoints
- Endpoints for importing old account data
- Endpoints for syncing data
- [Ratelimit system](2.configuration.md#ratelimit)
- [Captcha system](2.configuration.md#captcha)

245
pages/backend/configuration.mdx Normal file
View File

@@ -0,0 +1,245 @@
---
title: 'Configuration'
---
# Backend Config Reference
The backend can be configured in 3 different ways:
- Make a `config.json` file in the working directory of the application (root of repository)
- Make a `.env` file in the working directory of the application (root of repository)
- Add environment variables to your system (or container)
These different config options are all mutually inclusive, so you can use multiple at the same time if you want to.
::alert{type="warning"}
With any of these configurations, you have to have atleast three variables set for the server to function:
[`postgres.connection`](#postgresconnection), [`crypto.sessionSecret`](#cryptosessionsecret) and [`meta.name`](#metaname)
::
### Method 1 - `config.json`
This method uses nesting, so the key `server.basePath` with the value of `"/backend"` will result in a file that looks like this:
```json
{
"server": {
"basePath": "/backend"
}
}
```
### Method 2 - `.env`
The environment variable names use double underscores as separators and `MWB_` as the prefix. So the key `server.basePath` will result in the .env file like this:
```sh
MWB_SERVER__BASE_PATH=/backend
```
### Method 3 - Environment
This method is identical to the `.env` method listed above, but you add the variables to the environment instead of writing it in a file.
# Reference
## Server
All configurations related to the HTTP server.
### `server.port`
- Type: `number`
- Default: `8080`
Port number that the HTTP server listens on.
### `server.cors`
- Type: `string`
- Default: `""`
- Example: `"https://movie-web.app https://testing.movie-web.app"`
Space separated list of allowed origins.
### `server.allowAnySite`
- Type: `boolean`
- Default: `false`
If set to true, it allows any origin to access the site. This overwrites the [`server.cors`](#servercors) setting.
### `server.trustProxy`
- Type: `boolean`
- Default: `false`
Controls whether the server should trust reverse proxy headers. This is used to identify users for ratelimiting.
### `server.trustCloudflare`
- Type: `boolean`
- Default: `false`
Controls whether the server should trust Cloudflare IP headers. This is used to identify users for ratelimiting.
### `server.basePath`
- Type: `string`
- Default: `"/"`
Prefix for which path is being listened on. Useful if you're hosting on `example.com/backend` for example.
::alert{type="info"}
If this is set, you shouldn't apply URL rewriting before proxying.
::
## Logging
All configurations related to how the HTTP server will log. This is not related to the [metrics](0.introduction.md#metrics) endpoint.
### `logging.format`
- Type: `string` | `"pretty"` | `"json"`
- Default: `"pretty"`
Logging format to use, should be either `pretty` or `json`, most users should probably use the default.
## Postgres
All configurations related to how postgres functions.
### `postgres.connection` ⚠
- Type: `string`
- Example: `"postgresql://localhost:5432"`
Connection URL for postgres instance, should contain the database in the URL.
::alert{type="danger"}
**Required. The backend will not start if this is not configured.**
::
### `postgres.migrateOnBoot`
- Type: `boolean`
- Default: `false`
Run all [migrations](0.introduction.md#migrations) that haven't ran yet on boot.
::alert{type="warning"}
If you have multiple replicas running, this can cause a lot of issues. We recommend only using this if you run only one replica.
::
### `postgres.debugLogging`
- Type: `boolean`
- Default: `false`
Log all postgres queries in the console. Useful for debugging issues with the database.
::alert{type="warning"}
This outputs sensitive, **DO NOT** run it in production.
::
### `postgres.ssl`
- Type: `boolean`
- Default: `false`
Enable SSL for postgres connections. Useful if you're using a hosted postgres database.
## Cryptography
All configurations related to cryptography.
### `crypto.sessionSecret` ⚠
- Type: `string`
The secret used to sign sessions. **Must be at least 32 characters long.**
::alert{type="danger"}
**Required. The backend will not start if this is not configured.**
::
## Meta
These options configure how the server will display itself to the frontend.
### `meta.name` ⚠
- Type: `string`
- Example: `"Unofficial movie-web"`
The name of the backend instance, this will be displayed to users who try to create an account.
::alert{type="danger"}
**Required. The backend will not start if this is not configured.**
::
### `meta.description`
- Type: `string`
- Default: `""`
- Example: `"This is not an official instance of movie-web"`
The description of the backend instance, this will be displayed to users who try to create an account.
## Captcha
All configurations related to adding captcha functionality. Captchas' help to protect your server from bot attacks.
### `captcha.enabled`
- Type: `boolean`
- Default: `false`
Enables [Recaptcha](https://www.google.com/recaptcha/about/) support for user registration and login. [You can follow this guide to create a Recaptcha key](https://cloud.google.com/recaptcha-enterprise/docs/create-key-website#create-key){target="\_blank"}.
::alert{type="warning"}
If this is enabled, all other captcha related settings are required.
::
### `captcha.secret`
- Type: `string`
- Default: `""`
- Example: `"sjgaJ@3djasFVx"`
[Google Recaptcha](https://www.google.com/recaptcha/about/) secret key.
### `captcha.clientKey`
- Type: `string`
- Default: `""`
- Example: `"2jf853z5bc63bvDb2323FAda"`
[Google Recaptcha](https://www.google.com/recaptcha/about/) site key.
## Ratelimits
All configuration options related to adding ratelimiting functionality. Helps to protect against bot attacks or spammy users.
::alert{type="info"}
Make sure your IP headers are properly forwarded if you're using a reverse proxy. Also see [`server.trustProxy`](#servertrustproxy).
::
### `ratelimits.enabled`
- Type: `boolean`
- Default: `false`
Enables ratelimiting some more expensive endpoints.
::alert{type="warning"}
If this is enabled, all other ratelimit related settings are required.
::
### `ratelimits.redisUrl`
- Type: `string`
- Default: `""`
- Example: `"redis://localhost:6379"`
Redis connection URL for storing ratelimit data. You can use a plain redis instance for this, no modules are required.

97
pages/backend/deploy.mdx Normal file
View File

@@ -0,0 +1,97 @@
---
title: 'Deploy'
---
# Deploying the backend
The only officially recognized hosting method is through Docker (or similar container runtimes). It can be scaled horizontally to all your heart's content and is the safest way to host the backend.
For configuration, check out the [configuration reference](2.configuration.md).
::alert{type="info"}
The postgres database will need to be populated with [migrations](0.introduction.md#migrations) if `postgres.migrateOnBoot` isn't enabled.
::
## Method 1 - Docker Deployment
This method provides a straightforward setup with minimal configuration. For more extensive customization, see the [Configuration Reference](2.configuration.md).
**Prerequisites**
* **Docker:** If you don't have Docker installed, download it from the official website: [Docker installation](https://www.docker.com/get-started)
* **Docker Compose:** Install Docker Compose following the instructions for your operating system: [Docker-Compose installation](https://docs.docker.com/compose/install/)
**Setup**
1. **Create `docker-compose.yml`:**
```yaml
version: '3.8'
services:
postgres:
image: postgres
environment:
POSTGRES_USER: movie_web_user
POSTGRES_DB: movie_web_backend
POSTGRES_PASSWORD: YourPasswordHere
ports:
- "5432:5432"
networks:
- movie-web-network
movie-web:
image: ghcr.io/movie-web/backend:latest
environment:
MWB_POSTGRES__CONNECTION: postgresql://movie_web_user:YourPasswordHere@postgres:5432/movie_web_backend
MWB_CRYPTO__SESSION_SECRET: 32CharacterLongStringHere
MWB_META__NAME: unofficial-movie-web
MWB_POSTGRES__MIGRATE_ON_BOOT: "true"
MIKRO_ORM_MIGRATIONS_DISABLE_FOREIGN_KEYS: "true"
ports:
- "80:80"
depends_on:
- postgres
networks:
- movie-web-network
networks:
movie-web-network:
driver: bridge
```
**Important:**
* Replace `YourPasswordHere` with your secure database password.
* Generate a strong session secret and replace `32CharacterLongStringHere`.
2. **Start the Backend:** Open a terminal in the directory containing `docker-compose.yml` and execute:
```bash
docker-compose up -d
```
**Accessing Your Backend**
Your backend should be accessible on `(YourPrivateIP):80`. To share it outside your local network, you'll need to configure port forwarding or cloudflared tunnel.
**Optional: Implementing a Reverse Proxy**
To enhance your SSL and domain configuration, it's advisable to establish a reverse proxy, such as Nginx. For an optimal choice in this regard, Cloudflare Zero Trust Tunnel is recommended. You can find more information [here](https://developers.cloudflare.com/cloudflare-one/connections/connect-networks/get-started/create-remote-tunnel/).
- If you decide to utilize a reverse proxy, it's important to include `MWB_SERVER__CORS: "https://movie.example.com"` in your configuration.
- `MWB_SERVER__CORS` must contain a **space-separated** list of origins (Protocol + Hostname) for the client to be able to access the backend.
- Depending on your specific setup, you may also require the addition of `MWB_SERVER__TRUST_PROXY: true` and `MWB_SERVER__TRUST_CLOUDFLARE: true`.
## Method 2 - Railway (Easy)
Railway offers you $5 of credit once you verify your account, which is enough to run the backend for around 5 months (~$0.90 per month).
[![Deploy on Railway](https://railway.app/button.svg)](https://railway.app/template/TS4mw5)
1. Login to your [Railway](https://railway.app) account if you have one, otherwise create one [here](https://railway.app/login).
1. If you are signing up, then verify your account by clicking the link in the email Railway sends you.
1. If you created your account with an email, then to verify your account further, go to your account, then plans and verify your account with a GitHub account.
1. Click the [`Deploy on Railway`](https://railway.app/template/TS4mw5) button above.
1. If a `Configure` button is displayed, click on it and allow Railway to access your GitHub account.
1. Fill in the required variables or change the default values.
1. The `Deploy` button at the bottom of the template should be active, click on it.
1. Once the `Backend` service has deployed, copy the URL from the `Deployments` page. (Might take a second for it to be available after the service has deployed)
1. Congratulations! You have deployed the backend, you can now [set up the client](../1.self-hosting/2.use-backend.md).

30
pages/backend/introduction.mdx Normal file
View File

@@ -0,0 +1,30 @@
---
title: 'Introduction'
---
# Introduction to the backend
The backend is essentially just an account server. It handles user accounts, syncing, and other account related features.
## Recommended Community Backend
To keep consistency and compatibility between different instances our partner, [lonelil](https://github.com/lonelil), has kindly offered to host a movie-web backend with a copy of the original data from the now unavailable movie-web.app backend. You can access this backend at: `https://mw-backend.lonelil.com` and `https://mw-backend.lonelil.ru`
Meaning users **do not** have to set up a new account; you can use your previous passphrase from movie-web, and all of your data will be there!
## Metrics
The backend exposes an endpoint for [Prometheus metrics](https://prometheus.io/){target="\_blank"} which allows you to keep track of the backend more easily, it can be accessed on `/metrics`.
To view these metrics properly, you'll need to use an analytics program like [Grafana](https://grafana.com/){target="\_blank"}, [which can visualize logs from Prometheus](https://prometheus.io/docs/visualization/grafana/){target="\_blank"}.
## Security
Optionally, there are a few security settings:
- [Recaptcha support](2.configuration.md#captcha), the server can verify Recaptcha v3 tokens on register and login.
- [Ratelimits](2.configuration.md#ratelimits), some expensive endpoints have ratelimits, but only when enabled. This requires an additional redis connection.
## Migrations
Migrations help keep your database schema in sync with everyone else. To run migrations, you can use the `pnpm migration:up` command inside the docker container or in your command-line if you're not using docker.
Alternatively, you can enable the [`postgres.migrateOnBoot`](2.configuration.md#postgresmigrateonboot) variable and it will be automatically migrated on boot.

7
pages/backend/upgrade.mdx Normal file
View File

@@ -0,0 +1,7 @@
---
title: 'Upgrade guide'
---
# Upgrade guide
There is only one major version, there is nothing to write here yet.

264
pages/client/changelog.mdx Normal file
View File

@@ -0,0 +1,264 @@
---
title: 'Changelog'
---
# Version 4.6.3
- Updated providers to 2.2.5
- Fixed vercel routing
- Fixed TV browsers crashing because of MediaSession
- Fixed Chinese (traditional) translation
- Optimized all images
- Fixed page scrolling when adjusting the volume using the scroll wheel
- Added support for HLS audio tracks (You now have the option to change the audio language for RidoMovies)
- Admin page no longer leaks the worker url.
- Added the ability to drag and drop your subtitle files.
- Improved the error message when the extension has not whitelisted the domain. It should now ask you to grant permission.
- Fixed an issue where the episode progression would not save after clicking the 'Next episode' button
- Improved translations: Catalan, Czech, German, Spanish, Estonian, Persian, French, Galician, Indonesian, Italian, Dutch, Polish, Portuguese (Brazil), Romanian, Russian, Turkish, Chinese (Han (Traditional variant))
# Version 4.6.2
- Updated providers to 2.2.3
- Added defaults for extension store links
- Onboarding now defaults to true for self-hosters.
- Support for embedded HLS subtitles (This fixes Ridomovies having default subtitles that could not be changed).
- Improved translations: Polish, Toki Pona
# Version 4.6.1
- Fixed subtitle blur settings loading as NaN
- Improved translations: Czech, German, Persian, French, Italian, Dutch, Russian, Slovenian, Ukrainian, Chinese (Han (Simplified variant))
# Version 4.6.0
- Implemented media session support!
- Added option to blur background in subtitles
- Added vercel config to properly support using non-hash routing
- Fixed a bug in config that treated empty environment variables as being set, causing config.js to be ignored
- Fixed a bug in the button component that meant our own pages opened in a new tab
- Added new translations: Catalan
- Improved translations: Catalan, Spanish, Persian, French, Hindi, Icelandic, Italian, Nepali (macrolanguage), Dutch, Panjabi, Slovenian, Chinese (Han (Simplified variant)), Russian, Estonian, Korean
# Version 4.5.1
- Improved translations: Catalan, Czech, Spanish, Persian, French, Italian, Portuguese (Brazil), Russian, Tamil, Vietnamese, Chinese (Han (Simplified variant))
- Update providers to 2.2.2
- Update Dockerfile to have build-time arguments and add a Docker compose file
- Allow banners to be dismissible
- Update extension logic to process all URLs in a HLS playlist
- Automatically prefix backend URL with https:// if not provided
# Version 4.5.0
- Improved translations: Estonian, Persian, Toki Pona, Vietnamese.
- Route subtitles through extension if installed.
- Fix Docker build failing when PWA is enabled.
- Add randomised placeholders for search bar.
- Add preview to the theme selector.
- Remove references to the official domain.
- Update admin page to run worker tests in parallel.
- Disable creating account when backend server isn't set.
- Remove default setup option if no default proxy set.
- Remove extension help text when extension succeeded.
- Allow configuration of Google Analytics - removed our default one.
- Fix media download button redirection to incorrect URL on main tab.
- Allow users to change volume with scroll wheel.
# Version 4.4.0
- Changed behaviour of HLS playlists to have a copy button instead of a download button for more compatibility.
- Improve the appearance of the "active" pill under theme settings - it now has better padding and matches the theme it represents.
- If a user selects a proxy during onboarding, it is now saved to the backend if the user is signed in.
- Fixed sorting of shows that caused the "continue watching" to not update properly when syncing with the backend.
- Added an "x" button to clear the search query.
- Improve mobile layout for setup component.
- Fix HLS issue with throwing 403 error.
- Improved translations: Arabic, German, Persian, Finnish, Galician, Italian, Japanese, Korean, Panjabi, Russian, Turkish, Ukrainian, Chinese (Han (Simplified variant)).
- Update providers package to 2.2.
# Version 4.3.3
- Fixed body not being transferred properly to the extension (needs latest version of extension)
- Added new translations: Finnish
- Improved translations: Czech, German, English, Spanish, Persian, French, Galician, Gujarati, Hebrew, Hindi, Icelandic, Navajo, Portuguese (Brazil), Russian, Ukrainian, Chinese (Han (Simplified variant))
# Version 4.3.2
- Run account server data fetching in parallel.
- Added specific text per browser for extension setup screen
- Fix bug where first load the page couldn't talk to extension
- Fix too short of a timeout when checking for proxy response
- Move start of bolding for HLS disclaimer
- Fix app crash when opening download screen on lower RAM browsers
- Make onboarding start screen more mobile friendly
- Separate extension install links into two settings (firefox & chrome)
- Added new translations: Icelandic
- Improved translations: German, Spanish, Persian, French, Hebrew, Italian, Nepali (macrolanguage), Dutch, Polish, Portuguese (Brazil), Romanian, Chinese (Han (Simplified variant))
# Version 4.3.1
- Fix provider API interaction with extension.
# Version 4.3.0
- Add onboarding process to movie-web, triggable manually through settings. This needs to be turned when selfhosting.
- Added settings to toggle generated thumbnails, disabled by default
- Fix multiple subtitles with same language all showing as selected
- Add docker support, a hosted container image included (with ARM support)
- Added extension support, run movie-web without setting up a custom proxy
- Add disabled cursor for disabled buttons
- Add instruction link to custom proxy and custom server settings
- Added backdrop blur to navigation buttons
- Updated provider package (Re-enabled showbox/febbox subtitles)
- Added new translations: Catalan
- Improved translations: Bengali, Czech, German, Spanish, Persian, French, Galician, Italian, Nepali, Dutch, Polish, Portuguese, Portuguese, Russian, Turkish, Ukrainian, Vietnamese, Chinese
# Version 4.2.5
::alert{type="warning"}
This release requires a new version of simple-proxy: 2.1.3
::
- Update provider package, with fixes for febbox-mp4
# Version 4.2.4
::alert{type="warning"}
This release requires a new version of simple-proxy: 2.1.1
::
- Add meta tag for PWA's for apple devices
- Add galician flag
- Fix language fallback, this fixes weird dot notation instead of english language fallback
- Add Docker image for frontend
- Fix Brazilian portuguese flag in language selector
- Add profile picture preview in register and update
- Update Provider package to 2.0.4
- Added new translations: Catalan
- Improved translations: Czech, Greek, French, Gujarati, Hebrew, Hindi, Italian, Khmer (Central), Nepali, Dutch, Punjabi, Polish, Portuguese (Brazil), Romanian, Russian, Ukrainian, Vietnamese, Chinese (Simplified), pirate (generated), minion (generated)
# Version 4.2.3
- Fix player UI not disappearing
- Implement new locale system to support regional and alternative languages
- Add Turnstile interactive challenge and Turnstile loading screen
- Added new translations: Galician, Punjabi, Romanian
- Improved translations: Arabic, Czech, German, Spanish, Estonian, Gujarati, Hindi, Russian, Chinese (Simplified)
# Version 4.2.2
- Add worker URL syncing for accounts
- Fix broken hero title during the day
- Move search items with no poster to the end of the search results
- disable episodes if they have not been aired yet
- update provider package: disable febbox HLS, irreparable
- Added new translations: Bulgarian, Bengali, Greek, Persian, Gujarati, Indonesian, Japanese, Korean, Slovenian, Tamil, Chinese (Traditional)
- Improved translations: Arabic, Czech, German, Spanish, Estonian, French, Hebrew, Hindi, Italian, Nepali, Dutch, Polish, Portuguese (Brazil), Russian, Thai, Toki Pona, Turkish, Ukrainian, Chinese (Simplified), pirate (generated), minion (generated)
# Version 4.2.1
- Fix the scrape screen showing success when it shouldn't
- Fix some more [Object object] showing in the error dialogue
- Updated translations: Czech, German, French, Polish, Italian, Thai, Hebrew, Nepali, Estonian, Toki Pona, Portuguese, Pirate
- Fix Ukrainian, Hindi and Toki Pona flags
# Version 4.2.0
- Add splashscreens for PWA
- Renamed captions to subtitles in translations
- Add youtube-esque shortcuts for navigating video
- Fix error dialogue not showing actual error message but instead shows [Object object]
- Gray subtitle color
- Hide settings button on mobile when it shouldnt have shown
- Fix Estonia and Nepal flag
- Update provider package to 2.0.1
- Superstream now split into showbox and febbox.
- Fixed sidebar not highlighting last item on high screens
- New translations: Hindi, Polish, Portuguese - Brazillian, Ukrainian
- Updates to translations: Czech, Estonian, German, Hebrew, Cambodian, Nepali, Swedish, Thai, Chinese, Minion
# Version 4.1.3
- Add support for downloading HLS playlists
- Added cdn replacements configuration option
- new translations: estonian, toki pona, spanish
- Translation improvements: german, turkish, nepali, chinese
# Version 4.1.2
- Improve bundle chunking
- Add millionjs for faster react
- Update all dependency versions
- Translation improvements: czech, hebrew, german
- Fix mobile controls not going away after some time
- Improve poster quality
- Fix "media not found" error not being shown
- Add more information to the error details modal
# Version 4.1.1
- Fixed bug where settings toggles sometimes weren't usable
- Fixed bug where captions were permanently enabled
- Fixed some missing translations
- Translation improvements: arabic, french, nepali, chinese
# Version 4.1.0
- Added new translations: arabic, chinese, latvian, thai, nepali, dutch
- Translation improvements: turkish, hebrew
- Fixed text directions for captions
- Anti-tamper script has been removed and replaced with turnstile (this is the devtools blocked, you can use devtools again)
- Added way to add the providers-API instead of proxies
# Version 4.0.2
- Added new translations: Hebrew, French, German, Swedish, Turkish.
- Added minion joke language. Blame @jip\_.
- Thumbnail preview no longer goes under the next episode button.
- Passphrase inputs are now actual password fields, so they may act nicer with password managers.
- The player now remembers what your subtitle settings were, so no longer you need to keep selecting english every time you watch.
- Fix home link not working with /s/:term shortcut.
- Swedish flag is now an actual Swedish flag.
- Fix for various layout issues with small width mobile screens.
# Version 4.0.0
::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.

207
pages/client/configuration.mdx Normal file
View File

@@ -0,0 +1,207 @@
---
title: 'Configuration'
---
# Client Config Reference
The config for the movie-web can be provided in 2 different ways, depending on how you are hosting movie-web:
- If you are using a static web hoster (such as Vercel, Netlify or Cloudflare Pages), you can use [environment variables](#method-1-environment-variables).
- If you are hosting movie-web using shared hosting (such as cPanel or FTP), please use [the config file](#method-2-config-file).
Both methods can specify any of the keys listed in the [Shared Config](#config-reference-shared-config) section.
## Method 1 - Environment Variables
The movie-web client can be configured using environment variables **at build time**. You cannot use this method if hosting the pre-built `movie-web.zip` files!
Using environment variables to configure movie-web also allows configuration of some [environment variable specific keys](#config-reference-environment-variables-only).
## Method 2 - Config File
When using the pre-built `movie-web.zip`, you can set the configuration in the `config.js` file.
The `config.js` file contains a JavaScript object which must be set to the correct values:
```js
window.__CONFIG__ = {
// ... Config variables go here ...
};
```
## Config Reference - Shared Config
### `VITE_TMDB_READ_API_KEY` ⚠
- Type: `string`
- Default: `""`
This is the **read** API key from TMDB to allow movie-web to search for media. [Get one by following our guide](/client/tmdb).
::alert{type="danger"}
**Required. The client will not work properly if this is not configured.**
::
### `VITE_CORS_PROXY_URL`
- Type: `string`
- Default: `""`
- Example: `"https://example1.example.com,https://example2.example.com"`
This is where you put proxy URLs. [Get some by following our guides](/proxy/deploy).
If left empty, the client onboarding will not provide a "default setup" and the user will have to manually configure their own proxy or use the extension.
You can add multiple Workers by separating them with a comma, they will be load balanced using round robin method on the client.
**Worker URL entries must not end with a slash.**
::alert{type="danger"}
**Required. The client will not work properly if this is not configured.**
::
### `VITE_DMCA_EMAIL`
- Type: `string`
- Default: `""`
- Example: `"dmca@example.com"`
This is the DMCA email for on the DMCA page. If this config value is present, a new page will be made and linked in the footer, where it will mention how to handle DMCA take-down requests. If the configuration value is left empty, the page will not exist.
### `VITE_NORMAL_ROUTER`
- Type: `boolean`
- Default: `false`
The application has two routing modes: hash-router and history-router.
Hash router means that every page is linked with a hash like so: <code style="overflow-wrap: anywhere">https://example.com/#/browse</code>.
History router does routing without a hash like so: `https://example.com/browse`, this looks a lot nicer, but it requires that your hosting environment supports Single-Page-Application (SPA) redirects (Vercel supports this feature). If you don't know what that means, don't enable this.
Setting this configuration value to `true` will enable the history-router.
### `VITE_BACKEND_URL`
- Type: `string`
- Default: `""`
- Example: `"https://backend.example.com"`
This is the URL for the movie-web backend server which handles cross-device syncing.
The backend server can be found at https://github.com/movie-web/backend and is offered as a [Docker](https://docs.docker.com/get-started/overview/){target="\_blank"} image for deployment.
Backend URL must **not** end with a slash.
### `VITE_HAS_ONBOARDING`
- Type: `boolean`
- Default: `true`
If you want your users to be prompted with an onboarding screen before they start watching, enable this.
### `VITE_ONBOARDING_CHROME_EXTENSION_INSTALL_LINK`
- Type: `string`
- Default: `"https://chromewebstore.google.com/detail/movie-web-extension/hoffoikpiofojilgpofjhnkkamfnnhmm"`
- Example: `"https://google.com"`
When onboarding is enabled using `VITE_HAS_ONBOARDING`. This link will be used to link the proper Chrome extension to install.
If omitted, this will still show the extension onboarding screen, just without an install link for the extension.
### `VITE_ONBOARDING_FIREFOX_EXTENSION_INSTALL_LINK`
- Type: `string`
- Default: `"https://addons.mozilla.org/en-GB/firefox/addon/movie-web-extension"`
- Example: `"https://google.com"`
When onboarding is enabled using `VITE_HAS_ONBOARDING`. This link will be used to link the proper Firefox extension to install.
If omitted, this will still show the extension onboarding screen, just without an install link for the extension.
### `VITE_ONBOARDING_PROXY_INSTALL_LINK`
- Type: `string`
- Default: `""`
- Example: `"https://google.com"`
When onboarding is enabled using `VITE_HAS_ONBOARDING`. This link will be used to link the user to resources to host a custom proxy.
If omitted, this will still show the proxy onboarding screen, just without an documentation link for the proxy.
### `VITE_DISALLOWED_IDS`
- Type: `string`
- Default: `""`
- Example: `"series-123,movie-456"`
In the unfortunate event that you've been sent a DMCA take down notice, you'll need to disable some pages. This configuration key will allow you to disable specific ids.
For shows, it needs to be in this format: `series-<TMDB_ID>`. For movies the format is this: `movie-<TMDB_ID>`.
The list is comma separated, you can add as many as needed.
### `VITE_CDN_REPLACEMENTS`
- Type: `string`
- Default: `""`
- Example: <code style="overflow-wrap: anywhere">"google.com:example.com,123movies.com:flixhq.to"</code>
Sometimes you want to proxy a CDN. This is how you can easily replace a CDN URL with your own.
The format is `<beforeA>:<afterA>,<beforeB>:<afterB>,...`
### `VITE_TURNSTILE_KEY`
- Type: `string`
- Default: `""`
The [Turnstile key](https://dash.cloudflare.com/sign-up?to=/:account/turnstile){target="\_blank"} for Cloudflare captchas. It's used to authenticate requests to proxy workers (or providers API).
[The proxy workers will need to be configured to accept these captcha tokens](../2.proxy/2.configuration.md#turnstile_secret), otherwise it has no effect for security.
## Config reference - Environment Variables Only
::alert{type="danger"}
:icon{name="material-symbols:warning-rounded"} These configuration keys are specific to environment variables, they **only** work as environment variables **set at build time**.
::
### `VITE_PWA_ENABLED`
- Type: `boolean`
- Default: `false`
Set to `true` if you want to output a PWA application. Set to `false` or omit to get a normal web application.
A PWA web application can be installed as an application to your phone or desktop computer, but can be tricky to manage and comes with a few footguns.
::alert{type="warning"}
Make sure you know what you're doing before enabling this, it **cannot be disabled** after you've set it up once.
::
### `VITE_GA_ID`
- Type: `string`
- Default: `""`
- Example: `"G-1234567890"`
The Google Analytics ID for tracking user behavior. If omitted, no tracking will be done.
### `VITE_APP_DOMAIN`
- Type: `string`
- Default: `""`
- Example: `"https://movie-web.app"`
The domain where the app lives. Only required when having the [`VITE_OPENSEARCH_ENABLED`](#vite_opensearch_enabled) option enabled.
The value must include the protocol (HTTP/HTTPS) but must **not** end with a slash.
### `VITE_OPENSEARCH_ENABLED`
- Type: `boolean`
- Default: `false`
Whether to enable [OpenSearch](https://developer.mozilla.org/en-US/docs/Web/OpenSearch){target="\_blank"}, this allows a user to add a search engine to their browser. When enabling you **must** also set [`VITE_APP_DOMAIN`](#vite_app_domain).
::alert{type="warning"}
:icon{name="material-symbols:warning-rounded"} This field is case sensitive, make sure you use the correct casing.
::

109
pages/client/deploy.mdx Normal file
View File

@@ -0,0 +1,109 @@
---
title: 'Deploy'
---
# Deploying the client
## Method 1 - Vercel - Recommended
[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fmovie-web%2Fmovie-web%2Ftree%2Fmaster&env=VITE_CORS_PROXY_URL,VITE_TMDB_READ_API_KEY)
1. Click the Deploy button.
1. Sign in using either a GitHub, GitLab, or Bitbucket.
1. Follow the instructions to create a repository for movie-web.
1. Configure the environment variables:
- `VITE_CORS_PROXY_URL`: Enter your proxy URL here. Make sure to not have a slash at the end of your URL.
Example (THIS IS AN EXAMPLE, IT WON'T WORK FOR YOU): `https://test-proxy.test.workers.dev`
- `VITE_TMDB_READ_API_KEY`: Enter your TMDB Read Access Token here. Please read [the TMDB page](2.tmdb.md) on how to get an API key.
- `VITE_BACKEND_URL`: Only set if you have a self-hosted backend. Put in your backend URL. Check out [configuration reference](../4.client/2.configuration.md) for details. Make sure to not have a slash at the end of the URL.
1. Click "Deploy"
1. Congrats! You have your own version of movie-web hosted.
1. You may wish to configure a custom domain - Please consult [the Vercel docs for how to do this](https://vercel.com/docs/getting-started-with-vercel/domains).
## Method 2 - Static Web Host
1. Download the file `movie-web.zip` from the latest release: https://github.com/movie-web/movie-web/releases/latest.
2. Extract the ZIP file so you can edit the files.
3. Open `config.js` in an editor such as Notepad, Visual Studio Code or similar.
4. Put your proxy URL in-between the double quotes of `VITE_CORS_PROXY_URL: ""`. Make sure to not have a slash at the end of your URL.
Example (THIS IS AN EXAMPLE, IT WON'T WORK FOR YOU): `VITE_CORS_PROXY_URL: "https://test-proxy.test.workers.dev"`
5. Put your TMDB Read Access Token inside the quotes of `VITE_TMDB_READ_API_KEY: ""`. Please read [the TMDB page](2.tmdb.md) on how to get an API key.
6. If you have a self-hosted backend server, enter your URL in the `VITE_BACKEND_URL` variable. Check out [configuration reference](../4.client/2.configuration.md) for details. Make sure to not have a slash at the end of the URL.
7. Save the file.
8. Upload **all** of the files to a static website hosting such as:
- GitHub Pages
- Netlify
- Vercel
- Etc, [there are lots of options](https://www.staticwebsitehosting.org/){target="\_blank"}.
9. Congrats! You have your own version of movie-web hosted.
## Method 3 - Docker Compose - Home Network
This method is meant for those using a desktop device or single board computer with a minimum of 4GB of RAM such as a [Raspberry Pi](https://www.raspberrypi.com/) to run movie-web on there home network for network connected devices.
1. Ensure you have [docker](https://docs.docker.com/get-docker/) installed. In a newly created directory called `movie-web` create a file called `docker-compose.yaml`. Paste the contents of the code block below into this file.
```yaml
version: "3.8"
services:
movieweb:
build:
context: https://github.com/movie-web/movie-web.git
# args:
# TMDB_READ_API_KEY: ""
# CORS_PROXY_URL: ""
# BACKEND_URL: ""
ports:
- "80:80"
restart: unless-stopped
```
2. Within the `docker-compose.yaml` file uncomment `args`, `TMDB_READ_API_KEY`, `CORS_PROXY_URL`.
- Make sure `args` is in-line with `context`
- Make sure `TMDB_READ_API_KEY` and `CORS_PROXY_URL` are tabbed once to the right of `args`.
3. Put your proxy URL in-between the double quotes of `CORS_PROXY_URL: ""`. Make sure to not have a slash at the end of your URL.
Example (THIS IS AN EXAMPLE, IT WON'T WORK FOR YOU): `CORS_PROXY_URL: "https://test-proxy.test.workers.dev"`
4. Put your TMDB Read Access Token inside the quotes of `TMDB_READ_API_KEY: ""`. Please read [the TMDB page](2.tmdb.md) on how to get an API key.
5. Uncomment and add any [additional environment variables](3.configuration.md) you may need. Remove the `VITE_` prefix when adding an environment variable to `args`.
6. Save the file!
7. Now use [docker](https://docs.docker.com/get-docker/) to run `movieweb` as background service.
```bash
# movie-web is the current working directory
$ docker compose up --detach
```
8. Verify that setup was successful
- Navigate to `http://localhost`. You should see the UI for `movie-web`. Find something to watch and make sure that it plays.
- View logs with
```bash
$ docker compose logs --follow movieweb
```
9. Set a static IP address for your device.
- For Raspberry Pi: [guide](https://www.makeuseof.com/raspberry-pi-set-static-ip/)
- For Mac: [guide](https://www.macinstruct.com/tutorials/how-to-set-a-static-ip-address-on-a-mac/)
- For Windows: [guide](https://www.pcmag.com/how-to/how-to-set-up-a-static-ip-address)
10. Navigate to movie web at `http://<static-ip-address` from another device connected to your network.
### To Perform Updates For New Releases of Movie Web
1. Make sure `movie-web` is your current working directory and run:
```bash
# Re-build the image and start the container
$ docker compose up --build --detach
```

17
pages/client/introduction.mdx Normal file
View File

@@ -0,0 +1,17 @@
---
title: 'Introduction'
---
# Introduction to the client
The client is what users sees when navigating to your domain, it's the main part of the application and houses the interface and all of the scraping logic.
## Progressive Web App
The client can be optionally ran as a [PWA](https://web.dev/explore/progressive-web-apps), which allows it to be installed on a mobile device. **This can be hard to do correctly and really hard if not almost impossible to reverse**, so it's generally not recommended to do so if you don't have experience hosting PWAs. If you understand the risks and still want to continue, then read more about it [here](../1.self-hosting/3.about-pwa.md).
## Configuration
The client features various configuration options, some of which are required for the client to function. [If you are using Vercel to host the client](1.deploy.md#method-1-vercel-recommended), then the required variables are a necessary part of creating the site, if you're using another host, or hosting it for yourself, you'll need to set them up yourself.
You can view all of the configuration options on the [configurations page](3.configuration.md).

20
pages/client/tmdb.mdx Normal file
View File

@@ -0,0 +1,20 @@
---
title: 'TMDB API Key'
---
# Getting an API Key
In order to search for movies and TV shows, we use an API called ["The Movie Database" (TMDB)](https://www.themoviedb.org/){target="\_blank"}. For your client to be able to search, you need to generate an API key for yourself.
::alert{type="info"}
The API key is **free**, you just need to create an account.
::
1. Create an account at https://www.themoviedb.org/signup
1. You will be required to verify your email; click the link that you get sent to verify your account.
1. Go to https://www.themoviedb.org/settings/api/request to create a developer account.
1. Read the terms and conditions and accept them.
1. Fill out your details:
- Select "Website" as type of use.
- For the other details can put any values; they are not important.
1. Copy the "API Read Access Token" - **DO NOT COPY THE API Key - IT WILL NOT WORK**

65
pages/client/upgrade.mdx Normal file
View File

@@ -0,0 +1,65 @@
---
title: 'Update guide'
---
# Keeping your instance synced
Keeping your instance up-to-date with the latest features and bug fixes can enhance your instance's functionality and ensure it stays current. When updates are released, you have the option to adopt them using either one of the guides. Below is a automatic and an manual guide on updating your instance.
## Automatic update
You can also setup a scheduled workflow to automatically update your instance. This will allow you to keep your instance up to date without manual intervention.
To do this, you will need to follow the guide below...
1. If you have not already, click [here](https://github.com/movie-web/movie-web/fork) to fork the movie-web Github repository.
2. Paste the below file into your repository's root `/.github/workflows` directory
```yaml
# File: .github/workflows/sync.yml
name: Sync fork
on:
schedule:
- cron: "0 * * * *" # Run the job every hour
push:
branches:
- "*"
paths:
- .github/workflows/sync.yml
jobs:
sync:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- run: gh repo sync <OWNER>/<FORK> # Replace the placeholders within the < >
- uses: gautamkrishnar/keepalive-workflow@v1
```
3. Replace the `<OWNER>` placeholder with the GitHub username of the account that owns the fork.
4. Replace the `<FORK>` placeholder with the repository name of your fork.
5. Commit and push the changes to your repository.
Your instance should now be automatically updated to the latest version.
## Manual update
You can manually update by executing the following commands in the root directory of the repository you have created, you would have to do this every time a push occurs to stay up-to-date:
```bash
git remote add movie-web https://github.com/movie-web/movie-web.git
git fetch movie-web
# Change `dev` to `master` if you want a stable experience
git merge movie-web/dev --allow-unrelated-histories
git push -f # Force push to your origin main branch
```
# Upgrade version
## From `3.X` to `4.X`
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.

99
pages/extra/selfhost.mdx Normal file
View File

@@ -0,0 +1,99 @@
### Guide to full Self-Deployment of movie-web with Docker Compose
1. **Install Docker and Docker Compose:**
Ensure that Docker and Docker Compose are installed on your system. You can follow the official Docker documentation for installation instructions:
- [Install Docker](https://docs.docker.com/get-docker/)
2. **Create a Docker Compose file:**
Create a new file named `docker-compose.yml` in your project directory and paste the following content into it:
```yaml
version: '3.8'
services:
postgres:
image: postgres
restart: unless-stopped
environment:
POSTGRES_USER: movie_web_user
POSTGRES_DB: movie_web_backend
POSTGRES_PASSWORD: YourPasswordHere
networks:
- movie-web-network
movie-web-backend:
image: ghcr.io/movie-web/backend:latest
restart: unless-stopped
environment:
MWB_SERVER__CORS: "https://movie-backend.example.tld https://movie.example.tld"
MWB_SERVER__PORT: 8080
MWB_POSTGRES__CONNECTION: postgresql://movie_web_user:YourPasswordHere@postgres:5432/movie_web_backend
MWB_CRYPTO__SESSION_SECRET: 32CHARACTERLONGSECRET
MWB_META__NAME: Server name
MWB_META__DESCRIPTION: Server Description
MWB_POSTGRES__MIGRATE_ON_BOOT: "true"
MWB_SERVER__TRUSTPROXY: "true"
MWB_SERVER__TRUSTCLOUDFLARE: "true"
# This is needed to resolve errors running migrations on some platforms - does not affect the application
MIKRO_ORM_MIGRATIONS_DISABLE_FOREIGN_KEYS: "false"
ports:
- "8080:8080"
depends_on:
- postgres
networks:
- movie-web-network
movie-web-frontend:
build:
context: https://github.com/movie-web/movie-web.git
args:
TMDB_READ_API_KEY: "YourTMDBReadAPIKeyHere"
CORS_PROXY_URL: "https://cors.example.tld https://second.cors.example.tld"
BACKEND_URL: "https://backend.example.tld"
DMCA_EMAIL: "YourEmail"
PWA_ENABLED: "true"
APP_DOMAIN: "YourDomainHere"
OPENSEARCH_ENABLED: "true"
GA_ID: "Google ID Here"
ports:
- "80:80"
networks:
- movie-web-network
restart: unless-stopped
movie-web-proxy:
image: ghcr.io/movie-web/simple-proxy:latest
ports:
- "3000:3000"
networks:
- movie-web-network
restart: unless-stopped
networks:
movie-web-network:
driver: bridge
**Important:**
* Replace `YourPasswordHere` with your secure database password.
* Generate a strong session secret and replace `32CharacterLongStringHere`.
```
**Important:**
* Replace `YourPasswordHere` with your secure database password.
* Generate a strong session secret and replace `32CharacterLongStringHere`.
* Replace `TMDBReadAPIKey` with your api key learn more [here](https://movie-web.github.io/docs/client/tmdb).
* replace `yourDomainHere` with whatever you'll be using to access your main site, like movie-web.app
* replace `meta__name` and `meta__description`
2. **Start the Backend:** Open a terminal in the directory containing `docker-compose.yml` and execute:
```bash
docker compose up --detach
```
**Accessing Your Backend**
Your services should be accessible on `(YourPrivateIP):port`. To share it outside your local network, you'll need to configure port forwarding or cloudflared tunnel.
**Optional: Implementing a Reverse Proxy**
To enhance your SSL and domain configuration, it's advisable to establish a reverse proxy, such as Nginx. For an optimal choice in this regard, Cloudflare Zero Trust Tunnel is recommended. You can find more information [here](https://developers.cloudflare.com/cloudflare-one/connections/connect-networks/get-started/create-remote-tunnel/).

43
pages/extra/streaming.mdx Normal file
View File

@@ -0,0 +1,43 @@
---
title: 'Streaming'
---
# Streaming
This page explains all the different ways you can enable movie-web to stream your favorite movies & TV shows, each with their own pros and cons.
{/* ## Method 1 - Browser extension
The movie-web browser extension is the easiest way to be able to watch media with fast streaming speeds, it is available for both [Chrome] and [Firefox].
This method is great if you only use movie-web on your computer. If you use a mobile device or smart TV, you'll unfortunately have to stick to using a proxy since these devices don't usually support browser extensions.
Since this method uses your own IP, it is undetectable by streaming services, so you can use it to watch your favorite shows without worrying about getting blocked by their servers.
*/}
## Method 1 - Self-hosted proxy
Self-hosting a proxy is an easy way to get faster streaming speeds, [we have a guide](../2.proxy/1.deploy.md) that explains how to set up one for **free**.
This method is recommended if you want to host a proxy for your friends and or family to use, as it is the faster than using the public proxy and the most reliable way to stream media at the moment.
{/* This method is recommended if you want to host a proxy for your friends and family to use, or if you want to use movie-web on a device that doesn't support the [browser extension](#method-1---browser-extension), such as a smart TV or mobile device.*/}
1. Set up a proxy using one of our [guides](../2.proxy/1.deploy.md#deploying-the-proxy), [though we recommend Netlify](../2.proxy/1.deploy.md#method-1---netlify-easy).
2. Once that's done, go to the **Connections** section of the **Settings page** on your movie-web instance of chocie.
3. Enable `Use custom proxy workers` if it's not already enabled.
4. Add a new custom proxy by clicking `Add new worker`.
5. Copy the URL of the proxy you deployed before, and paste it into the empty text box.
![Example of settings page](/assets/proxy-url-example.gif)
::alert{type="info"}
If you're self-hosting the client, you can use the [`VITE_CORS_PROXY_URL`](../3.client/3.configuration.md#vite_cors_proxy_url) variable to set the proxy URL for everyone who uses your client.
::
## Method 2 - Public proxy
The public proxy is the easiest way to get started with movie-web as it is the default, it is hosted by us and is completely free to use.
If you are using the main website, then you are most likely already using the public proxy. Unfortunately you will most likely be getting slower speeds and your video might be buffering more often, which is why we recommend using a self-hosted proxy if you can.
This is not the case with self-hosted clients, there is no proxy set up by default on self-hosted clients and you will need to [set up one yourself](../2.proxy/1.deploy.md).

2
pages/index.mdx
View File

@@ -1,2 +0,0 @@
# Hello world
This is my first `@neato/guider` page!

58
pages/index.tsx Normal file
View File

@@ -0,0 +1,58 @@
import {
Button,
Card,
CardGrid,
GuiderLayout,
Hero,
} from '@neato/guider/client';
export default function LandingPage() {
return (
<GuiderLayout meta={{ layout: 'page' }} >
<Hero>
<Hero.Title>movie-web</Hero.Title>
<Hero.Subtitle>
A simple and no-BS app for watching movies and TV shows. Totally free and open source, forever.
</Hero.Subtitle>
<Hero.Actions>
<Button to="/self-hosting/hosting-intro">Get Started</Button>
<Button to="https://github.com/movie-web/movie-web" type="secondary">
Open on GitHub →
</Button>
</Hero.Actions>
</Hero>
<CardGrid>
<Card icon="mdi:server-network" title="Easy to host">
Can be easily hosted on any static website host.
</Card>
<Card icon="material-symbols:hangout-video-off" title="No Ads">
movie-web will never show ads, enjoy watching without interruptions.
</Card>
<Card icon="ic:baseline-ondemand-video" title="Custom Player">
Enjoy a fully custom video player including streaming integration, subtitle customization and easy TV season navigation.
</Card>
<Card icon="mdi:content-save" title="Saves your progress">
Will remember your progress in movies and TV shows, so you can easily continue where you left off.
</Card>
<Card icon="mdi:bookmark" title="Bookmarking">
Allows you to bookmark your favorite movies and TV shows, so you can easily find them again.
</Card>
<Card icon="mdi:cloud-refresh" title="Syncing across devices">
Enjoy uninterrupted streaming as your progress, proxies, and bookmarks sync effortlessly across all your devices.
</Card>
<Card icon="mdi:power-plug-outline" title="Modular by design">
Mix and match different parts of the movie-web service, [host your backend](4.backend/1.deploy.md) or use ours, it'll work either way.
</Card>
<Card icon="mdi:flag" title="Multiple Languages">
Supports over 25 languages, including English, German, French, Spanish, Italian, Czech, Hindi, Arabic, Hebrew and more.
</Card>
<Card icon="mdi:brush-variant" title="Customizable">
Supports various themes, subtitle colors and subtitle sizes so you can make it look however you want.
</Card>
<Card icon="mdi:cellphone" title="Progressive Web App Support">
Supports PWA, so you can install it on your phone and use it just like a native app.
</Card>
</CardGrid>
</GuiderLayout>
);
}

47
pages/instances.mdx Normal file
View File

@@ -0,0 +1,47 @@
---
title: 'Instances'
icon: 'mdi:web'
---
# Instances
This page showcases movie-web instances hosted by the community and other alternative sites. If you want to add your instance to this list, please open a pull request on [GitHub](https://github.com/movie-web/docs).
## Community Instances
The community maintains these trusted instances, meaning they are likely to be up-to-date. Remember that since these are volunteer instances, they might be down or stop working at any time. If you want to be sure you have access to movie-web, consider [hosting your own instance](../1.self-hosting/1.hosting-intro.md).
**Instances marked with a 💾 have set up a backend, making it possible to sync your data across multiple devices.**<br />
**Additionally, instances with a 🌐 use the community backend hosted by Lonelil, which has all the original movie-web.app data!**<br />
**Moreover, instances marked with a 📱 have full PWA compatibility, enabling usage on your mobile device as if it were a native application.**
| Instance | Host | Status |
| :------------------------------------------------ | :---------------------------------------------------------------------------------- | :------- |
| [mw.lonelil.com](https://mw.lonelil.com) | [lonelil - Partner](https://github.com/lonelil) | 💾🌐📱 |
| [watch.qtchaos.de](https://watch.qtchaos.de) | [chaos - Project Lead](https://github.com/qtchaos) | 💾📱 |
| [bmov](https://bmov.vercel.app) | [TheScreechingBagel - Mod](https://github.com/TheScreechingBagel) | 💾🌐 |
| [stream.thehairy.me](https://stream.thehairy.me) | [thehairy - Mod](https://github.com/thehairy) | 💾🌐📱 |
| [movie-web-me](https://movie-web-me.vercel.app) | [Isra - Contributor](https://github.com/zisra) | 💾🌐 |
| [scootydooter](https://scootydooter.vercel.app) | [Toon - Contributor](https://github.com/Toon-arch) | 💾🌐📱 |
| [sudo-flix.lol](https://sudo-flix.lol) | [itzCozi - Community Self Hoster](https://github.com/sudo-flix) | 💾📱 |
| [movie-web.x](https://movie-web.x) | [Unstoppable Domains](https://unstoppabledomains.com) and [IPFS](https://ipfs.tech) | 💾 |
::alert{type="info"}
[movie-web.x](https://movie-web.x) is only accessible using Brave, Opera or installing an [extension](https://unstoppabledomains.com/extension) to resolve unstoppable domains.
If you cannot access [movie-web.x](https://movie-web.x) try using a gateway: [Cloudflare](https://cloudflare-ipfs.com/ipns/k51qzi5uqu5diql6nkzokwdvz9511dp9itillc7xhixptq14tk1oz8agh3wrjd), [dweb.link](https://k51qzi5uqu5diql6nkzokwdvz9511dp9itillc7xhixptq14tk1oz8agh3wrjd.ipns.dweb.link), or [cf-ipfs](https://k51qzi5uqu5diql6nkzokwdvz9511dp9itillc7xhixptq14tk1oz8agh3wrjd.ipns.cf-ipfs.com)
::
## Community Backend
Our partner, Lonelil, has kindly offered to host a movie-web backend with a copy of the original data from the movie-web.app. You can access this backend at: `https://mw-backend.lonelil.com` or `https://mw-backend.lonelil.ru`
You **do not** have to set up a new account; you can use your previous passphrase from movie-web, and all of your data will be there!
## Alternatives
These sites are not related to movie-web but are good enough to switch to if the official instances are down. You can also use [FMHY](https://fmhy.pages.dev/videopiracyguide) to find even more options.
- [watch.lonelil.com](https://watch.lonelil.com)
- [themoviearchive.site](https://themoviearchive.site)
- [braflix.video](https://braflix.video)
- [watch.streamflix.one](https://watch.streamflix.one)

31
pages/proxy/changelog.mdx Normal file
View File

@@ -0,0 +1,31 @@
---
title: 'Changelog'
---
# Version 2.1.3
- Upgrade nitro, which fixes issues on AWS lambda
# Version 2.1.2
- Block more headers, be more anonymous (only works on non-cloudflare platforms)
- Add package version to route `/` for debugging purposes
- Add REQ_DEBUG=true variable to allow for logging all requests made.
- Remove old console.log
# Version 2.1.1
- Fix support for JWT on non-Cloudflare platforms
- Fix header copying logic so User-Agent, Referer and Origin work properly
- Upgrade h3
# Version 2.1.0
- [Added Turnstile integration](2.configuration.md#turnstile_secret) to secure your workers from abuse.
# Version 2.0.1
- Bugfix where sometimes body would double read
- Bugfix where sometimes no response would be given at all due to race condition
# Version 2.0.0
- Full rewrite, now supports multiple platforms: nodejs, Cloudflare, AWS lambda
- Standard proxy headers are no longer sent through. Which now doesn't send a client ip through anymore.

26
pages/proxy/configuration.mdx Normal file
View File

@@ -0,0 +1,26 @@
---
title: 'Configuration'
---
# Proxy Config Reference
Adding environment variables is different for every platform, [here's a guide on how to add environment variables on Cloudflare](https://developers.cloudflare.com/workers/configuration/environment-variables/#add-environment-variables-via-the-dashboard){target="\_blank"}. You'll have to do some research on your own if you aren't hosting the proxy on Cloudflare.
# Reference
### `TURNSTILE_SECRET`
- Type: `string`
- Default: `""`
Turnstile secret key from the [Cloudflare dashboard](https://dash.cloudflare.com/sign-up?to=/:account/turnstile){target="\_blank"}.
::alert{type="warning"}
Keep in mind that you will also need to [configure the Turnstile key on the client](../3.client/3.configuration.md#vite_turnstile_key) and **configure the [`JWT_SECRET`](#jwt_secret) below.**
::
### `JWT_SECRET`
- Type: `string`
- Default: `""`
A [JWT](https://jwt.io/) secret key. This can be any random secret, but **must be 32 characters long.**

104
pages/proxy/deploy.mdx Normal file
View File

@@ -0,0 +1,104 @@
---
title: 'Deploy'
---
# Deploying the proxy
## Method 1 - Netlify (Easy)
Netlify has a very generous free plan, so you'll be able to host your proxy for free unless you get hundreds of users.
[![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/movie-web/simple-proxy){target="\_blank"}
1. Create a GitHub account at https://github.com/signup if you don't have one already.
1. Click on the `Deploy to Netlify` button above.
1. Authorize Netlify to connect with GitHub by clicking the `Connect to GitHub` button.
1. There should now be a `Save & Deploy` button, click it.
1. Once the deployment is complete, click on the `Get Started` button that pops up, this will redirect you to the dashboard of your site.
1. Click on the only site in the `Sites` section of your dashboard.
1. Find the link of your site near the top of the page, it should look something like `https://<random-words>.netlify.app`. Right click the link, click `Copy link address`. [Now you'll just have to set up the client](../5.extra/1.streaming.md#method-1---self-hosted-proxy)!
## Method 2 - Cloudflare (Easy)
::alert{type="warning"}
The sources showbox and febbox do NOT work with cloudflare. Use a different host if you want those to work.
::
Cloudflare has a generous free plan, so you don't need to pay anything unless you get hundreds of users.
[![Deploy to Cloudflare Workers](https://deploy.workers.cloudflare.com/button)](https://deploy.workers.cloudflare.com/?url=https://github.com/movie-web/simple-proxy){target="\_blank"}
1. Create a GitHub account at https://github.com if you don't have one.
1. Click the `Deploy with workers` button above.
1. Click the `Authorize Workers` button to authorize Cloudflare to talk to GitHub.
1. Authorize Cloudflare Workers in the GitHub page that pops up.
1. Follow the instructions to configure your Cloudflare account. Select `I have an account` if you have a Cloudflare account already, otherwise follow the link to create one.
1. Click the link to [`Workers Dashboard`](https://dash.cloudflare.com/sign-up?to=/:account/workers-and-pages){target="\_blank"} to find your account ID.
1. You can copy your account ID from the URL e.g. https://dash.cloudflare.com/ab7cb454c93987b6343350d4e84c16c7/workers-and-pages/create where `ab7cb454c93987b6343350d4e84c16c7` is the account ID.
1. Paste the account ID into the text box on the original Cloudflare workers page.
1. Click the link to [`My Profile`](https://dash.cloudflare.com/profile/api-tokens){target="\_blank"}, to create an API token.
1. Click `Create Token`.
1. Select `Use template` next to `Edit Cloudflare Workers`.
1. Under `Account Resources`, select `Include` and your account under the dropdown.
1. Under `Zone Resources`, select `All zones` (You can select a more specific zone if you have the zones available).
1. At the bottom of the page, click `Continue to summary`.
1. On the next screen, click `Create token`.
1. Copy the API token and **save it in a safe place, it won't be shown again**.
1. Paste the API token into the Cloudflare Workers API Token text box.
1. Click `Fork the Repository` and follow the instructions to enable workflows.
1. Click `Deploy` to deploy to Cloudflare Workers.
1. Congratulations! Your worker is now deploying. Please wait for the GitHub Action to build and publish your worker.
1. You can click the [`Worker dash`](https://dash.cloudflare.com/sign-up?to=/:account/workers-and-pages){target="\_blank"} and `GitHub repo` buttons to see the status of the deploy.
1. When the worker has deployed, you will need to take note of the URL. This can be found on Cloudflare under [Workers and Pages -> Overview](https://dash.cloudflare.com/sign-up?to=/:account/workers-and-pages){target="\_blank"} -> Proxy.
1. Use the URL you took note of and [set up a custom proxy in the client](../5.extra/1.streaming.md#method-1---self-hosted-proxy).
## Method 2 - Cloudflare (Manual)
::alert{type="warning"}
The sources showbox and febbox do NOT work with cloudflare. Use a different host if you want those to work.
::
1. Login to your Cloudflare account if you have one, otherwise create one [here](https://dash.cloudflare.com/sign-up?to=/:account/workers-and-pages)
1. If you are signing up for an account, make sure to verify your email before going further!
1. Download the latest version of the Cloudflare [`simple-proxy-cloudflare.mjs` script from here](https://github.com/movie-web/simple-proxy/releases/latest/download/simple-proxy-cloudflare.mjs).
1. Go to `Workers & Pages` and then `Overview` in the left-hand navigation bar.
1. Click the `Create Worker` button
1. If you've made a worker or pages application before, you will need to click `Create Application` first
1. Give your worker a name and click `Deploy`. This can be anything you would like!
1. On the `Congratulations` web page, click the `Edit code` button to edit the code in the worker you have just created.
1. There should now be a code editor on the left hand side on the web page.
1. Select all of the existing template code and delete it. **You must make sure all of the code is deleted for this to work!**
1. Go to your downloads folder and open up the `simple-proxy-cloudflare.mjs` file you downloaded earlier in a text editor, and **copy** the contents.
1. Back in your browser, paste the contents of the file into the code editor.
1. The `Save and deploy` button in the top right corner should now be active, click it to deploy your proxy!
1. A confirmation dialog will appear, click `Save and deploy` once more.
1. Your worker is now deployed! You can click the back button in the top left to take you back to the summary screen.
1. On the summary screen, your worker link will be displayed under `Preview`. Right click the link, click `Copy link address` and save the link somewhere - [you will need it to set up the client](../5.extra/1.streaming.md#method-1---self-hosted-proxy)!
## Method 3 - Railway (Easy)
Railway offers you $5 of credit once you verify your account, which is enough to run the proxy for around 5-7 months.
[![Deploy on Railway](https://railway.app/button.svg)](https://railway.app/template/dyYHq1)
1. Login to your [Railway](https://railway.app) account if you have one, otherwise create one [here](https://railway.app/login).
1. If you are signing up, then verify your account by clicking the link in the email Railway sends you.
1. If you created your account with an email, then to verify your account further, go to your account, then plans and verify your account with a GitHub account.
1. Click the [`Deploy on Railway`](https://railway.app/template/dyYHq1) button above.
1. If a `Configure` button is displayed, click on it and allow Railway to access your GitHub account.
1. The `Deploy` button at the bottom of the template should be active, click on it.
1. Once the proxy has deployed, copy the URL from the `Deployments` page.
1. Congratulations! You have deployed the proxy, [you can now set up the client](../5.extra/1.streaming.md#method-1---self-hosted-proxy).
## Method 4 - Docker
::alert{type="warning"}
Experience with Docker, domains and web hosting is **highly recommended** for this method. <br />
[Deploying with Netlify](#method-1-netlify-easy) is easier and safer to do! You are exposing your server at your own risk!
::
Our `simple-proxy` application is available from the GitHub Container Registry under the image [`ghcr.io/movie-web/simple-proxy:latest`](https://ghcr.io/movie-web/simple-proxy:latest){target="\_blank"} :copy-button{content="ghcr.io/movie-web/simple-proxy:latest"}
The container exposes the HTTP port (Without TLS/SSL) as `3000/TCP`.
If you know what you are doing, you should know what to do with this information. If you don't, then please follow our Cloudflare guides.

11
pages/proxy/introduction.mdx Normal file
View File

@@ -0,0 +1,11 @@
---
title: 'Introduction'
---
# Introduction to the proxy
Our proxy is used to bypass CORS-protected URLs on the client side, allowing users to make requests to CORS protected endpoints without a backend server.
The proxy is made using [Nitro by UnJS](https://nitro.unjs.io/) which supports building the proxy to work on multiple providers including Cloudflare Workers, AWS Lambda and [more...](https://nitro.unjs.io/deploy)
Our recommended provider is Netlify due to its [generous free plan](https://www.netlify.com/pricing/#core-pricing-table).

23
pages/self-hosting/about-pwa.mdx Normal file
View File

@@ -0,0 +1,23 @@
---
title: 'PWA vs no-PWA'
---
# About Self-hosting PWA
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).
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
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.
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).
## 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 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!

36
pages/self-hosting/hosting-intro.mdx Normal file
View File

@@ -0,0 +1,36 @@
---
title: 'Start self-hosting'
---
# How to self-host
::alert{type="info"}
We provide support on a case-by-case basis. If you have any questions, feel free to ask in our [Discord server](https://movie-web.github.io/links/discord).
::
Since movie-web has many different components, there are a few configurations of how you can host it. Each of these configurations has their own benefits, whether that be having complete control over your data or customizing your experience.
**If you don't know what to choose, go with [method 1.](#method-1---only-host-the-frontend)**
## Method 1 - Only host the frontend
With this method, you only host the essential parts that make movie-web work. But keep using the account server from official movie-web.
This method is the easiest to self-host and is recommended for most users.
1. [Set up the Proxy!](../2.proxy/1.deploy.md)
2. [Set up the Client!](../3.client/1.deploy.md)
## Method 2 - Only host the account server
If you want to own your own data, it's possible to self-host just the account server and nothing else.
This method is only recommended if you have experience hosting databases or other similar stateful applications.
1. [Set up the Backend!](../4.backend/1.deploy.md)
2. [Configure the Client!](../3.client/1.deploy.md)
## Method 3 - Host everything
If you want an instance that's completely isolated from the official movie-web. You can self-host all of the parts yourself, though this method is not recommended for inexperienced hosters.
1. [Set up the Proxy!](../2.proxy/1.deploy.md)
2. [Set up the Backend!](../4.backend/1.deploy.md)
3. [Set up the Client!](../3.client/1.deploy.md)

45
pages/self-hosting/troubleshooting.mdx Normal file
View File

@@ -0,0 +1,45 @@
---
title: 'Troubleshooting'
---
# Troubleshooting
There is always a possibility for something to go wrong while trying to deploy your own instance of movie-web. This page will contain common issues people have come across while self-hosting and their solutions.
## "Failed to find media, try again!" while searching
**This is likely a misconfigured TMDB API key.** To verify that TMDB is the issue, visit `/admin` or `/#/admin` and click on the `Test TMDB` button.
If the test succeeds, then your TMDB configuration is correct and the issue is with something else.
If the test fails, then you should recheck your credentials. [**Make sure you're using the Read Access Token, not the normal API Key.**](https://www.themoviedb.org/settings/api#v4_auth_key){target="\_blank"}
## Everything I try to watch fails
**This is likely a misconfigured Worker.** To make sure that the Workers are the issue, visit `/admin` or `/#/admin`, then click on the `Test workers` button.
You should have at least 1 Worker registered, if you don't, you should [deploy a worker](../2.proxy/1.deploy.md#method-1---cloudflare-easy) and [set it up in the client](../3.client/3.configuration.md#vite_cors_proxy_url).
If any Worker fails the test, you should double check its URL and see if its up to date with the latest updates.
## I can't make an account or login
**This is likely misconfigured or broken backend.** To verify that the backend is the issue, visit `/admin` or `/#/admin`, then click on the `Test backend` button.
If the backend is online and properly configured it should display the name and version of the backend. If the name and description of the test don't match your own instance, [make sure you have your backend URL set correctly.](../3.client/3.configuration.md#vite_backend_url)
If the test gives you an error, your [backend URL configuration option](../3.client/3.configuration.md#vite_backend_url) likely has a typo.
If the version that shows up on your backend is not the latest version, you should update your backend to keep up with the latest changes.
## I updated from version 3 to version 4 but I still see the old version
It is likely that you haven't installed the PWA version of movie-web. Please read the [upgrade guide](../3.client/5.upgrade.md) for more details on the matter.
## I'm getting SSL issues when using a hosted postgres database
You are most likely missing the [`postgres.ssl`](../4.backend/2.configuration.md#postgresssl) variable on your backend, enable it and the connection should work.
## Permission denied to set parameter "session_replication_role"
Set the `MIKRO_ORM_MIGRATIONS_DISABLE_FOREIGN_KEYS` option to `false` in either your `.env` or your Docker command.

16
pages/self-hosting/use-backend.mdx Normal file
View File

@@ -0,0 +1,16 @@
---
title: 'Configure backend'
---
# Configure your client with the backend
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 in case you need to go back!
::
1. On movie-web, click the menu icon at the top right and then `Settings`.
1. Scroll down the page to the `Connections` section.
1. Enable the `Custom server` toggle and enter your backend URL in the input box that appears.
1. Click `Save` at the bottom right corner of your screen.