Setup navigation structure

This commit is contained in:
mrjvs
2023-12-12 19:25:35 +01:00
parent ed407e2d76
commit 4f9e1f0974
21 changed files with 105 additions and 9 deletions

View File

@@ -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)

View File

@@ -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)

View File

@@ -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).

View File

@@ -0,0 +1,3 @@
# Setting up the backend
// EXPLAIN HOW TO HOST THE BACKEND

View File

@@ -0,0 +1,3 @@
# Configure your client with the backend
// EXPLAIN HOW TO SET BACKEND URL ON OFFICIAL INSTANCE

View File

@@ -1,2 +1,3 @@
title: 'Self-Hosting'
icon: mdi:server-network
navigation.redirect: /self-hosting/hosting-intro

View File

@@ -0,0 +1,3 @@
# Introduction to the proxy
// EXPLAIN WHAT A PROXY IS

View File

@@ -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

3
content/3.proxy/_dir.yml Normal file
View File

@@ -0,0 +1,3 @@
title: 'Proxy'
icon: mdi:server-network
navigation.redirect: /proxy/introduction

View File

@@ -0,0 +1,3 @@
# Introduction to the client
// EXPLAIN WHAT THE CLIENT DOES

View File

@@ -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

View File

@@ -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`

View File

@@ -0,0 +1,3 @@
# Version 4.0.0
Changelog goes here

View File

@@ -0,0 +1,3 @@
## From `3.*` to `4.0.0`
Upgrade guide goes here

View File

@@ -0,0 +1,3 @@
title: 'Client'
icon: mdi:server-network
navigation.redirect: /client/introduction

View File

@@ -0,0 +1,3 @@
# Introduction to the backend
// EXPLAIN WHAT THE BACKEND DOES

View File

@@ -0,0 +1,7 @@
# Deploying the backend
// FILL PAGE
## Method 1 - docker
// EXPLAIN HOW TO DEPLOY WITH DOCKER

View File

@@ -0,0 +1,3 @@
# Backend Config Reference
// ADD CONFIGURATION REFERENCE

View File

@@ -0,0 +1,3 @@
# Version 1.0.0
Changelog goes here

View File

@@ -0,0 +1 @@
No upgrades to be done yet

View File

@@ -0,0 +1,3 @@
title: 'Backend'
icon: mdi:server-network
navigation.redirect: /backend/introduction