mirror of
https://github.com/p-stream/p-stream.git
synced 2026-03-11 17:55:33 +00:00
update docs reference
This commit is contained in:
parent
b2648e1980
commit
77f9127628
9 changed files with 18 additions and 24 deletions
2
.github/CONTRIBUTING.md
vendored
2
.github/CONTRIBUTING.md
vendored
|
|
@ -99,7 +99,7 @@ Here are some tips to make sure that your pull requests are :pinched_fingers: fi
|
||||||
|
|
||||||
Language contributions help P-Stream massively, allowing people worldwide to use our app!
|
Language contributions help P-Stream massively, allowing people worldwide to use our app!
|
||||||
|
|
||||||
We use Weblate for crowdsourcing our translations. [Click here to go to our translation tool.](https://docs.pstream.mov/links/weblate)
|
We use Weblate for crowdsourcing our translations.
|
||||||
|
|
||||||
1. First make sure you make an account. (click the link above)
|
1. First make sure you make an account. (click the link above)
|
||||||
2. Click the language you want to help translate, if it's not listed you can click the plus top left to add a new language.
|
2. Click the language you want to help translate, if it's not listed you can click the plus top left to add a new language.
|
||||||
|
|
|
||||||
18
README.md
18
README.md
|
|
@ -1,6 +1,6 @@
|
||||||
# P-Stream
|
# P-Stream
|
||||||
|
|
||||||
[](https://docs.pstream.mov)
|
[](https://p-stream.github.io/docs/)
|
||||||
|
|
||||||
## Quick Deploy
|
## Quick Deploy
|
||||||
|
|
||||||
|
|
@ -8,20 +8,18 @@
|
||||||
|
|
||||||
[](https://deploy.workers.cloudflare.com/?url=https://github.com/p-stream/p-stream)
|
[](https://deploy.workers.cloudflare.com/?url=https://github.com/p-stream/p-stream)
|
||||||
|
|
||||||
**NOTE: To self-host, more setup is required. Check the [docs](https://docs.pstream.mov) to properly set up!!!!**
|
**NOTE: To self-host, more setup is required. Check the [docs](https://p-stream.github.io/docs/) to properly set up!!!!**
|
||||||
|
|
||||||
## Links And Resources
|
## Links And Resources
|
||||||
|
|
||||||
| Service | Link | Source Code |
|
| Service | Link | Source Code |
|
||||||
| ------------- | ----------------------------------------------- | ------------------------------------------------------- |
|
| ------------- | ----------------------------------------------- | ------------------------------------------------------- |
|
||||||
| P-Stream Docs | [docs](https://docs.pstream.mov) | [source code](https://github.com/p-stream/docs) |
|
| P-Stream Docs | [docs](https://p-stream.github.io/docs/) | [source code](https://github.com/p-stream/docs) |
|
||||||
| Extension | [extension](https://docs.pstream.mov/extension) | [source code](https://github.com/p-stream/browser-ext) |
|
| Extension | [extension](https://p-stream.github.io/docs/extension) | [source code](https://github.com/p-stream/browser-ext) |
|
||||||
| Proxy | [simple-proxy](https://docs.pstream.mov/proxy) | [source code](https://github.com/p-stream/simple-proxy) |
|
| Proxy | [simple-proxy](https://p-stream.github.io/docs/proxy) | [source code](https://github.com/p-stream/simple-proxy) |
|
||||||
| Backend | [backend](https://server.fifthwit.net) | [source code](https://github.com/p-stream/backend) |
|
| Backend | [backend](https://github.com/p-stream/backend) | [source code](https://github.com/p-stream/backend) |
|
||||||
| Frontend | [P-Stream](https://docs.pstream.mov/instances) | [source code](https://github.com/p-stream/p-stream) |
|
| Frontend | [P-Stream](https://p-stream.github.io/docs/instances) | [source code](https://github.com/p-stream/p-stream) |
|
||||||
| Weblate | [weblate](https://weblate.pstream.mov) | |
|
| Weblate | [weblate](https://p-stream.github.io/docs/weblate) | |
|
||||||
|
|
||||||
**_I provide these if you are not able to host yourself, though I do encourage hosting the frontend._**
|
|
||||||
|
|
||||||
## Referrers
|
## Referrers
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -2,11 +2,11 @@
|
||||||
<rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom">
|
<rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom">
|
||||||
<channel>
|
<channel>
|
||||||
<title>P-Stream Notifications</title>
|
<title>P-Stream Notifications</title>
|
||||||
<link>https://pstream.mov</link>
|
<link>https://raw.githubusercontent.com/p-stream/p-stream/production/public/notifications.xml</link>
|
||||||
<description>Site updates and important notifications for P-Stream users</description>
|
<description>Site updates and important notifications for P-Stream users</description>
|
||||||
<language>en</language>
|
<language>en</language>
|
||||||
<lastBuildDate>Mon, 29 Sep 2025 18:00:00 MST</lastBuildDate>
|
<lastBuildDate>Mon, 29 Sep 2025 18:00:00 MST</lastBuildDate>
|
||||||
<atom:link href="https://pstream.mov/notifications.xml" rel="self" type="application/rss+xml" />
|
<atom:link href="https://raw.githubusercontent.com/p-stream/p-stream/production/public/notifications.xml" rel="self" type="application/rss+xml" />
|
||||||
|
|
||||||
<item>
|
<item>
|
||||||
<guid>notification-061</guid>
|
<guid>notification-061</guid>
|
||||||
|
|
|
||||||
|
|
@ -4,7 +4,7 @@ Locales are difficult, here is some guidance.
|
||||||
|
|
||||||
## Process on adding new languages
|
## Process on adding new languages
|
||||||
|
|
||||||
1. Use [Weblate](https://docs.pstream.mov/links/weblate) to add translations, see contributing guidelines.
|
1. Use [Weblate](https://github.com/p-stream/p-stream) to add translations, see contributing guidelines.
|
||||||
2. Add your language to `@/assets/languages.ts`. Must be in ISO format (ISO-639 for language and ISO-3166 for country/region). For joke languages, use any format.
|
2. Add your language to `@/assets/languages.ts`. Must be in ISO format (ISO-639 for language and ISO-3166 for country/region). For joke languages, use any format.
|
||||||
3. If the language code doesn't have a region specified (Such as in `pt-BR`, `BR` being the region), add a default region in `@/utils/language.ts` at `defaultLanguageCodes`
|
3. If the language code doesn't have a region specified (Such as in `pt-BR`, `BR` being the region), add a default region in `@/utils/language.ts` at `defaultLanguageCodes`
|
||||||
4. If the language code doesn't contain a region (Such as in `zh-Hant`), add a default country in `@/utils/language.ts` at `countryPriority`.
|
4. If the language code doesn't contain a region (Such as in `zh-Hant`), add a default country in `@/utils/language.ts` at `countryPriority`.
|
||||||
|
|
|
||||||
|
|
@ -11,7 +11,7 @@ import type {
|
||||||
TraktReleaseResponse,
|
TraktReleaseResponse,
|
||||||
} from "./types/trakt";
|
} from "./types/trakt";
|
||||||
|
|
||||||
export const TRAKT_BASE_URL = "https://fed-airdate.pstream.mov";
|
export const TRAKT_BASE_URL = "";
|
||||||
|
|
||||||
// Token cookie configuration
|
// Token cookie configuration
|
||||||
const TOKEN_COOKIE_NAME = "turnstile_token";
|
const TOKEN_COOKIE_NAME = "turnstile_token";
|
||||||
|
|
|
||||||
|
|
@ -349,10 +349,6 @@ export function LinksDropdown(props: { children: React.ReactNode }) {
|
||||||
)}
|
)}
|
||||||
<CircleDropdownLink href={conf().FLUXER_LINK} icon={Icons.FLUXER} />
|
<CircleDropdownLink href={conf().FLUXER_LINK} icon={Icons.FLUXER} />
|
||||||
<CircleDropdownLink href="/support" icon={Icons.SUPPORT} />
|
<CircleDropdownLink href="/support" icon={Icons.SUPPORT} />
|
||||||
<CircleDropdownLink
|
|
||||||
href="https://rentry.co/nnqtas3e"
|
|
||||||
icon={Icons.TIP_JAR}
|
|
||||||
/>
|
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
</Transition>
|
</Transition>
|
||||||
|
|
|
||||||
|
|
@ -11,7 +11,7 @@ import { getTurnstileToken } from "@/utils/turnstile";
|
||||||
|
|
||||||
// Thanks Nemo for this API
|
// Thanks Nemo for this API
|
||||||
const THE_INTRO_DB_BASE_URL = "https://api.theintrodb.org/v2";
|
const THE_INTRO_DB_BASE_URL = "https://api.theintrodb.org/v2";
|
||||||
const FED_SKIPS_BASE_URL = "https://fed-skips.pstream.mov";
|
const FED_SKIPS_BASE_URL = "";
|
||||||
const INTRODB_BASE_URL = "https://api.introdb.app/intro";
|
const INTRODB_BASE_URL = "https://api.introdb.app/intro";
|
||||||
const MAX_RETRIES = 3;
|
const MAX_RETRIES = 3;
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -116,7 +116,7 @@ function ProxyEdit({
|
||||||
</p>
|
</p>
|
||||||
<p className="max-w-[30rem] font-medium">
|
<p className="max-w-[30rem] font-medium">
|
||||||
<Trans i18nKey="settings.connections.workers.description">
|
<Trans i18nKey="settings.connections.workers.description">
|
||||||
<MwLink to="https://docs.pstream.mov/proxy/deploy">
|
<MwLink to="https://p-stream.github.io/docs/proxy/deploy">
|
||||||
{t("settings.connections.workers.documentation")}
|
{t("settings.connections.workers.documentation")}
|
||||||
</MwLink>
|
</MwLink>
|
||||||
</Trans>
|
</Trans>
|
||||||
|
|
@ -237,7 +237,7 @@ function BackendEdit({ backendUrl, setBackendUrl }: BackendEditProps) {
|
||||||
</p>
|
</p>
|
||||||
<p className="max-w-[30rem] font-medium">
|
<p className="max-w-[30rem] font-medium">
|
||||||
<Trans i18nKey="settings.connections.server.description">
|
<Trans i18nKey="settings.connections.server.description">
|
||||||
<MwLink to="https://docs.pstream.mov/backend/deploy">
|
<MwLink to="https://p-stream.github.io/docs/backend/deploy">
|
||||||
{t("settings.connections.server.documentation")}
|
{t("settings.connections.server.documentation")}
|
||||||
</MwLink>
|
</MwLink>
|
||||||
</Trans>
|
</Trans>
|
||||||
|
|
|
||||||
|
|
@ -140,11 +140,11 @@ export function conf(): RuntimeConfig {
|
||||||
DMCA_EMAIL: getKey("DMCA_EMAIL"),
|
DMCA_EMAIL: getKey("DMCA_EMAIL"),
|
||||||
ONBOARDING_CHROME_EXTENSION_INSTALL_LINK: getKey(
|
ONBOARDING_CHROME_EXTENSION_INSTALL_LINK: getKey(
|
||||||
"ONBOARDING_CHROME_EXTENSION_INSTALL_LINK",
|
"ONBOARDING_CHROME_EXTENSION_INSTALL_LINK",
|
||||||
"https://docs.pstream.mov/extension",
|
"https://p-stream.github.io/docs/extension",
|
||||||
),
|
),
|
||||||
ONBOARDING_FIREFOX_EXTENSION_INSTALL_LINK: getKey(
|
ONBOARDING_FIREFOX_EXTENSION_INSTALL_LINK: getKey(
|
||||||
"ONBOARDING_FIREFOX_EXTENSION_INSTALL_LINK",
|
"ONBOARDING_FIREFOX_EXTENSION_INSTALL_LINK",
|
||||||
"https://docs.pstream.mov/extension",
|
"https://p-stream.github.io/docs/extension",
|
||||||
),
|
),
|
||||||
ONBOARDING_PROXY_INSTALL_LINK: getKey("ONBOARDING_PROXY_INSTALL_LINK"),
|
ONBOARDING_PROXY_INSTALL_LINK: getKey("ONBOARDING_PROXY_INSTALL_LINK"),
|
||||||
BACKEND_URLS: getKey("BACKEND_URL", BACKEND_URL)
|
BACKEND_URLS: getKey("BACKEND_URL", BACKEND_URL)
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue