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