From 4f9e1f0974312ba08c6e0cbdef1cc27d2821f28a Mon Sep 17 00:00:00 2001 From: mrjvs Date: Tue, 12 Dec 2023 19:25:35 +0100 Subject: [PATCH 1/8] Setup navigation structure --- content/2.self-hosting/1.hosting-intro.md | 30 +++++++++++++++++++ content/2.self-hosting/1.self-hosting.md | 9 ------ content/2.self-hosting/3.client.md | 2 ++ content/2.self-hosting/4.backend.md | 3 ++ content/2.self-hosting/5.use-backend.md | 3 ++ content/2.self-hosting/_dir.yml | 1 + content/3.proxy/0.introduction.md | 3 ++ content/3.proxy/1.deploy.md | 15 ++++++++++ content/3.proxy/_dir.yml | 3 ++ content/4.client/0.introduction.md | 3 ++ content/4.client/1.deploy.md | 11 +++++++ .../2.configuration.md} | 2 ++ content/4.client/3.changelog.md | 3 ++ content/4.client/4.upgrade.md | 3 ++ content/4.client/_dir.yml | 3 ++ content/5.backend/0.introduction.md | 3 ++ content/5.backend/1.deploy.md | 7 +++++ content/5.backend/2.configuration.md | 3 ++ content/5.backend/3.changelog.md | 3 ++ content/5.backend/4.upgrade.md | 1 + content/5.backend/_dir.yml | 3 ++ 21 files changed, 105 insertions(+), 9 deletions(-) create mode 100644 content/2.self-hosting/1.hosting-intro.md delete mode 100644 content/2.self-hosting/1.self-hosting.md create mode 100644 content/2.self-hosting/4.backend.md create mode 100644 content/2.self-hosting/5.use-backend.md create mode 100644 content/3.proxy/0.introduction.md create mode 100644 content/3.proxy/1.deploy.md create mode 100644 content/3.proxy/_dir.yml create mode 100644 content/4.client/0.introduction.md create mode 100644 content/4.client/1.deploy.md rename content/{2.self-hosting/4.client-config.md => 4.client/2.configuration.md} (99%) create mode 100644 content/4.client/3.changelog.md create mode 100644 content/4.client/4.upgrade.md create mode 100644 content/4.client/_dir.yml create mode 100644 content/5.backend/0.introduction.md create mode 100644 content/5.backend/1.deploy.md create mode 100644 content/5.backend/2.configuration.md create mode 100644 content/5.backend/3.changelog.md create mode 100644 content/5.backend/4.upgrade.md create mode 100644 content/5.backend/_dir.yml diff --git a/content/2.self-hosting/1.hosting-intro.md b/content/2.self-hosting/1.hosting-intro.md new file mode 100644 index 0000000..97be2e8 --- /dev/null +++ b/content/2.self-hosting/1.hosting-intro.md @@ -0,0 +1,30 @@ +# 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.** + +## 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. +This method is the easiest to self-host and is recommended for most users. + +1. [Setup the Proxy!](2.proxy.md) +2. [Setup the Client!](3.client.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.md) +2. [Configure the Client!](3.client.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.md) +2. [Setup the Backend!](4.backend.md) +3. [Setup the Client!](3.client.md) \ No newline at end of file diff --git a/content/2.self-hosting/1.self-hosting.md b/content/2.self-hosting/1.self-hosting.md deleted file mode 100644 index dcd24ef..0000000 --- a/content/2.self-hosting/1.self-hosting.md +++ /dev/null @@ -1,9 +0,0 @@ -# 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. -:: - -The movie-web application is made of two parts: the proxy and the client. Click the following links to find out more: -- [Setup the Proxy](2.proxy.md) -- [Setup the Client](3.client.md) diff --git a/content/2.self-hosting/3.client.md b/content/2.self-hosting/3.client.md index d4cd12f..5f2c2db 100644 --- a/content/2.self-hosting/3.client.md +++ b/content/2.self-hosting/3.client.md @@ -10,6 +10,8 @@ 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 [below](#tmdb-api-key) on how to get an API key. + + - `VITE_BACKEND_URL`: Only set if you have a selfhosted 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). diff --git a/content/2.self-hosting/4.backend.md b/content/2.self-hosting/4.backend.md new file mode 100644 index 0000000..c56673f --- /dev/null +++ b/content/2.self-hosting/4.backend.md @@ -0,0 +1,3 @@ +# Setting up the backend + +// EXPLAIN HOW TO HOST THE BACKEND diff --git a/content/2.self-hosting/5.use-backend.md b/content/2.self-hosting/5.use-backend.md new file mode 100644 index 0000000..4319ec1 --- /dev/null +++ b/content/2.self-hosting/5.use-backend.md @@ -0,0 +1,3 @@ +# Configure your client with the backend + +// EXPLAIN HOW TO SET BACKEND URL ON OFFICIAL INSTANCE diff --git a/content/2.self-hosting/_dir.yml b/content/2.self-hosting/_dir.yml index 2810153..c319602 100644 --- a/content/2.self-hosting/_dir.yml +++ b/content/2.self-hosting/_dir.yml @@ -1,2 +1,3 @@ title: 'Self-Hosting' icon: mdi:server-network +navigation.redirect: /self-hosting/hosting-intro \ No newline at end of file diff --git a/content/3.proxy/0.introduction.md b/content/3.proxy/0.introduction.md new file mode 100644 index 0000000..8aeafd7 --- /dev/null +++ b/content/3.proxy/0.introduction.md @@ -0,0 +1,3 @@ +# Introduction to the proxy + +// EXPLAIN WHAT A PROXY IS diff --git a/content/3.proxy/1.deploy.md b/content/3.proxy/1.deploy.md new file mode 100644 index 0000000..d862505 --- /dev/null +++ b/content/3.proxy/1.deploy.md @@ -0,0 +1,15 @@ +# Deploying the proxy + +// FILL PAGE + +## Method 1 - cloudflare (easy) + +// EXPLAIN HOW TO DEPLOY TO CLOUDFLARE with button + +## Method 1 - cloudflare (manual) + +// EXPLAIN HOW TO DEPLOY TO CLOUDFLARE MANUALLY + +## Method 2 - docker + +// EXPLAIN HOW TO DEPLOY WITH DOCKER diff --git a/content/3.proxy/_dir.yml b/content/3.proxy/_dir.yml new file mode 100644 index 0000000..df2ae15 --- /dev/null +++ b/content/3.proxy/_dir.yml @@ -0,0 +1,3 @@ +title: 'Proxy' +icon: mdi:server-network +navigation.redirect: /proxy/introduction \ No newline at end of file diff --git a/content/4.client/0.introduction.md b/content/4.client/0.introduction.md new file mode 100644 index 0000000..d087629 --- /dev/null +++ b/content/4.client/0.introduction.md @@ -0,0 +1,3 @@ +# Introduction to the client + +// EXPLAIN WHAT THE CLIENT DOES \ No newline at end of file diff --git a/content/4.client/1.deploy.md b/content/4.client/1.deploy.md new file mode 100644 index 0000000..463af87 --- /dev/null +++ b/content/4.client/1.deploy.md @@ -0,0 +1,11 @@ +# Deploying the client + +// FILL PAGE + +## Method 1 - vercel + +// EXPLAIN HOW TO DEPLOY TO CLOUDFLARE with button + +## Method 2 - docker + +// EXPLAIN HOW TO DEPLOY WITH DOCKER diff --git a/content/2.self-hosting/4.client-config.md b/content/4.client/2.configuration.md similarity index 99% rename from content/2.self-hosting/4.client-config.md rename to content/4.client/2.configuration.md index 6db2e0c..7d388b4 100644 --- a/content/2.self-hosting/4.client-config.md +++ b/content/4.client/2.configuration.md @@ -71,6 +71,8 @@ This is the URL for the movie-web backend server which handles cross-device sync 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. +Backend url must **not** end with a slash. + Example: `VITE_BACKEND_URL=https://backend.example.com` Default: `https://backend.movie-web.app` diff --git a/content/4.client/3.changelog.md b/content/4.client/3.changelog.md new file mode 100644 index 0000000..5d28c92 --- /dev/null +++ b/content/4.client/3.changelog.md @@ -0,0 +1,3 @@ +# Version 4.0.0 + +Changelog goes here diff --git a/content/4.client/4.upgrade.md b/content/4.client/4.upgrade.md new file mode 100644 index 0000000..0dd6b15 --- /dev/null +++ b/content/4.client/4.upgrade.md @@ -0,0 +1,3 @@ +## From `3.*` to `4.0.0` + +Upgrade guide goes here diff --git a/content/4.client/_dir.yml b/content/4.client/_dir.yml new file mode 100644 index 0000000..6ade5d1 --- /dev/null +++ b/content/4.client/_dir.yml @@ -0,0 +1,3 @@ +title: 'Client' +icon: mdi:server-network +navigation.redirect: /client/introduction diff --git a/content/5.backend/0.introduction.md b/content/5.backend/0.introduction.md new file mode 100644 index 0000000..ce96031 --- /dev/null +++ b/content/5.backend/0.introduction.md @@ -0,0 +1,3 @@ +# Introduction to the backend + +// EXPLAIN WHAT THE BACKEND DOES \ No newline at end of file diff --git a/content/5.backend/1.deploy.md b/content/5.backend/1.deploy.md new file mode 100644 index 0000000..6312c9c --- /dev/null +++ b/content/5.backend/1.deploy.md @@ -0,0 +1,7 @@ +# Deploying the backend + +// FILL PAGE + +## Method 1 - docker + +// EXPLAIN HOW TO DEPLOY WITH DOCKER diff --git a/content/5.backend/2.configuration.md b/content/5.backend/2.configuration.md new file mode 100644 index 0000000..8b817d4 --- /dev/null +++ b/content/5.backend/2.configuration.md @@ -0,0 +1,3 @@ +# Backend Config Reference + +// ADD CONFIGURATION REFERENCE diff --git a/content/5.backend/3.changelog.md b/content/5.backend/3.changelog.md new file mode 100644 index 0000000..49f636b --- /dev/null +++ b/content/5.backend/3.changelog.md @@ -0,0 +1,3 @@ +# Version 1.0.0 + +Changelog goes here diff --git a/content/5.backend/4.upgrade.md b/content/5.backend/4.upgrade.md new file mode 100644 index 0000000..536b368 --- /dev/null +++ b/content/5.backend/4.upgrade.md @@ -0,0 +1 @@ +No upgrades to be done yet diff --git a/content/5.backend/_dir.yml b/content/5.backend/_dir.yml new file mode 100644 index 0000000..33e6d33 --- /dev/null +++ b/content/5.backend/_dir.yml @@ -0,0 +1,3 @@ +title: 'Backend' +icon: mdi:server-network +navigation.redirect: /backend/introduction From 6d14cd42c2ed1e73e28f20ca13e703c905e69b9e Mon Sep 17 00:00:00 2001 From: mrjvs Date: Tue, 12 Dec 2023 19:28:16 +0100 Subject: [PATCH 2/8] Add more pages --- content/2.self-hosting/3.client.md | 4 ++-- content/2.self-hosting/6.about-pwa.md | 4 ++++ content/2.self-hosting/7.troubleshooting.md | 5 +++++ 3 files changed, 11 insertions(+), 2 deletions(-) create mode 100644 content/2.self-hosting/6.about-pwa.md create mode 100644 content/2.self-hosting/7.troubleshooting.md diff --git a/content/2.self-hosting/3.client.md b/content/2.self-hosting/3.client.md index 5f2c2db..45e3ef7 100644 --- a/content/2.self-hosting/3.client.md +++ b/content/2.self-hosting/3.client.md @@ -1,6 +1,6 @@ # Setting up the client -## Vercel - Recommended +## 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. @@ -17,7 +17,7 @@ 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). -## Any Static Web Host +## Method 2 - Any 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. diff --git a/content/2.self-hosting/6.about-pwa.md b/content/2.self-hosting/6.about-pwa.md new file mode 100644 index 0000000..395a977 --- /dev/null +++ b/content/2.self-hosting/6.about-pwa.md @@ -0,0 +1,4 @@ +# About selfhosting PWA + +// EXPLAIN WHY ITS A BAD IDEA, BUT ALSO HOW TO DO IT + diff --git a/content/2.self-hosting/7.troubleshooting.md b/content/2.self-hosting/7.troubleshooting.md new file mode 100644 index 0000000..d6ff19f --- /dev/null +++ b/content/2.self-hosting/7.troubleshooting.md @@ -0,0 +1,5 @@ +# Troubleshooting + +// EXPLAIN HOW TO TROUBLESHOOT + +// MENTION ADMIN PAGE FOR TROUBLESHOOTING From 31690529eb66b3b8e5f3e14eb0f187a635698816 Mon Sep 17 00:00:00 2001 From: mrjvs Date: Tue, 12 Dec 2023 19:36:07 +0100 Subject: [PATCH 3/8] Add navigation page titles --- content/1.introduction/1.getting-started.md | 3 +++ content/2.self-hosting/1.hosting-intro.md | 3 +++ content/2.self-hosting/2.proxy.md | 3 +++ content/2.self-hosting/3.client.md | 3 +++ content/2.self-hosting/4.backend.md | 3 +++ content/2.self-hosting/5.use-backend.md | 3 +++ content/2.self-hosting/6.about-pwa.md | 3 +++ content/2.self-hosting/7.troubleshooting.md | 3 +++ content/3.proxy/0.introduction.md | 3 +++ content/3.proxy/1.deploy.md | 3 +++ content/4.client/0.introduction.md | 3 +++ content/4.client/1.deploy.md | 3 +++ content/4.client/2.configuration.md | 3 +++ content/4.client/3.changelog.md | 3 +++ content/4.client/4.upgrade.md | 3 +++ content/5.backend/0.introduction.md | 3 +++ content/5.backend/1.deploy.md | 3 +++ content/5.backend/2.configuration.md | 3 +++ content/5.backend/3.changelog.md | 3 +++ content/5.backend/4.upgrade.md | 3 +++ 20 files changed, 60 insertions(+) diff --git a/content/1.introduction/1.getting-started.md b/content/1.introduction/1.getting-started.md index 31dd91e..1429f18 100644 --- a/content/1.introduction/1.getting-started.md +++ b/content/1.introduction/1.getting-started.md @@ -1,2 +1,5 @@ +--- +title: 'Getting started' +--- # Getting Started diff --git a/content/2.self-hosting/1.hosting-intro.md b/content/2.self-hosting/1.hosting-intro.md index 97be2e8..8dddc2e 100644 --- a/content/2.self-hosting/1.hosting-intro.md +++ b/content/2.self-hosting/1.hosting-intro.md @@ -1,3 +1,6 @@ +--- +title: 'Start self-hosting' +--- # How to self host ::alert{type="info"} diff --git a/content/2.self-hosting/2.proxy.md b/content/2.self-hosting/2.proxy.md index c727f54..815d222 100644 --- a/content/2.self-hosting/2.proxy.md +++ b/content/2.self-hosting/2.proxy.md @@ -1,3 +1,6 @@ +--- +title: 'The proxy' +--- # Setting up the proxy Our proxy is used to bypass CORS-protected URLs on the client side, allowing users to make requests to protected endpoints without a backend server. diff --git a/content/2.self-hosting/3.client.md b/content/2.self-hosting/3.client.md index 45e3ef7..7402a0b 100644 --- a/content/2.self-hosting/3.client.md +++ b/content/2.self-hosting/3.client.md @@ -1,3 +1,6 @@ +--- +title: 'The client' +--- # Setting up the client ## Method 1 - Vercel - Recommended diff --git a/content/2.self-hosting/4.backend.md b/content/2.self-hosting/4.backend.md index c56673f..b210c6a 100644 --- a/content/2.self-hosting/4.backend.md +++ b/content/2.self-hosting/4.backend.md @@ -1,3 +1,6 @@ +--- +title: 'The backend' +--- # Setting up the backend // EXPLAIN HOW TO HOST THE BACKEND diff --git a/content/2.self-hosting/5.use-backend.md b/content/2.self-hosting/5.use-backend.md index 4319ec1..f15ba1e 100644 --- a/content/2.self-hosting/5.use-backend.md +++ b/content/2.self-hosting/5.use-backend.md @@ -1,3 +1,6 @@ +--- +title: 'Configure backend' +--- # Configure your client with the backend // EXPLAIN HOW TO SET BACKEND URL ON OFFICIAL INSTANCE diff --git a/content/2.self-hosting/6.about-pwa.md b/content/2.self-hosting/6.about-pwa.md index 395a977..290e163 100644 --- a/content/2.self-hosting/6.about-pwa.md +++ b/content/2.self-hosting/6.about-pwa.md @@ -1,3 +1,6 @@ +--- +title: 'PWA vs no-PWA' +--- # About selfhosting PWA // EXPLAIN WHY ITS A BAD IDEA, BUT ALSO HOW TO DO IT diff --git a/content/2.self-hosting/7.troubleshooting.md b/content/2.self-hosting/7.troubleshooting.md index d6ff19f..22608af 100644 --- a/content/2.self-hosting/7.troubleshooting.md +++ b/content/2.self-hosting/7.troubleshooting.md @@ -1,3 +1,6 @@ +--- +title: 'Troubleshooting' +--- # Troubleshooting // EXPLAIN HOW TO TROUBLESHOOT diff --git a/content/3.proxy/0.introduction.md b/content/3.proxy/0.introduction.md index 8aeafd7..2a92c39 100644 --- a/content/3.proxy/0.introduction.md +++ b/content/3.proxy/0.introduction.md @@ -1,3 +1,6 @@ +--- +title: 'Introduction' +--- # Introduction to the proxy // EXPLAIN WHAT A PROXY IS diff --git a/content/3.proxy/1.deploy.md b/content/3.proxy/1.deploy.md index d862505..fa546f3 100644 --- a/content/3.proxy/1.deploy.md +++ b/content/3.proxy/1.deploy.md @@ -1,3 +1,6 @@ +--- +title: 'Deploy' +--- # Deploying the proxy // FILL PAGE diff --git a/content/4.client/0.introduction.md b/content/4.client/0.introduction.md index d087629..f93a948 100644 --- a/content/4.client/0.introduction.md +++ b/content/4.client/0.introduction.md @@ -1,3 +1,6 @@ +--- +title: 'Introduction' +--- # Introduction to the client // EXPLAIN WHAT THE CLIENT DOES \ No newline at end of file diff --git a/content/4.client/1.deploy.md b/content/4.client/1.deploy.md index 463af87..7e34c66 100644 --- a/content/4.client/1.deploy.md +++ b/content/4.client/1.deploy.md @@ -1,3 +1,6 @@ +--- +title: 'Deploy' +--- # Deploying the client // FILL PAGE diff --git a/content/4.client/2.configuration.md b/content/4.client/2.configuration.md index 7d388b4..2a4803f 100644 --- a/content/4.client/2.configuration.md +++ b/content/4.client/2.configuration.md @@ -1,3 +1,6 @@ +--- +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: diff --git a/content/4.client/3.changelog.md b/content/4.client/3.changelog.md index 5d28c92..1039af2 100644 --- a/content/4.client/3.changelog.md +++ b/content/4.client/3.changelog.md @@ -1,3 +1,6 @@ +--- +title: 'Changelog' +--- # Version 4.0.0 Changelog goes here diff --git a/content/4.client/4.upgrade.md b/content/4.client/4.upgrade.md index 0dd6b15..d64f539 100644 --- a/content/4.client/4.upgrade.md +++ b/content/4.client/4.upgrade.md @@ -1,3 +1,6 @@ +--- +title: 'Upgrade guide' +--- ## From `3.*` to `4.0.0` Upgrade guide goes here diff --git a/content/5.backend/0.introduction.md b/content/5.backend/0.introduction.md index ce96031..317769e 100644 --- a/content/5.backend/0.introduction.md +++ b/content/5.backend/0.introduction.md @@ -1,3 +1,6 @@ +--- +title: 'Introduction' +--- # Introduction to the backend // EXPLAIN WHAT THE BACKEND DOES \ No newline at end of file diff --git a/content/5.backend/1.deploy.md b/content/5.backend/1.deploy.md index 6312c9c..1685a1a 100644 --- a/content/5.backend/1.deploy.md +++ b/content/5.backend/1.deploy.md @@ -1,3 +1,6 @@ +--- +title: 'Deploy' +--- # Deploying the backend // FILL PAGE diff --git a/content/5.backend/2.configuration.md b/content/5.backend/2.configuration.md index 8b817d4..3040200 100644 --- a/content/5.backend/2.configuration.md +++ b/content/5.backend/2.configuration.md @@ -1,3 +1,6 @@ +--- +title: 'Configuration' +--- # Backend Config Reference // ADD CONFIGURATION REFERENCE diff --git a/content/5.backend/3.changelog.md b/content/5.backend/3.changelog.md index 49f636b..da748f7 100644 --- a/content/5.backend/3.changelog.md +++ b/content/5.backend/3.changelog.md @@ -1,3 +1,6 @@ +--- +title: 'Changelog' +--- # Version 1.0.0 Changelog goes here diff --git a/content/5.backend/4.upgrade.md b/content/5.backend/4.upgrade.md index 536b368..980e6cd 100644 --- a/content/5.backend/4.upgrade.md +++ b/content/5.backend/4.upgrade.md @@ -1 +1,4 @@ +--- +title: 'Upgrade guide' +--- No upgrades to be done yet From c4d1622922ec963575b60ca366fae19af5cd18d5 Mon Sep 17 00:00:00 2001 From: mrjvs Date: Tue, 12 Dec 2023 20:12:52 +0100 Subject: [PATCH 4/8] Rename numbers --- content/0.index.md | 2 +- content/1.introduction/1.getting-started.md | 5 ----- content/1.introduction/_dir.yml | 2 -- .../{2.self-hosting => 1.self-hosting}/1.hosting-intro.md | 2 +- content/{2.self-hosting => 1.self-hosting}/2.proxy.md | 0 content/{2.self-hosting => 1.self-hosting}/3.client.md | 0 content/{2.self-hosting => 1.self-hosting}/4.backend.md | 0 content/{2.self-hosting => 1.self-hosting}/5.use-backend.md | 0 content/{2.self-hosting => 1.self-hosting}/6.about-pwa.md | 0 .../{2.self-hosting => 1.self-hosting}/7.troubleshooting.md | 0 content/{2.self-hosting => 1.self-hosting}/_dir.yml | 0 content/{3.proxy => 2.proxy}/0.introduction.md | 0 content/{3.proxy => 2.proxy}/1.deploy.md | 0 content/{3.proxy => 2.proxy}/_dir.yml | 0 content/{4.client => 3.client}/0.introduction.md | 0 content/{4.client => 3.client}/1.deploy.md | 0 content/{4.client => 3.client}/2.configuration.md | 0 content/{4.client => 3.client}/3.changelog.md | 0 content/{4.client => 3.client}/4.upgrade.md | 0 content/{4.client => 3.client}/_dir.yml | 0 content/{5.backend => 4.backend}/0.introduction.md | 0 content/{5.backend => 4.backend}/1.deploy.md | 0 content/{5.backend => 4.backend}/2.configuration.md | 0 content/{5.backend => 4.backend}/3.changelog.md | 0 content/{5.backend => 4.backend}/4.upgrade.md | 0 content/{5.backend => 4.backend}/_dir.yml | 0 26 files changed, 2 insertions(+), 9 deletions(-) delete mode 100644 content/1.introduction/1.getting-started.md delete mode 100644 content/1.introduction/_dir.yml rename content/{2.self-hosting => 1.self-hosting}/1.hosting-intro.md (96%) rename content/{2.self-hosting => 1.self-hosting}/2.proxy.md (100%) rename content/{2.self-hosting => 1.self-hosting}/3.client.md (100%) rename content/{2.self-hosting => 1.self-hosting}/4.backend.md (100%) rename content/{2.self-hosting => 1.self-hosting}/5.use-backend.md (100%) rename content/{2.self-hosting => 1.self-hosting}/6.about-pwa.md (100%) rename content/{2.self-hosting => 1.self-hosting}/7.troubleshooting.md (100%) rename content/{2.self-hosting => 1.self-hosting}/_dir.yml (100%) rename content/{3.proxy => 2.proxy}/0.introduction.md (100%) rename content/{3.proxy => 2.proxy}/1.deploy.md (100%) rename content/{3.proxy => 2.proxy}/_dir.yml (100%) rename content/{4.client => 3.client}/0.introduction.md (100%) rename content/{4.client => 3.client}/1.deploy.md (100%) rename content/{4.client => 3.client}/2.configuration.md (100%) rename content/{4.client => 3.client}/3.changelog.md (100%) rename content/{4.client => 3.client}/4.upgrade.md (100%) rename content/{4.client => 3.client}/_dir.yml (100%) rename content/{5.backend => 4.backend}/0.introduction.md (100%) rename content/{5.backend => 4.backend}/1.deploy.md (100%) rename content/{5.backend => 4.backend}/2.configuration.md (100%) rename content/{5.backend => 4.backend}/3.changelog.md (100%) rename content/{5.backend => 4.backend}/4.upgrade.md (100%) rename content/{5.backend => 4.backend}/_dir.yml (100%) diff --git a/content/0.index.md b/content/0.index.md index e9f8168..25b1dc8 100644 --- a/content/0.index.md +++ b/content/0.index.md @@ -8,7 +8,7 @@ layout: page --- cta: - Get Started - - /introduction/getting-started + - /self-hosting/hosting-intro secondary: - Open on GitHub → - https://github.com/movie-web/movie-web diff --git a/content/1.introduction/1.getting-started.md b/content/1.introduction/1.getting-started.md deleted file mode 100644 index 1429f18..0000000 --- a/content/1.introduction/1.getting-started.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: 'Getting started' ---- -# Getting Started - diff --git a/content/1.introduction/_dir.yml b/content/1.introduction/_dir.yml deleted file mode 100644 index ff0894d..0000000 --- a/content/1.introduction/_dir.yml +++ /dev/null @@ -1,2 +0,0 @@ -icon: ph:star-duotone -navigation.redirect: /introduction/getting-started diff --git a/content/2.self-hosting/1.hosting-intro.md b/content/1.self-hosting/1.hosting-intro.md similarity index 96% rename from content/2.self-hosting/1.hosting-intro.md rename to content/1.self-hosting/1.hosting-intro.md index 8dddc2e..74f91af 100644 --- a/content/2.self-hosting/1.hosting-intro.md +++ b/content/1.self-hosting/1.hosting-intro.md @@ -22,7 +22,7 @@ If you want to own your own data, it's possible to selfhost just the account ser This method is only recommended if you have experience hosting databases or other similar stateful applications. 1. [Setup the Backend!](4.backend.md) -2. [Configure the Client!](3.client.md) +2. [Configure the Client!](5.use-backend.md) ## Method 3 - host everything If you want an instance that's completely isolated from official movie-web. You can selfhost all parts. diff --git a/content/2.self-hosting/2.proxy.md b/content/1.self-hosting/2.proxy.md similarity index 100% rename from content/2.self-hosting/2.proxy.md rename to content/1.self-hosting/2.proxy.md diff --git a/content/2.self-hosting/3.client.md b/content/1.self-hosting/3.client.md similarity index 100% rename from content/2.self-hosting/3.client.md rename to content/1.self-hosting/3.client.md diff --git a/content/2.self-hosting/4.backend.md b/content/1.self-hosting/4.backend.md similarity index 100% rename from content/2.self-hosting/4.backend.md rename to content/1.self-hosting/4.backend.md diff --git a/content/2.self-hosting/5.use-backend.md b/content/1.self-hosting/5.use-backend.md similarity index 100% rename from content/2.self-hosting/5.use-backend.md rename to content/1.self-hosting/5.use-backend.md diff --git a/content/2.self-hosting/6.about-pwa.md b/content/1.self-hosting/6.about-pwa.md similarity index 100% rename from content/2.self-hosting/6.about-pwa.md rename to content/1.self-hosting/6.about-pwa.md diff --git a/content/2.self-hosting/7.troubleshooting.md b/content/1.self-hosting/7.troubleshooting.md similarity index 100% rename from content/2.self-hosting/7.troubleshooting.md rename to content/1.self-hosting/7.troubleshooting.md diff --git a/content/2.self-hosting/_dir.yml b/content/1.self-hosting/_dir.yml similarity index 100% rename from content/2.self-hosting/_dir.yml rename to content/1.self-hosting/_dir.yml diff --git a/content/3.proxy/0.introduction.md b/content/2.proxy/0.introduction.md similarity index 100% rename from content/3.proxy/0.introduction.md rename to content/2.proxy/0.introduction.md diff --git a/content/3.proxy/1.deploy.md b/content/2.proxy/1.deploy.md similarity index 100% rename from content/3.proxy/1.deploy.md rename to content/2.proxy/1.deploy.md diff --git a/content/3.proxy/_dir.yml b/content/2.proxy/_dir.yml similarity index 100% rename from content/3.proxy/_dir.yml rename to content/2.proxy/_dir.yml diff --git a/content/4.client/0.introduction.md b/content/3.client/0.introduction.md similarity index 100% rename from content/4.client/0.introduction.md rename to content/3.client/0.introduction.md diff --git a/content/4.client/1.deploy.md b/content/3.client/1.deploy.md similarity index 100% rename from content/4.client/1.deploy.md rename to content/3.client/1.deploy.md diff --git a/content/4.client/2.configuration.md b/content/3.client/2.configuration.md similarity index 100% rename from content/4.client/2.configuration.md rename to content/3.client/2.configuration.md diff --git a/content/4.client/3.changelog.md b/content/3.client/3.changelog.md similarity index 100% rename from content/4.client/3.changelog.md rename to content/3.client/3.changelog.md diff --git a/content/4.client/4.upgrade.md b/content/3.client/4.upgrade.md similarity index 100% rename from content/4.client/4.upgrade.md rename to content/3.client/4.upgrade.md diff --git a/content/4.client/_dir.yml b/content/3.client/_dir.yml similarity index 100% rename from content/4.client/_dir.yml rename to content/3.client/_dir.yml diff --git a/content/5.backend/0.introduction.md b/content/4.backend/0.introduction.md similarity index 100% rename from content/5.backend/0.introduction.md rename to content/4.backend/0.introduction.md diff --git a/content/5.backend/1.deploy.md b/content/4.backend/1.deploy.md similarity index 100% rename from content/5.backend/1.deploy.md rename to content/4.backend/1.deploy.md diff --git a/content/5.backend/2.configuration.md b/content/4.backend/2.configuration.md similarity index 100% rename from content/5.backend/2.configuration.md rename to content/4.backend/2.configuration.md diff --git a/content/5.backend/3.changelog.md b/content/4.backend/3.changelog.md similarity index 100% rename from content/5.backend/3.changelog.md rename to content/4.backend/3.changelog.md diff --git a/content/5.backend/4.upgrade.md b/content/4.backend/4.upgrade.md similarity index 100% rename from content/5.backend/4.upgrade.md rename to content/4.backend/4.upgrade.md diff --git a/content/5.backend/_dir.yml b/content/4.backend/_dir.yml similarity index 100% rename from content/5.backend/_dir.yml rename to content/4.backend/_dir.yml From 042023dd1151bda2120ca5195912a737988448e1 Mon Sep 17 00:00:00 2001 From: mrjvs Date: Tue, 12 Dec 2023 21:44:28 +0100 Subject: [PATCH 5/8] Write a lot, like an actual lot. of documentation Co-authored-by: William Oldham --- README.md | 58 +------- content/1.self-hosting/1.hosting-intro.md | 20 +-- content/1.self-hosting/2.proxy.md | 40 ------ .../{5.use-backend.md => 2.use-backend.md} | 2 +- .../{6.about-pwa.md => 3.about-pwa.md} | 0 content/1.self-hosting/3.client.md | 54 -------- content/1.self-hosting/4.backend.md | 6 - ...roubleshooting.md => 4.troubleshooting.md} | 0 content/2.proxy/0.introduction.md | 5 +- content/2.proxy/1.deploy.md | 60 +++++++- content/3.client/1.deploy.md | 35 ++++- content/3.client/2.tmdb.md | 19 +++ ...{2.configuration.md => 3.configuration.md} | 0 .../{3.changelog.md => 4.changelog.md} | 2 +- content/3.client/4.upgrade.md | 6 - content/3.client/5.upgrade.md | 6 + content/4.backend/0.introduction.md | 18 ++- content/4.backend/1.deploy.md | 23 +++- content/4.backend/2.configuration.md | 130 +++++++++++++++++- content/4.backend/3.changelog.md | 11 +- content/4.backend/4.upgrade.md | 5 +- 21 files changed, 304 insertions(+), 196 deletions(-) delete mode 100644 content/1.self-hosting/2.proxy.md rename content/1.self-hosting/{5.use-backend.md => 2.use-backend.md} (58%) rename content/1.self-hosting/{6.about-pwa.md => 3.about-pwa.md} (100%) delete mode 100644 content/1.self-hosting/3.client.md delete mode 100644 content/1.self-hosting/4.backend.md rename content/1.self-hosting/{7.troubleshooting.md => 4.troubleshooting.md} (100%) create mode 100644 content/3.client/2.tmdb.md rename content/3.client/{2.configuration.md => 3.configuration.md} (100%) rename content/3.client/{3.changelog.md => 4.changelog.md} (65%) delete mode 100644 content/3.client/4.upgrade.md create mode 100644 content/3.client/5.upgrade.md diff --git a/README.md b/README.md index 8607e02..23f9a6f 100644 --- a/README.md +++ b/README.md @@ -1,57 +1,3 @@ -# Docus Starter +# movie-web docs -Starter template for [Docus](https://docus.dev). - -## Clone - -Clone the repository (using `nuxi`): - -```bash -npx nuxi init -t themes/docus -``` - -## Setup - -Install dependencies: - -```bash -yarn install -``` - -## Development - -```bash -yarn dev -``` - -## Edge Side Rendering - -Can be deployed to Vercel Functions, Netlify Functions, AWS, and most Node-compatible environments. - -Look at all the available presets [here](https://v3.nuxtjs.org/guide/deploy/presets). - -```bash -yarn build -``` - -## Static Generation - -Use the `generate` command to build your application. - -The HTML files will be generated in the .output/public directory and ready to be deployed to any static compatible hosting. - -```bash -yarn generate -``` - -## Preview build - -You might want to preview the result of your build locally, to do so, run the following command: - -```bash -yarn preview -``` - ---- - -For a detailed explanation of how things work, check out [Docus](https://docus.dev). +Find it at https://docs.movie-web.app/ diff --git a/content/1.self-hosting/1.hosting-intro.md b/content/1.self-hosting/1.hosting-intro.md index 74f91af..b1ddea6 100644 --- a/content/1.self-hosting/1.hosting-intro.md +++ b/content/1.self-hosting/1.hosting-intro.md @@ -10,24 +10,24 @@ We **do not** provide support on how to self-host. If you can't figure it out th 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.** -## 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. This method is the easiest to self-host and is recommended for most users. -1. [Setup the Proxy!](2.proxy.md) -2. [Setup the Client!](3.client.md) +1. [Setup the Proxy!](../2.proxy/1.deploy.md) +2. [Setup the Client!](../3.client/1.deploy.md) -## Method 2 - only host the account server +## 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.md) -2. [Configure the Client!](5.use-backend.md) +1. [Setup the Backend!](../4.backend/1.deploy.md) +2. [Configure the Client!](../3.client/1.deploy.md) -## Method 3 - host everything +## 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.md) -2. [Setup the Backend!](4.backend.md) -3. [Setup the Client!](3.client.md) \ No newline at end of file +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) \ No newline at end of file diff --git a/content/1.self-hosting/2.proxy.md b/content/1.self-hosting/2.proxy.md deleted file mode 100644 index 815d222..0000000 --- a/content/1.self-hosting/2.proxy.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: 'The proxy' ---- -# Setting up the proxy - -Our proxy is used to bypass CORS-protected URLs on the client side, allowing users to make requests to 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 Cloudflare due to its [generous free plan](https://www.cloudflare.com/en-gb/plans/developer-platform/). - -## Cloudflare Workers - -The proxy is made as a Cloudflare worker. 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) - -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 authorise 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" to find your account ID. - 1. If you have used workers in the past, there will be a place on the right hand side to copy your account ID. - 1. If you haven't used workers before, 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" 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" 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 -> proxy. diff --git a/content/1.self-hosting/5.use-backend.md b/content/1.self-hosting/2.use-backend.md similarity index 58% rename from content/1.self-hosting/5.use-backend.md rename to content/1.self-hosting/2.use-backend.md index f15ba1e..ebc9701 100644 --- a/content/1.self-hosting/5.use-backend.md +++ b/content/1.self-hosting/2.use-backend.md @@ -3,4 +3,4 @@ title: 'Configure backend' --- # Configure your client with the backend -// EXPLAIN HOW TO SET BACKEND URL ON OFFICIAL INSTANCE +// CONFIGURE IT HERE \ No newline at end of file diff --git a/content/1.self-hosting/6.about-pwa.md b/content/1.self-hosting/3.about-pwa.md similarity index 100% rename from content/1.self-hosting/6.about-pwa.md rename to content/1.self-hosting/3.about-pwa.md diff --git a/content/1.self-hosting/3.client.md b/content/1.self-hosting/3.client.md deleted file mode 100644 index 7402a0b..0000000 --- a/content/1.self-hosting/3.client.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: 'The client' ---- -# Setting up 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 [below](#tmdb-api-key) on how to get an API key. - - - `VITE_BACKEND_URL`: Only set if you have a selfhosted 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 - Any 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 [below](#tmdb-api-key) on how to get an API key. -6. Save the file. -7. Upload **all** of the files to a static website hosting such as: - - GitHub Pages - - Netlify - - Vercel - - Etc, there are lots - Google it if the ones above don't work for you. -1. Congrats! You have your own version of movie-web hosted. - - -## TMDB API Key -In order to search for movies and TV shows, we use an API called "The Movie Database" (TMDB). In order for your client to be able to search, you need to generate an API key. - -::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** diff --git a/content/1.self-hosting/4.backend.md b/content/1.self-hosting/4.backend.md deleted file mode 100644 index b210c6a..0000000 --- a/content/1.self-hosting/4.backend.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -title: 'The backend' ---- -# Setting up the backend - -// EXPLAIN HOW TO HOST THE BACKEND diff --git a/content/1.self-hosting/7.troubleshooting.md b/content/1.self-hosting/4.troubleshooting.md similarity index 100% rename from content/1.self-hosting/7.troubleshooting.md rename to content/1.self-hosting/4.troubleshooting.md diff --git a/content/2.proxy/0.introduction.md b/content/2.proxy/0.introduction.md index 2a92c39..03a2ab1 100644 --- a/content/2.proxy/0.introduction.md +++ b/content/2.proxy/0.introduction.md @@ -2,5 +2,8 @@ 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. -// EXPLAIN WHAT A PROXY IS +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 Cloudflare due to its [generous free plan](https://www.cloudflare.com/en-gb/plans/developer-platform/). diff --git a/content/2.proxy/1.deploy.md b/content/2.proxy/1.deploy.md index fa546f3..bcc228d 100644 --- a/content/2.proxy/1.deploy.md +++ b/content/2.proxy/1.deploy.md @@ -3,16 +3,62 @@ title: 'Deploy' --- # Deploying the proxy -// FILL PAGE +## Method 1 - Cloudflare (Easy) -## Method 1 - cloudflare (easy) +Cloudflare has a generous free plan, so you don't need to pay anything unless you get hundreds of users. -// EXPLAIN HOW TO DEPLOY TO CLOUDFLARE with button +[![Deploy to Cloudflare Workers](https://deploy.workers.cloudflare.com/button)](https://deploy.workers.cloudflare.com/?url=https://github.com/movie-web/simple-proxy) -## Method 1 - cloudflare (manual) +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 authorise 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` 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` 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` 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 -> Proxy. -// EXPLAIN HOW TO DEPLOY TO CLOUDFLARE MANUALLY +## Method 1 - Cloudflare (Manual) +1. Login to your Cloudflare account if you have one, otherwise create one [here](https://dash.cloudflare.com/sign-up) + 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 setup the client! -## Method 2 - docker +## Method 2 - Docker -// EXPLAIN HOW TO DEPLOY WITH DOCKER +::alert{type="warning"} +Experience with Docker, domains and web hosting is **highly recommended** for this method.
+[Deploying with Cloudflare](#method-1-cloudflare-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` :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. \ No newline at end of file diff --git a/content/3.client/1.deploy.md b/content/3.client/1.deploy.md index 7e34c66..e60ebbd 100644 --- a/content/3.client/1.deploy.md +++ b/content/3.client/1.deploy.md @@ -3,12 +3,35 @@ title: 'Deploy' --- # Deploying the client -// FILL PAGE +## 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. -## Method 1 - vercel + - `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). -// EXPLAIN HOW TO DEPLOY TO CLOUDFLARE with button +## 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. -## Method 2 - docker - -// EXPLAIN HOW TO DEPLOY WITH DOCKER + 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. +6. Save the file. +7. Upload **all** of the files to a static website hosting such as: + - GitHub Pages + - Netlify + - Vercel + - Etc, there are lots - Google it if the ones above don't work for you. +1. Congrats! You have your own version of movie-web hosted. \ No newline at end of file diff --git a/content/3.client/2.tmdb.md b/content/3.client/2.tmdb.md new file mode 100644 index 0000000..c5a0598 --- /dev/null +++ b/content/3.client/2.tmdb.md @@ -0,0 +1,19 @@ +--- +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). In order for your client to be able to search, you need to generate an API key. + +::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** \ No newline at end of file diff --git a/content/3.client/2.configuration.md b/content/3.client/3.configuration.md similarity index 100% rename from content/3.client/2.configuration.md rename to content/3.client/3.configuration.md diff --git a/content/3.client/3.changelog.md b/content/3.client/4.changelog.md similarity index 65% rename from content/3.client/3.changelog.md rename to content/3.client/4.changelog.md index 1039af2..4a61910 100644 --- a/content/3.client/3.changelog.md +++ b/content/3.client/4.changelog.md @@ -3,4 +3,4 @@ title: 'Changelog' --- # Version 4.0.0 -Changelog goes here +// CHANGELOG GOES HERE diff --git a/content/3.client/4.upgrade.md b/content/3.client/4.upgrade.md deleted file mode 100644 index d64f539..0000000 --- a/content/3.client/4.upgrade.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -title: 'Upgrade guide' ---- -## From `3.*` to `4.0.0` - -Upgrade guide goes here diff --git a/content/3.client/5.upgrade.md b/content/3.client/5.upgrade.md new file mode 100644 index 0000000..b95c51b --- /dev/null +++ b/content/3.client/5.upgrade.md @@ -0,0 +1,6 @@ +--- +title: 'Upgrade guide' +--- +## Upgrade guide + +// UPGRADE GUIDE HERE diff --git a/content/4.backend/0.introduction.md b/content/4.backend/0.introduction.md index 317769e..1a407f1 100644 --- a/content/4.backend/0.introduction.md +++ b/content/4.backend/0.introduction.md @@ -3,4 +3,20 @@ title: 'Introduction' --- # Introduction to the backend -// EXPLAIN WHAT THE BACKEND DOES \ No newline at end of file +The backend is essentially just an account server. There is not much more to it. + +## Metrics + +The backend exposes prometheus metrics, it can be accessed on `/metrics`. + +## Security + +Optionally, there are a few security settings: +- Recaptcha support, the server can verify Recaptcha v3 tokens on register and login. +- Ratelimits, Some expensive endpoints have ratelimits, but only when enabled. This requires an additional redis connection. + +## Migrations + +To run migrations, You can use the command `pnpm migration:up` inside the docker container. + +Alternatively, you can enabled `postgres.migrateOnBoot` and it will be automatically migrated on boot. diff --git a/content/4.backend/1.deploy.md b/content/4.backend/1.deploy.md index 1685a1a..4b87208 100644 --- a/content/4.backend/1.deploy.md +++ b/content/4.backend/1.deploy.md @@ -3,8 +3,25 @@ title: 'Deploy' --- # Deploying the backend -// FILL PAGE +The only officially recognized hosting method is through Docker (or similar container runtimes). -## Method 1 - docker +It can be scaled horizontally to all your heart's content. -// EXPLAIN HOW TO DEPLOY WITH DOCKER +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) if `postgres.migrateOnBoot` isn't enabled. +:: + +## Method 1 - Docker + +For other versions, [check out the package page](https://github.com/movie-web/backend/pkgs/container/backend). + +```sh +docker run \ + -p 80:80 \ + -e POSTGRES__CONNECTION=postgresql://localhost:5432 \ + -e CRYPTO__SESSION_SECRET=add-your-own-secret \ + -e META__NAME=unofficial-movie-web \ + ghcr.io/movie-web/backend:latest +``` diff --git a/content/4.backend/2.configuration.md b/content/4.backend/2.configuration.md index 3040200..6e8ffcd 100644 --- a/content/4.backend/2.configuration.md +++ b/content/4.backend/2.configuration.md @@ -3,4 +3,132 @@ title: 'Configuration' --- # Backend Config Reference -// ADD CONFIGURATION REFERENCE +The config the backend can be provided in 3 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) + +## Method 1 - `config.json` + +This method uses nesting. So the key `server.basePath`. Will result in a json file like this: +```json +{ + "server": { + "basePath": "/backend", + } +} +``` + +## Method 2 - `.env` + +This method is a flat method using double underscores as seperators and `MW_` as prefix. So the key `server.basePath`. Will result in the .env file like this: +```sh +MB_SERVER__BASE_PATH=/backend +``` + +## Method 3 - environment + +This method is identical to the `.env` method listed above, but instead of writing it in a file, you add it to the environment. + +# Reference + +### `server.port` +Port number that the HTTP server listens on. + +Example: `8080` + +### `server.cors` +Space seperated list of allowed origins. + +Example: +``` +https://movie-web.app https://testing.movie-web.app +``` + +### `server.allowAnySite` +If this setting is set to true, it allows any origin to access the site. +This overwrites the setting at `server.cors`. + +Example: `false` + +### `server.trustProxy` +Should the server trust reverse proxy headers? This is used for ratelimiting + +Example: `false` + +### `server.basePath` +Prefix for which path is being listened on. Useful you're hosting on `example.com/backend` for example. +If this is set, you shouldn't apply url rewriting before proxying. + +Example: `/backend` + +### `logging.format` +Logging format, Should be either `pretty` or `json`. + +Example: `pretty` + +### `postgres.connection` - REQUIRED +Connection URL for postgres instance, should contain the database in the URL. + +Example: `postgresql://localhost:5432` + +### `postgres.migrateOnBoot` +Run all migrations that haven't ran yet on boot. + +Example: `false` + +::alert{type="warn"} +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` +Log all postgres queries in the console, this outputs sensitive data so DO NOT run it in production. + +Example: `false` + +### `crypto.sessionSecret` - REQUIRED +The secret used to sign sessions. Must be at least 32 characters long. + +Example: `Make your own` + +### `meta.name` - REQUIRED + +The name of the backend instance, this will be displayed to users who try to create an account. + +Example: `Unofficial movie-web` + +### `meta.description` + +The description of the backend instance, this will be displayed to users who try to create an account. + +Example: `This is not an official instance of movie-web` + +### `captcha.enabled` + +To protect your server from bot attacks, captcha's can be useful to enabled. If this is enabled, all other captcha related settings are required. + +Example: `false` + +### `captcha.secret` + +Google Recaptcha secret key. + +Example: `sjgaJ@3djasFVx` + +### `captcha.clientKey` + +Google Recaptcha site key. + +Example: `2jf853z5bc63bvDb2323FAda` + +### `ratelimits.enabled` + +To protect bot attacks or spammy users, you can enabled ratelimits. Make sure your ip headers are properly forwarded if you're using a reverse proxy. Also see `server.trustProxy`. If this is enabled, all other ratelimit related settings are required. + +Example: `false` + +### `ratelimits.redisUrl` + +Redis connection URL for storing ratelimit data. Just uses plain redis without any modules. + +Example: `redis://localhost:6379` diff --git a/content/4.backend/3.changelog.md b/content/4.backend/3.changelog.md index da748f7..488e3ec 100644 --- a/content/4.backend/3.changelog.md +++ b/content/4.backend/3.changelog.md @@ -1,6 +1,13 @@ --- title: 'Changelog' --- -# Version 1.0.0 +# Version 1.1.5 -Changelog goes here +Initial version of the backend. + +- Prometheus metrics endpoint +- Account creation/deletion endpoints +- Endpoints for importing old account data +- Endpoints for syncing data +- Ratelimit system +- Captcha system diff --git a/content/4.backend/4.upgrade.md b/content/4.backend/4.upgrade.md index 980e6cd..9cc7e6f 100644 --- a/content/4.backend/4.upgrade.md +++ b/content/4.backend/4.upgrade.md @@ -1,4 +1,7 @@ --- title: 'Upgrade guide' --- -No upgrades to be done yet + +# Upgrade guide + +There is only one major version, there is nothing to write here yet. From 3d759542358512c19cb22e81b1597cb301e6e3da Mon Sep 17 00:00:00 2001 From: mrjvs Date: Tue, 12 Dec 2023 22:27:15 +0100 Subject: [PATCH 6/8] Add update information --- content/1.self-hosting/2.use-backend.md | 11 ++++++- content/1.self-hosting/3.about-pwa.md | 17 +++++++++-- content/3.client/0.introduction.md | 12 +++++++- content/3.client/4.changelog.md | 39 ++++++++++++++++++++++++- content/3.client/5.upgrade.md | 10 +++++-- 5 files changed, 82 insertions(+), 7 deletions(-) diff --git a/content/1.self-hosting/2.use-backend.md b/content/1.self-hosting/2.use-backend.md index ebc9701..457100f 100644 --- a/content/1.self-hosting/2.use-backend.md +++ b/content/1.self-hosting/2.use-backend.md @@ -3,4 +3,13 @@ title: 'Configure backend' --- # Configure your client with the backend -// CONFIGURE IT HERE \ No newline at end of file +If you would like to use an alternative backend server (The server responsible for saving user data across devices) then you can specify your own URL **without needing to host your own movie-web frontend!** + +::alert{type="danger"} +Changing your backend server will log you out of your account - make sure you have a copy of your 12-word passphrase saved safely in case you need to go back! +:: + +1. On movie-web, got to your settings page by click the menu icon at the top right and then `Settings`. +1. Scroll down the page to the section named `Connections` where there is a toggle named `Custom server`. +1. Enable the `Custom server` toggle and enter your backend URL in the input box named `Custom server URL`. +1. Click `Save` at the bottom right corner of your screen. diff --git a/content/1.self-hosting/3.about-pwa.md b/content/1.self-hosting/3.about-pwa.md index 290e163..fdebfd2 100644 --- a/content/1.self-hosting/3.about-pwa.md +++ b/content/1.self-hosting/3.about-pwa.md @@ -1,7 +1,20 @@ --- title: 'PWA vs no-PWA' --- -# About selfhosting PWA +# About Selfhosting PWA -// EXPLAIN WHY ITS A BAD IDEA, BUT ALSO HOW TO DO IT +So that clients can have a more native app-like experience on mobile, movie-web has a function to support Progessive Web Apps (PWA). You can learn more about what a PWA is [here](https://developer.mozilla.org/en-US/docs/Web/Progressive_web_apps/Guides/What_is_a_progressive_web_app). +In movie-web version 3, PWAs were enabled by default. Unfortunately, PWAs tend to come with caching complications that can be tricky to resolve. That's why we have **disabled** PWAs by default in movie-web version 4. If you are upgrading from version 3, please [read our upgrade guide](../3.client/5.upgrade.md) for more information. + +::alert{type="warning"} +Enabling PWAs means that you cannot disable it again - Please only proceed if you know what you are doing! +:: + +## If you are running movie-web on a hoster such as Vercel +If your hosting is building movie-web from the source, you can enable PWAs using environment variables. The full environment variable reference can be found [here](../3.client/3.configuration.md) but for PWAs we are only interested in `VITE_PWA_ENABLED`. + +Setting `VITE_PWA_ENABLED` to `true` will generate a [service worker file](https://developer.mozilla.org/en-US/docs/Web/Progressive_web_apps/Guides/Making_PWAs_installable#service_worker) and a [web app manifest](https://developer.mozilla.org/en-US/docs/Web/Progressive_web_apps/Guides/Making_PWAs_installable#the_web_app_manifest) which enable the website to be installed from a [web browser both on Desktop and on Mobile](https://developer.mozilla.org/en-US/docs/Web/Progressive_web_apps/Guides/Making_PWAs_installable#installation_from_the_web). + +## If you are running movie-web using the .zip files +If you are downloading the movie-web `zip` files from our GitHub and installing them on a static website hoster, then all you need to do is to make sure to download the [`movie-web.pwa.zip`](https://github.com/movie-web/movie-web/releases/latest/download/movie-web.pwa.zip) file instead of the `movie-web.zip` file! \ No newline at end of file diff --git a/content/3.client/0.introduction.md b/content/3.client/0.introduction.md index f93a948..40fdb02 100644 --- a/content/3.client/0.introduction.md +++ b/content/3.client/0.introduction.md @@ -3,4 +3,14 @@ title: 'Introduction' --- # Introduction to the client -// EXPLAIN WHAT THE CLIENT DOES \ No newline at end of file +The client is what the main part of the application, it houses the interface and all of the scraping logic. + +## PWA + +The client can be optionally ran as a PWA. This can be hard to do correctly and really hard to reverse, so it's generally not recommended to do so if you don't have experience hosting PWA's. + +You can read more about it [here](../1.self-hosting/3.about-pwa.md). + +## Configuration + +The client has a decent amount of configuration options. You can view them all [here](./3.configuration.md). diff --git a/content/3.client/4.changelog.md b/content/3.client/4.changelog.md index 4a61910..8eb3543 100644 --- a/content/3.client/4.changelog.md +++ b/content/3.client/4.changelog.md @@ -3,4 +3,41 @@ title: 'Changelog' --- # Version 4.0.0 -// CHANGELOG GOES HERE +::alert{type="info"} +If you are upgrading from a previous version, make sure to read [the upgrade guide](5.upgrade.md). +:: + +### Bug fixes +- Fixed bug where video player overlays the controls on IOS. +- Fixed bug where you are kicked out of the fullscreen when switching episode. +- Fixed bug where you cannot select a different episode if first episode fails to load. + +### Enhancements +- Completely redesigned look and feel for the entire website. +- Added FAQ and DMCA pages. +- Source loading page is more detailed. +- Video player has been remade from scratch, all internal workings are brand new. +- You can now input numbers manually into the subtitle customization menu. +- Subtitle delay can now be increased outside of the slider range by inputting manual numbers. +- Movie and show URL's now include the name of the media in the link, makes it easier at a glance to see what a link is about. +- Instructions on how to download are now given inside the app. +- Chromecasting no longer shows captions on the web player (still doesnt show on cast receiver) +- Chromecasting now supports HLS + +### New features +- Quality selector! You can now switch qualities. +- Search bar no longer requires you to choose between shows or movies. +- Visit `/s/:term` to quickly watch something. For example `https://movie-web.app/s/hamilton`. +- You can now add movie-web as a search provider in your browser. +- Safari now has subtitles when fullscreening. +- A next episode button will appear when close to the end of an episode, allowing quick switching to next episode. +- When seeking and hovering over progress bar, you will now see a thumbnail for the place you're hovering. +- Subtitles now have language flag next to them. +- Your subtitle preference gets saved. +- Turn on subtitles using keyboard shortcut `C`. +- Self-hosters can now test their configurations at the `/admin` page. +- Subtitles can now be downloaded. +- Sync your data through online accounts (using passphrases for maximum privacy) +- You can now choose your own worker URL set in the settings page. +- A custom backend server URL can be set on the settings page. +- On the settings page, you can now choose between multiple themes. diff --git a/content/3.client/5.upgrade.md b/content/3.client/5.upgrade.md index b95c51b..33cc0c6 100644 --- a/content/3.client/5.upgrade.md +++ b/content/3.client/5.upgrade.md @@ -1,6 +1,12 @@ --- title: 'Upgrade guide' --- -## Upgrade guide +# Upgrade guide -// UPGRADE GUIDE HERE +## From `3.X` to `4.0.0` + +You will need the latest version of the proxy worker. Redeploy a new worker using [our self-hosting guide](../2.proxy/1.deploy.md). + +After you have the new worker, you will need to [get the new movie-web deployment files](https://github.com/movie-web/movie-web/releases/latest). **You CANNOT use the non-PWA version**. To upgrade safely without any complications, you need to update with `movie-web.pwa.zip`, Not the non-PWA version. + +In the future, you will **ALWAYS** need to go with the PWA option. You cannot downgrade to non-PWA version without facing many caching complications. From 751b7294f6e6b416f2c70929fdbb7a42dfaf2c9a Mon Sep 17 00:00:00 2001 From: mrjvs Date: Wed, 13 Dec 2023 00:08:31 +0100 Subject: [PATCH 7/8] Add troubleshooting guide --- content/1.self-hosting/4.troubleshooting.md | 38 +++++++++++++++++++-- content/3.client/5.upgrade.md | 2 +- 2 files changed, 37 insertions(+), 3 deletions(-) diff --git a/content/1.self-hosting/4.troubleshooting.md b/content/1.self-hosting/4.troubleshooting.md index 22608af..7c330b1 100644 --- a/content/1.self-hosting/4.troubleshooting.md +++ b/content/1.self-hosting/4.troubleshooting.md @@ -3,6 +3,40 @@ title: 'Troubleshooting' --- # Troubleshooting -// EXPLAIN HOW TO TROUBLESHOOT +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. -// MENTION ADMIN PAGE FOR TROUBLESHOOTING + +## "Failed to find media, try again!" while searching + +This is likely a misconfigured TMDB api key. Verify that TMDB isn't working by going to `/admin` or `/#/admin`. Then clicking `Test TMDB`. + +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`. + +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`. + +It should give you the name that you have configured as backend with the latest version of the backend. + +If the test gives you an error, your backend URL configuration option likely has a typo. + +If the version is not the latest version, you should update your backend instance. + +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) diff --git a/content/3.client/5.upgrade.md b/content/3.client/5.upgrade.md index 33cc0c6..2ff7431 100644 --- a/content/3.client/5.upgrade.md +++ b/content/3.client/5.upgrade.md @@ -3,7 +3,7 @@ title: 'Upgrade guide' --- # Upgrade guide -## From `3.X` to `4.0.0` +## 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). From 5de0fe3d67f0067f50242c03b8f307f166dcc7e8 Mon Sep 17 00:00:00 2001 From: mrjvs Date: Wed, 13 Dec 2023 00:35:12 +0100 Subject: [PATCH 8/8] Add some repo files --- .github/CODEOWNERS | 3 +++ .github/CODE_OF_CONDUCT.md | 1 + .github/CONTRIBUTING.md | 1 + 3 files changed, 5 insertions(+) create mode 100644 .github/CODEOWNERS create mode 100644 .github/CODE_OF_CONDUCT.md create mode 100644 .github/CONTRIBUTING.md diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS new file mode 100644 index 0000000..d0f0ca6 --- /dev/null +++ b/.github/CODEOWNERS @@ -0,0 +1,3 @@ +* @movie-web/core + +.github @binaryoverload diff --git a/.github/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..4322215 --- /dev/null +++ b/.github/CODE_OF_CONDUCT.md @@ -0,0 +1 @@ +Please visit the [main document at primary repository](https://github.com/movie-web/movie-web/blob/dev/.github/CODE_OF_CONDUCT.md). \ No newline at end of file diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 0000000..1b605cf --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1 @@ +Please visit the [main document at primary repository](https://github.com/movie-web/movie-web/blob/dev/.github/CONTRIBUTING.md). \ No newline at end of file