mirror of https://github.com/sussy-code/docs.git
refactor docs to sudo-docs!
This commit is contained in:
Captain Jack Sparrow
parent
1f26b7bd82
commit
a60fd07199
|
|
@ -1 +1,2 @@
|
|||
* @movie-web/project-leads
|
||||
* Maintainers: [MW-Exodus Team](https://github.com/MW-Legacy)
|
||||
* Founder: (sussy-code)[https://github.com/sussy-code]
|
||||
|
|
|
|||
|
|
@ -1 +1 @@
|
|||
Please visit the [main document at primary repository](https://github.com/movie-web/movie-web/blob/dev/.github/CODE_OF_CONDUCT.md).
|
||||
Please visit the [main document at primary repository](https://github.com/sussy-code/smov/blob/dev/.github/CODE_OF_CONDUCT.md).
|
||||
|
|
|
|||
|
|
@ -1 +1 @@
|
|||
Please visit the [main document at primary repository](https://github.com/movie-web/movie-web/blob/dev/.github/CONTRIBUTING.md).
|
||||
Please visit the [main document at primary repository](https://github.com/sussy-code/smov/blob/dev/.github/CONTRIBUTING.md).
|
||||
|
|
|
|||
2
LICENSE
2
LICENSE
|
|
@ -1,6 +1,6 @@
|
|||
MIT License
|
||||
|
||||
Copyright (c) 2023 movie-web
|
||||
Copyright (c) 2023 sudo-flix
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
# movie-web docs
|
||||
# sudo-flix docs
|
||||
|
||||
Find it at https://movie-web.github.io/docs
|
||||
Find it at https://sussy-code.github.io/docs
|
||||
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ import logoUrl from '../public/icon-light.png';
|
|||
export function Logo() {
|
||||
return (
|
||||
<Link href="/" className={classes.logo}>
|
||||
<img src={logoUrl.src} alt="Logo of movie-web" />
|
||||
<img src={logoUrl.src} alt="Logo of sudo-flix" />
|
||||
</Link>
|
||||
);
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,11 +1,11 @@
|
|||
{
|
||||
"name": "movie-web-docs",
|
||||
"name": "sudo-flix-docs",
|
||||
"version": "0.2.0",
|
||||
"lockfileVersion": 2,
|
||||
"requires": true,
|
||||
"packages": {
|
||||
"": {
|
||||
"name": "movie-web-docs",
|
||||
"name": "sudo-flix-docs",
|
||||
"version": "0.2.0",
|
||||
"dependencies": {
|
||||
"@neato/guider": "^1.0.1",
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
{
|
||||
"name": "movie-web-docs",
|
||||
"name": "sudo-flix-docs",
|
||||
"version": "0.2.0",
|
||||
"private": true,
|
||||
"scripts": {
|
||||
|
|
|
|||
|
|
@ -58,7 +58,7 @@ Port number that the HTTP server listens on.
|
|||
|
||||
- Type: `string`
|
||||
- Default: `""`
|
||||
- Example: `"https://movie-web.app https://testing.movie-web.app"`
|
||||
- Example: `"https://sudo-flix.lol https://testing.sudo-flix.app"`
|
||||
|
||||
Space separated list of allowed origins.
|
||||
|
||||
|
|
@ -170,7 +170,7 @@ These options configure how the server will display itself to the frontend.
|
|||
### `meta.name` ⚠
|
||||
|
||||
- Type: `string`
|
||||
- Example: `"Unofficial movie-web"`
|
||||
- Example: `"Unofficial sudo-flix"`
|
||||
|
||||
The name of the backend instance, this will be displayed to users who try to create an account.
|
||||
|
||||
|
|
@ -182,7 +182,7 @@ The name of the backend instance, this will be displayed to users who try to cre
|
|||
|
||||
- Type: `string`
|
||||
- Default: `""`
|
||||
- Example: `"This is not an official instance of movie-web"`
|
||||
- Example: `"This is not an official instance of sudo-flix"`
|
||||
|
||||
The description of the backend instance, this will be displayed to users who try to create an account.
|
||||
|
||||
|
|
|
|||
|
|
@ -37,14 +37,14 @@ This method provides a straightforward setup with minimal configuration. For mor
|
|||
ports:
|
||||
- "5432:5432"
|
||||
networks:
|
||||
- movie-web-network
|
||||
- sudo-flix-network
|
||||
|
||||
movie-web:
|
||||
image: ghcr.io/movie-web/backend:latest
|
||||
sudo-flix:
|
||||
image: ghcr.io/sudo-flix/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_META__NAME: unofficial-sudo-flix
|
||||
MWB_POSTGRES__MIGRATE_ON_BOOT: "true"
|
||||
MIKRO_ORM_MIGRATIONS_DISABLE_FOREIGN_KEYS: "true"
|
||||
ports:
|
||||
|
|
@ -52,10 +52,10 @@ This method provides a straightforward setup with minimal configuration. For mor
|
|||
depends_on:
|
||||
- postgres
|
||||
networks:
|
||||
- movie-web-network
|
||||
- sudo-flix-network
|
||||
|
||||
networks:
|
||||
movie-web-network:
|
||||
sudo-flix-network:
|
||||
driver: bridge
|
||||
```
|
||||
|
||||
|
|
|
|||
|
|
@ -8,8 +8,7 @@ The backend is essentially just an account server. It handles user accounts, syn
|
|||
|
||||
## 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!
|
||||
I recommend using the [sudo-backend](https://backend.sudo-flix.lol)!
|
||||
|
||||
## Metrics
|
||||
|
||||
|
|
|
|||
|
|
@ -123,11 +123,11 @@ title: 'Changelog'
|
|||
|
||||
# Version 4.3.0
|
||||
|
||||
- Add onboarding process to movie-web, triggable manually through settings. This needs to be turned when selfhosting.
|
||||
- Add onboarding process to sudo-flix, 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
|
||||
- Added extension support, run sudo-flix 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
|
||||
|
|
@ -272,8 +272,8 @@ If you are upgrading from a previous version, make sure to read [the upgrade gui
|
|||
|
||||
- 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.
|
||||
- Visit `/s/:term` to quickly watch something. For example `https://sudo-flix.lol/s/hamilton`.
|
||||
- You can now add sudo-flix 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.
|
||||
|
|
|
|||
|
|
@ -4,22 +4,22 @@ 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:
|
||||
The config for the sudo-flix can be provided in 2 different ways, depending on how you are hosting sudo-flix:
|
||||
|
||||
- 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).
|
||||
- If you are hosting sudo-flix 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!
|
||||
The sudo-flix client can be configured using environment variables **at build time**. You cannot use this method if hosting the pre-built `sudo-flix.zip` files!
|
||||
|
||||
Using environment variables to configure movie-web also allows configuration of some [environment variable specific keys](#config-reference-environment-variables-only).
|
||||
Using environment variables to configure sudo-flix 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.
|
||||
When using the pre-built `sudo-flix.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:
|
||||
|
||||
|
|
@ -36,7 +36,7 @@ window.__CONFIG__ = {
|
|||
- 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](./tmdb.mdx).
|
||||
This is the **read** API key from TMDB to allow sudo-flix to search for media. [Get one by following our guide](./tmdb.mdx).
|
||||
|
||||
<Caution>
|
||||
**Required. The client will not work properly if this is not configured.**
|
||||
|
|
@ -85,9 +85,9 @@ Setting this configuration value to `true` will enable the history-router.
|
|||
- Default: `""`
|
||||
- Example: `"https://backend.example.com"`
|
||||
|
||||
This is the URL for the movie-web backend server which handles cross-device syncing.
|
||||
This is the URL for the sudo-flix 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/) image for deployment.
|
||||
The backend server can be found at https://github.com/sussy-code/backend and is offered as a [Docker](https://docs.docker.com/get-started/overview/) image for deployment.
|
||||
|
||||
Backend URL must **not** end with a slash.
|
||||
|
||||
|
|
@ -101,7 +101,7 @@ If you want your users to be prompted with an onboarding screen before they star
|
|||
### `VITE_ONBOARDING_CHROME_EXTENSION_INSTALL_LINK`
|
||||
|
||||
- Type: `string`
|
||||
- Default: `"https://chromewebstore.google.com/detail/movie-web-extension/hoffoikpiofojilgpofjhnkkamfnnhmm"`
|
||||
- Default: `"https://chromewebstore.google.com/detail/sudo-flix-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.
|
||||
|
|
@ -111,7 +111,7 @@ If omitted, this will still show the extension onboarding screen, just without a
|
|||
### `VITE_ONBOARDING_FIREFOX_EXTENSION_INSTALL_LINK`
|
||||
|
||||
- Type: `string`
|
||||
- Default: `"https://addons.mozilla.org/en-GB/firefox/addon/movie-web-extension"`
|
||||
- Default: `"https://addons.mozilla.org/en-GB/firefox/addon/sudo-flix-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.
|
||||
|
|
@ -198,7 +198,7 @@ The Google Analytics ID for tracking user behavior. If omitted, no tracking will
|
|||
|
||||
- Type: `string`
|
||||
- Default: `""`
|
||||
- Example: `"https://movie-web.app"`
|
||||
- Example: `"https://sudo-flix.lol"`
|
||||
|
||||
The domain where the app lives. Only required when having the [`VITE_OPENSEARCH_ENABLED`](#vite-opensearch-enabled) option enabled.
|
||||
|
||||
|
|
|
|||
|
|
@ -6,13 +6,13 @@ title: 'Deploy'
|
|||
|
||||
## Method 1 - Vercel - Recommended
|
||||
|
||||
1. Click [here](https://github.com/movie-web/movie-web/fork) to fork the movie-web Github repository
|
||||
1. Click [here](https://github.com/sussy-code/smov/fork) to fork the sudo-flix Github repository
|
||||
1. Click [here](https://vercel.com/) to go to Vercel
|
||||
1. Sign in using either a GitHub, GitLab, or Bitbucket.
|
||||
1. Clicking the "New Project" button on the top right of your dashboard and following the steps to create a new project for your self hosted version of movie web.
|
||||
1. After clicking it, you'll be presented with a list of Git repositories that the Git account you've signed up with has write access to.
|
||||
|
||||
1. Select your own fork of the movie-web Github repository.
|
||||
|
||||
1. Select your own fork of the sudo-flix Github repository.
|
||||
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.
|
||||
|
|
@ -22,14 +22,14 @@ title: 'Deploy'
|
|||
- `VITE_TMDB_READ_API_KEY`: Enter your TMDB Read Access Token here. Please read [the TMDB page](./tmdb.mdx) 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](../client/configuration.mdx) 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. Congrats! You have your own version of sudo-flix 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.
|
||||
1. Download the file `sudo-flix.zip` from the latest release: https://github.com/sussy-code/smov/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.
|
||||
|
|
@ -44,13 +44,13 @@ title: 'Deploy'
|
|||
- Netlify
|
||||
- Vercel
|
||||
- Etc, [there are lots of options](https://www.staticwebsitehosting.org/).
|
||||
9. Congrats! You have your own version of movie-web hosted.
|
||||
9. Congrats! You have your own version of sudo-flix 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.
|
||||
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 sudo-flix 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.
|
||||
1. Ensure you have [docker](https://docs.docker.com/get-docker/) installed. In a newly created directory called `sudo-flix` create a file called `docker-compose.yaml`. Paste the contents of the code block below into this file.
|
||||
|
||||
```yaml
|
||||
version: "3.8"
|
||||
|
|
@ -59,7 +59,7 @@ services:
|
|||
|
||||
movieweb:
|
||||
build:
|
||||
context: https://github.com/movie-web/movie-web.git
|
||||
context: https://github.com/sussy-code/smov.git
|
||||
# args:
|
||||
# TMDB_READ_API_KEY: ""
|
||||
# CORS_PROXY_URL: ""
|
||||
|
|
@ -82,12 +82,12 @@ services:
|
|||
7. Now use [docker](https://docs.docker.com/get-docker/) to run `movieweb` as background service.
|
||||
|
||||
```bash
|
||||
# movie-web is the current working directory
|
||||
# sudo-flix 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.
|
||||
- Navigate to `http://localhost`. You should see the UI for `sudo-flix`. Find something to watch and make sure that it plays.
|
||||
- View logs with
|
||||
|
||||
```bash
|
||||
|
|
@ -103,7 +103,7 @@ $ docker compose up --detach
|
|||
|
||||
### To Perform Updates For New Releases of Movie Web
|
||||
|
||||
1. Make sure `movie-web` is your current working directory and run:
|
||||
1. Make sure `sudo-flix` is your current working directory and run:
|
||||
|
||||
```bash
|
||||
# Re-build the image and start the container
|
||||
|
|
|
|||
|
|
@ -16,7 +16,7 @@ To do this, you will need to follow the guide below...
|
|||
|
||||
<Steps>
|
||||
<Steps.Step>
|
||||
If you have not already, click [here](https://github.com/movie-web/movie-web/fork) to fork the movie-web Github repository.
|
||||
If you have not already, click [here](https://github.com/sussy-code/smov/fork) to fork the sudo-flix Github repository.
|
||||
</Steps.Step>
|
||||
<Steps.Step>
|
||||
Paste the below file into your repository's root `/.github/workflows` directory
|
||||
|
|
@ -63,10 +63,10 @@ Your instance should now be automatically updated to the latest version.
|
|||
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
|
||||
git remote add sudo-flix https://github.com/sussy-code/smov.git
|
||||
git fetch sudo-flix
|
||||
# Change `dev` to `master` if you want a stable experience
|
||||
git merge movie-web/dev --allow-unrelated-histories
|
||||
git merge sudo-flix/dev --allow-unrelated-histories
|
||||
git push -f # Force push to your origin main branch
|
||||
```
|
||||
|
||||
|
|
@ -76,6 +76,6 @@ git push -f # Force push to your origin main branch
|
|||
|
||||
You will need the latest version of the proxy worker. Redeploy a new worker using [our self-hosting guide](../proxy/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.
|
||||
After you have the new worker, you will need to [get the new sudo-flix deployment files](https://github.com/sussy-code/smov/releases/latest). **You CANNOT use the non-PWA version**. To upgrade safely without any complications, you need to update with `sudo-flix.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.
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
### Guide to full Self-Deployment of movie-web with Docker Compose
|
||||
### Guide to full Self-Deployment of sudo-flix with Docker Compose
|
||||
|
||||
1. **Install Docker and Docker Compose:**
|
||||
|
||||
|
|
@ -21,10 +21,10 @@
|
|||
POSTGRES_DB: movie_web_backend
|
||||
POSTGRES_PASSWORD: YourPasswordHere
|
||||
networks:
|
||||
- movie-web-network
|
||||
- sudo-flix-network
|
||||
|
||||
movie-web-backend:
|
||||
image: ghcr.io/movie-web/backend:latest
|
||||
sudo-flix-backend:
|
||||
image: ghcr.io/sudo-flix/backend:latest
|
||||
restart: unless-stopped
|
||||
environment:
|
||||
MWB_SERVER__CORS: "https://movie-backend.example.tld https://movie.example.tld"
|
||||
|
|
@ -43,11 +43,11 @@
|
|||
depends_on:
|
||||
- postgres
|
||||
networks:
|
||||
- movie-web-network
|
||||
- sudo-flix-network
|
||||
|
||||
movie-web-frontend:
|
||||
sudo-flix-frontend:
|
||||
build:
|
||||
context: https://github.com/movie-web/movie-web.git
|
||||
context: https://github.com/sussy-code/smov.git
|
||||
args:
|
||||
TMDB_READ_API_KEY: "YourTMDBReadAPIKeyHere"
|
||||
CORS_PROXY_URL: "https://cors.example.tld https://second.cors.example.tld"
|
||||
|
|
@ -60,26 +60,26 @@
|
|||
ports:
|
||||
- "80:80"
|
||||
networks:
|
||||
- movie-web-network
|
||||
- sudo-flix-network
|
||||
restart: unless-stopped
|
||||
|
||||
movie-web-proxy:
|
||||
image: ghcr.io/movie-web/simple-proxy:latest
|
||||
sudo-flix-proxy:
|
||||
image: ghcr.io/sudo-flix/simple-proxy:latest
|
||||
ports:
|
||||
- "3000:3000"
|
||||
networks:
|
||||
- movie-web-network
|
||||
- sudo-flix-network
|
||||
restart: unless-stopped
|
||||
|
||||
networks:
|
||||
movie-web-network:
|
||||
sudo-flix-network:
|
||||
driver: bridge
|
||||
```
|
||||
**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](../client/tmdb.mdx).
|
||||
* replace `yourDomainHere` with whatever you'll be using to access your main site, like movie-web.app
|
||||
* replace `yourDomainHere` with whatever you'll be using to access your main site, like sudo-flix.app
|
||||
* replace `meta__name` and `meta__description`
|
||||
2. **Start the Backend:** Open a terminal in the directory containing `docker-compose.yml` and execute:
|
||||
|
||||
|
|
|
|||
|
|
@ -4,13 +4,13 @@ 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.
|
||||
This page explains all the different ways you can enable sudo-flix 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].
|
||||
The sudo-flix 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.
|
||||
This method is great if you only use sudo-flix 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.
|
||||
*/}
|
||||
|
|
@ -21,10 +21,10 @@ Self-hosting a proxy is an easy way to get faster streaming speeds, [we have a g
|
|||
|
||||
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.*/}
|
||||
{/* This method is recommended if you want to host a proxy for your friends and family to use, or if you want to use sudo-flix 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](../proxy/deploy.mdx), [though we recommend Netlify](../proxy/deploy.mdx#method-1-netlify-easy).
|
||||
2. Once that's done, go to the **Connections** section of the **Settings page** on your movie-web instance of choice.
|
||||
2. Once that's done, go to the **Connections** section of the **Settings page** on your sudo-flix instance of choice.
|
||||
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.
|
||||
|
|
@ -36,7 +36,7 @@ If you're self-hosting the client, you can use the [`VITE_CORS_PROXY_URL`](../cl
|
|||
|
||||
## 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.
|
||||
The public proxy is the easiest way to get started with sudo-flix 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.
|
||||
|
||||
|
|
|
|||
|
|
@ -10,14 +10,14 @@ export default function LandingPage() {
|
|||
return (
|
||||
<GuiderLayout meta={{ layout: 'page' }}>
|
||||
<Hero>
|
||||
<Hero.Title>movie-web</Hero.Title>
|
||||
<Hero.Title>sudo-flix</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">
|
||||
<Button to="https://github.com/sussy-code/smov" type="secondary">
|
||||
Open on GitHub →
|
||||
</Button>
|
||||
</Hero.Actions>
|
||||
|
|
@ -27,7 +27,7 @@ export default function LandingPage() {
|
|||
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.
|
||||
sudo-flix 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,
|
||||
|
|
@ -46,7 +46,7 @@ export default function LandingPage() {
|
|||
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
|
||||
Mix and match different parts of the sudo-flix service, host your
|
||||
backend or use ours, it'll work either way.
|
||||
</Card>
|
||||
<Card icon="mdi:flag" title="Multiple Languages">
|
||||
|
|
|
|||
|
|
@ -4,45 +4,7 @@ title: 'Instances'
|
|||
|
||||
# Instances
|
||||
|
||||
This page showcases movie-web instances hosted by the community and other alternative sites.
|
||||
This page showcases sudo-flix instances hosted by the community and other alternative sites.
|
||||
|
||||
## Community Instances
|
||||
|
||||
The community maintains these trusted instances, which are likely to be up-to-date. Remember that since these are volunteer instances, they might be down or stop working anytime. If you want to be sure you have access to movie-web, consider [hosting your own instance](../self-hosting/hosting-intro.mdx).
|
||||
|
||||
**Instances marked with a 💾 have set up a backend, making it possible to sync your data across multiple devices.**
|
||||
|
||||
**Additionally, instances with a 🌐 use the community backend hosted by Lonelil, which has all the original movie-web.app data!**
|
||||
|
||||
**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.ru](https://mw.lonelil.ru) | [lonelil - Partner](https://github.com/lonelil) | 💾🌐📱 |
|
||||
| [watch.qtchaos.de](https://watch.qtchaos.de) | [chaos - Project Lead](https://github.com/qtchaos) | 💾📱 |
|
||||
| [bmov.app](https://bmov.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 - Contributor](https://github.com/sussy-code) | 💾📱 |
|
||||
| [movie-web.x](https://movie-web.x) | [Unstoppable Domains](https://unstoppabledomains.com) and [IPFS](https://ipfs.tech) | 💾 |
|
||||
|
||||
<Note>
|
||||
[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)
|
||||
</Note>
|
||||
|
||||
## 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.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.ru](https://watch.lonelil.ru)
|
||||
- [themoviearchive.site](https://themoviearchive.site)
|
||||
- [braflix.video](https://braflix.video)
|
||||
- [watch.streamflix.one](https://watch.streamflix.one)
|
||||
- [sudo-flix.lol](https://sudo-flix.lol)
|
||||
- [kanded.xyz](https://flix.kanded.xyz)
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ title: 'Deploy'
|
|||
|
||||
Netlify has a very generous free plan, so you'll be able to host your proxy for free unless you get hundreds of users.
|
||||
|
||||
[](https://app.netlify.com/start/deploy?repository=https://github.com/movie-web/simple-proxy)
|
||||
[](https://app.netlify.com/start/deploy?repository=https://github.com/sussy-code/simple-proxy)
|
||||
|
||||
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.
|
||||
|
|
@ -26,7 +26,7 @@ The sources showbox and febbox do NOT work with cloudflare. Use a different host
|
|||
|
||||
Cloudflare has a generous free plan, so you don't need to pay anything unless you get hundreds of users.
|
||||
|
||||
[](https://deploy.workers.cloudflare.com/?url=https://github.com/movie-web/simple-proxy)
|
||||
[](https://deploy.workers.cloudflare.com/?url=https://github.com/sussy-code/simple-proxy)
|
||||
|
||||
1. Create a GitHub account at https://github.com if you don't have one.
|
||||
1. Click the `Deploy with workers` button above.
|
||||
|
|
@ -60,7 +60,7 @@ The sources showbox and febbox do NOT work with cloudflare. Use a different host
|
|||
|
||||
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. Download the latest version of the Cloudflare [`simple-proxy-cloudflare.mjs` script from here](https://github.com/sussy-code/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
|
||||
|
|
@ -97,7 +97,7 @@ Experience with Docker, domains and web hosting is **highly recommended** for th
|
|||
[Deploying with Netlify](#method-1-netlify-easy) is easier and safer to do! You are exposing your server at your own risk!
|
||||
</Warning>
|
||||
|
||||
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)
|
||||
Our `simple-proxy` application is available from the GitHub Container Registry under the image [`ghcr.io/sudo-flix/simple-proxy:latest`](https://ghcr.io/sudo-flix/simple-proxy:latest)
|
||||
|
||||
The container exposes the HTTP port (Without TLS/SSL) as `3000/TCP`.
|
||||
|
||||
|
|
|
|||
|
|
@ -4,20 +4,20 @@ 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).
|
||||
So that clients can have a more native app-like experience on mobile, sudo-flix 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](../client/upgrade.mdx) for more information.
|
||||
In sudo-flix 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 sudo-flix version 4. If you are upgrading from version 3, please [read our upgrade guide](../client/upgrade.mdx) for more information.
|
||||
|
||||
<Warning>
|
||||
Enabling PWAs means that you cannot disable it again - Please only proceed if you know what you are doing!
|
||||
</Warning>
|
||||
|
||||
## If you are running movie-web on a hosting platform such as Vercel
|
||||
## If you are running sudo-flix 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`](../client/configuration.mdx#vite-pwa-enabled) environment variable.
|
||||
If your hosting is building sudo-flix from the source, you can enable PWAs using the [`VITE_PWA_ENABLED`](../client/configuration.mdx#vite-pwa-enabled) environment variable.
|
||||
|
||||
Setting [`VITE_PWA_ENABLED`](../client/configuration.mdx#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 running sudo-flix 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!
|
||||
If you are downloading the sudo-flix `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 [`sudo-flix.pwa.zip`](https://github.com/sussy-code/smov/releases/latest/download/sudo-flix.pwa.zip) file instead of the `sudo-flix.zip` file!
|
||||
|
|
|
|||
|
|
@ -5,15 +5,15 @@ title: 'Start self-hosting'
|
|||
# How to self-host
|
||||
|
||||
<Note>
|
||||
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).
|
||||
We provide support on a case-by-case basis. If you have any questions, feel free to ask in our [Discord server](https://discord.gg/9vmr6vBQKS).
|
||||
</Note>
|
||||
|
||||
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.
|
||||
Since sudo-flix 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.
|
||||
With this method, you only host the essential parts that make sudo-flix work. But keep using the account server from official sudo-flix.
|
||||
This method is the easiest to self-host and is recommended for most users.
|
||||
|
||||
1. [Set up the Proxy!](../proxy/deploy.mdx)
|
||||
|
|
@ -29,7 +29,7 @@ This method is only recommended if you have experience hosting databases or othe
|
|||
|
||||
## 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.
|
||||
If you want an instance that's completely isolated from the official sudo-flix. You can self-host all of the parts yourself, though this method is not recommended for inexperienced hosters.
|
||||
|
||||
1. [Set up the Proxy!](../proxy/deploy.mdx)
|
||||
2. [Set up the Backend!](../backend/deploy.mdx)
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ 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.
|
||||
There is always a possibility for something to go wrong while trying to deploy your own instance of sudo-flix. This page will contain common issues people have come across while self-hosting and their solutions.
|
||||
|
||||
## "Failed to find media, try again!" while searching
|
||||
|
||||
|
|
@ -34,7 +34,7 @@ If the version that shows up on your backend is not the latest version, you shou
|
|||
|
||||
## 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](../client/upgrade.mdx) for more details on the matter.
|
||||
It is likely that you haven't installed the PWA version of sudo-flix. Please read the [upgrade guide](../client/upgrade.mdx) for more details on the matter.
|
||||
|
||||
## I'm getting SSL issues when using a hosted postgres database
|
||||
|
||||
|
|
|
|||
|
|
@ -4,13 +4,13 @@ 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!**
|
||||
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 sudo-flix frontend!**
|
||||
|
||||
<Caution>
|
||||
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!
|
||||
</Caution>
|
||||
|
||||
1. On movie-web, click the menu icon at the top right and then `Settings`.
|
||||
1. On sudo-flix, 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.
|
||||
|
|
|
|||
Binary file not shown.
|
Before Width: | Height: | Size: 28 KiB After Width: | Height: | Size: 80 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 27 KiB After Width: | Height: | Size: 75 KiB |
|
|
@ -5,25 +5,25 @@ import coverUrl from "./public/cover.png";
|
|||
import faviconUrl from "./public/favicon.ico";
|
||||
|
||||
export default defineTheme({
|
||||
github: "movie-web/movie-web",
|
||||
github: "sussy-code/smov",
|
||||
contentFooter: {
|
||||
text: "Made with 💜",
|
||||
editRepositoryBase: "https://github.com/movie-web/docs/blob/master",
|
||||
text: "Made with :3 (sillyness)",
|
||||
editRepositoryBase: "https://github.com/sussy-code/docs/blob/master",
|
||||
socials: [
|
||||
social.github("https://github.com/movie-web"),
|
||||
social.discord("https://movie-web.github.io/links/discord"),
|
||||
social.github("https://github.com/sussy-code"),
|
||||
social.discord("https://discord.gg/9vmr6vBQKS"),
|
||||
]
|
||||
},
|
||||
meta: (pageMeta) => (
|
||||
<NextSeo {...{
|
||||
title: `${pageMeta.title ?? "For all your movie and TV show needs"} | movie-web`,
|
||||
description: pageMeta.description ?? "movie-web is a free and open source streaming site, no ads, no tracking, no nonsense.",
|
||||
title: `${pageMeta.title ?? "Watch your favorite shows and movies for free with no ads ever! (っ'ヮ'c)"} | sudo-flix`,
|
||||
description: pageMeta.description ?? "sudo-flix is a free and open source streaming site, no ads, no tracking, no nonsense.",
|
||||
openGraph: {
|
||||
images: [{
|
||||
url: coverUrl.src,
|
||||
}],
|
||||
title: `${pageMeta.title ?? "For all your movie and TV show needs"} | movie-web`,
|
||||
description: pageMeta.description ?? "movie-web is a free and open source streaming site, no ads, no tracking, no nonsense.",
|
||||
title: `${pageMeta.title ?? "Watch your favorite shows and movies for free with no ads ever! (っ'ヮ'c)"} | sudo-flix`,
|
||||
description: pageMeta.description ?? "sudo-flix is a free and open source streaming site, no ads, no tracking, no nonsense.",
|
||||
},
|
||||
twitter: {
|
||||
cardType: 'summary_large_image',
|
||||
|
|
|
|||
Loading…
Reference in New Issue