Merge pull request #5 from movie-web/dev

Deploy docs
This commit is contained in:
William Oldham 2023-12-21 18:20:22 +00:00 committed by GitHub
commit 7b67e38741
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
6 changed files with 64 additions and 6 deletions

View File

@ -1,9 +1,9 @@
export default defineAppConfig({ export default defineAppConfig({
docus: { docus: {
title: 'movie-web', title: 'movie-web',
description: 'For all your media scraping needs', description: 'Hosting documentation for movie-web',
socials: { socials: {
github: 'movie-web/providers', github: 'movie-web/movie-web',
}, },
image: '', image: '',
aside: { aside: {

View File

@ -0,0 +1,16 @@
---
title: 'Configuration'
---
# Proxy Config Reference
The environment variables for the proxy is different to adjust per platform. So we will only be listed the variables themselves, it's your job to figure out to apply them to your platform.
# Reference
### `TURNSTILE_SECRET`
Turnstile secret key from the cloudflare dashboard. To enable turnstile completely you will also need `JWT_SECRET` configured.
If you want turnstile verification working correctly, you will also need to configure the turnstile key on the client, not just on the proxy.
### `JWT_SECRET`
A jwt secret key. **Must be 32 characters long.** Can be any random secret.

View File

@ -0,0 +1,15 @@
---
title: 'Changelog'
---
# Version 2.1.0
- Added turnstile integration to secure your workers from abuse.
# Version 2.0.1
- bugfix where sometimes body would double read
- bugfix where sometimes no response would be given at all due to race condition
# Version 2.0.0
- full rewrite, now supports multiple platforms: nodejs, cloudflare, aws lambda
- standard proxy headers are no longer sent through. Which now doesn't send a client ip through anymore.

View File

@ -92,6 +92,14 @@ Example: `VITE_DISALLOWED_IDS=series-123,movie-456`
Default: `""` Default: `""`
### `VITE_TURNSTILE_KEY`
The turnstile key for cloudflare captchas. It's used to authenticate request to proxy workers (or providers api).
The proxy workers will need to be configured to accept these captcha tokens, otherwise it has no effect for security.
Example: `""`
## Config reference - Environment Variables Only ## Config reference - Environment Variables Only
::alert{type="danger"} ::alert{type="danger"}
:icon{name="material-symbols:warning-rounded"} These configuration keys are specific to environment variables, they **only** work as environment variables **set at build time**. :icon{name="material-symbols:warning-rounded"} These configuration keys are specific to environment variables, they **only** work as environment variables **set at build time**.
@ -125,3 +133,4 @@ when enabling you **must** also set `VITE_APP_DOMAIN`.
`VITE_OPENSEARCH_ENABLED` must be set to `true` to be enabled. Anything else will be treated as turned off, it's case sensitive so `True` will also be disabled. `VITE_OPENSEARCH_ENABLED` must be set to `true` to be enabled. Anything else will be treated as turned off, it's case sensitive so `True` will also be disabled.
Example: `VITE_OPENSEARCH_ENABLED=true` Example: `VITE_OPENSEARCH_ENABLED=true`

View File

@ -1,6 +1,24 @@
--- ---
title: 'Changelog' title: 'Changelog'
--- ---
# Version 4.1.0
- Added new translations: arabic, chinese, latvian, thai, nepali, dutch
- Translation improvements: turkish, hebrew
- Fixed text directions for captions
- Anti-tamper script has been removed and replaced with turnstile (this is the devtools blocked, you can use devtools again)
- Added way to add the providers-api instead of proxies
# Version 4.0.2
- Added new translations: Hebrew, French, German, Swedish, Turkish.
- Added minion joke language. Blame @jip_.
- Thumbnail preview no longer goes under the next episode button.
- Passphrase inputs are now actual password fields, so they may act nicer with password managers.
- The player now remembers what your subtitle settings were, so no longer you need to keep selecting english everytime you watch.
- Fix home link not working with /s/:term shortcut.
- Swedish flag is now an actual Swedish flag.
- Fix for various layout issues with small width mobile screens.
# Version 4.0.0 # Version 4.0.0
::alert{type="info"} ::alert{type="info"}

View File

@ -21,14 +21,14 @@ This method uses nesting. So the key `server.basePath`. Will result in a json fi
## Method 2 - `.env` ## 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: The environment variable names use double underscores as separators and `MW_` as the prefix. So the key `server.basePath` will result in the .env file like this:
```sh ```sh
MB_SERVER__BASE_PATH=/backend MW_SERVER__BASE_PATH=/backend
``` ```
## Method 3 - environment ## 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. This method is identical to the `.env` method listed above, but you add the variables to the environment instead of writing it in a file.
# Reference # Reference