mirror of
https://github.com/movie-web/docs.git
synced 2025-09-13 14:43:27 +00:00
Initial draft
This commit is contained in:
qtchaos
@@ -1,33 +1,36 @@
|
||||
---
|
||||
title: 'Start self-hosting'
|
||||
---
|
||||
|
||||
# How to self host
|
||||
|
||||
::alert{type="info"}
|
||||
We **do not** provide support on how to self-host. If you can't figure it out then tough luck. Please do not make GitHub issues or ask in our Discord server for support on how to self-host.
|
||||
::
|
||||
|
||||
There are a few configurations of hosting movie-web. Each with their own benefits.
|
||||
**If you don't know what to choose, go with method 1.**
|
||||
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 offical movie-web.
|
||||
|
||||
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. [Setup the Proxy!](../2.proxy/1.deploy.md)
|
||||
2. [Setup the Client!](../3.client/1.deploy.md)
|
||||
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 selfhost just the account server and nothing else.
|
||||
This method is only recommended if you have experience hosting databases or other similar stateful applications.
|
||||
|
||||
1. [Setup the Backend!](../4.backend/1.deploy.md)
|
||||
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 official movie-web. You can selfhost all parts.
|
||||
This method is not recommended for inexperienced hosters.
|
||||
|
||||
1. [Setup the Proxy!](../2.proxy/1.deploy.md)
|
||||
2. [Setup the Backend!](../4.backend/1.deploy.md)
|
||||
3. [Setup the Client!](../3.client/1.deploy.md)
|
||||
If you want an instance that's completely isolated from the official movie-web. You can selfhost 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)
|
||||
|
||||
@@ -1,15 +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!**
|
||||
If you would like to use an alternative backend server (the server responsible for saving user data across devices) then you can specify your own URL **without needing to host your own movie-web frontend!**
|
||||
|
||||
::alert{type="danger"}
|
||||
Changing your backend server will log you out of your account - make sure you have a copy of your 12-word passphrase saved safely in case you need to go back!
|
||||
::
|
||||
|
||||
1. On movie-web, got to your settings page by click the menu icon at the top right and then `Settings`.
|
||||
1. Scroll down the page to the section named `Connections` where there is a toggle named `Custom server`.
|
||||
1. Scroll down the page to the section named `Connections` where there is a toggle named `Custom server`.
|
||||
1. Enable the `Custom server` toggle and enter your backend URL in the input box named `Custom server URL`.
|
||||
1. Click `Save` at the bottom right corner of your screen.
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
---
|
||||
title: 'PWA vs no-PWA'
|
||||
---
|
||||
|
||||
# About Selfhosting PWA
|
||||
|
||||
So that clients can have a more native app-like experience on mobile, movie-web has a function to support Progessive Web Apps (PWA). You can learn more about what a PWA is [here](https://developer.mozilla.org/en-US/docs/Web/Progressive_web_apps/Guides/What_is_a_progressive_web_app).
|
||||
@@ -12,9 +13,11 @@ Enabling PWAs means that you cannot disable it again - Please only proceed if yo
|
||||
::
|
||||
|
||||
## If you are running movie-web on a hoster such as Vercel
|
||||
If your hosting is building movie-web from the source, you can enable PWAs using environment variables. The full environment variable reference can be found [here](../3.client/3.configuration.md) but for PWAs we are only interested in `VITE_PWA_ENABLED`.
|
||||
|
||||
Setting `VITE_PWA_ENABLED` to `true` will generate a [service worker file](https://developer.mozilla.org/en-US/docs/Web/Progressive_web_apps/Guides/Making_PWAs_installable#service_worker) and a [web app manifest](https://developer.mozilla.org/en-US/docs/Web/Progressive_web_apps/Guides/Making_PWAs_installable#the_web_app_manifest) which enable the website to be installed from a [web browser both on Desktop and on Mobile](https://developer.mozilla.org/en-US/docs/Web/Progressive_web_apps/Guides/Making_PWAs_installable#installation_from_the_web).
|
||||
If your hosting is building movie-web from the source, you can enable PWAs using environment variables. The full environment variable reference can be found [here](../3.client/3.configuration.md) but for PWAs we are only interested in `VITE_PWA_ENABLED`.
|
||||
|
||||
Setting [`VITE_PWA_ENABLED`](../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 hoster, then all you need to do is to make sure to download the [`movie-web.pwa.zip`](https://github.com/movie-web/movie-web/releases/latest/download/movie-web.pwa.zip) file instead of the `movie-web.zip` file!
|
||||
|
||||
If you are downloading the movie-web `zip` files from our GitHub and installing them on a static website hoster, then all you need to do is to make sure to download the [`movie-web.pwa.zip`](https://github.com/movie-web/movie-web/releases/latest/download/movie-web.pwa.zip) file instead of the `movie-web.zip` file!
|
||||
|
||||
@@ -1,10 +1,10 @@
|
||||
---
|
||||
title: 'Troubleshooting'
|
||||
---
|
||||
|
||||
# Troubleshooting
|
||||
|
||||
There is a possibility for something to go wrong while trying to deploy your own instance of movie-web. This page will contain common issues people 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 movie-web. This page will contain common issues people come across while self-hosting and their solutions.
|
||||
|
||||
## "Failed to find media, try again!" while searching
|
||||
|
||||
@@ -14,7 +14,6 @@ If it succeeds, the TMDB api key is correct and it will be a different issue.
|
||||
|
||||
If it does not work. Recheck your TMDB api key. **Make sure its the READ api key, not the normal api key.**
|
||||
|
||||
|
||||
## Everything I try to watch fails
|
||||
|
||||
This is likely a misconfigured worker. Verify that the workers are the issue by going to `/admin` or `/#/admin`. Then clicking `Test workers`.
|
||||
@@ -23,7 +22,6 @@ You should have at least 1 worker registered.
|
||||
|
||||
If any worker fails the test, you should double check its URL and double check if the worker has the correct code.
|
||||
|
||||
|
||||
## I can't make an account or login
|
||||
|
||||
This is likely misconfigured or broken backend. Verify the backend by going to `/admin` or `/#/admin`. Then clicking `Test backend`.
|
||||
@@ -36,7 +34,14 @@ If the version is not the latest version, you should update your backend instanc
|
||||
|
||||
If the name and description of the results don't match your own instance, make sure you have your backend URL set correctly.
|
||||
|
||||
|
||||
## I updated from version 3 to version 4 but still see the old version
|
||||
|
||||
This is likely that you haven't installed the PWA version of movie-web. Please read the [upgrade guide](../3.client/5.upgrade.md)
|
||||
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` 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.
|
||||
|
||||
@@ -1,3 +1,3 @@
|
||||
title: 'Self-Hosting'
|
||||
icon: mdi:server-network
|
||||
navigation.redirect: /self-hosting/hosting-intro
|
||||
navigation.redirect: /self-hosting/hosting-intro
|
||||
|
||||
Reference in New Issue
Block a user