mirror of https://github.com/synctv-org/synctv
You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
258 lines
11 KiB
JavaScript
258 lines
11 KiB
JavaScript
import { defineConfig } from 'astro/config';
|
|
import starlight from '@astrojs/starlight';
|
|
import starlightCodeblockFullscreen from 'starlight-codeblock-fullscreen';
|
|
import starlightLinksValidator from 'starlight-links-validator';
|
|
import { docsBase, docsSite, githubEditUrl, githubUrl } from './src/lib/project';
|
|
|
|
export default defineConfig({
|
|
site: docsSite,
|
|
base: docsBase,
|
|
redirects: {
|
|
'/install/quick-start': '/install/docker-compose',
|
|
'/en/install/quick-start': '/en/install/docker-compose',
|
|
},
|
|
integrations: [
|
|
starlight({
|
|
title: {
|
|
'zh-CN': 'SyncTV 文档',
|
|
en: 'SyncTV Docs',
|
|
},
|
|
description: 'SyncTV Server 安装、配置、管理和运维文档',
|
|
titleDelimiter: '·',
|
|
logo: {
|
|
src: './public/logo-notext.svg',
|
|
alt: 'SyncTV',
|
|
},
|
|
defaultLocale: 'root',
|
|
locales: {
|
|
root: {
|
|
label: '简体中文',
|
|
lang: 'zh-CN',
|
|
},
|
|
en: {
|
|
label: 'English',
|
|
lang: 'en',
|
|
},
|
|
},
|
|
favicon: '/favicon.svg',
|
|
head: [
|
|
{
|
|
tag: 'meta',
|
|
attrs: {
|
|
property: 'og:type',
|
|
content: 'website',
|
|
},
|
|
},
|
|
{
|
|
tag: 'meta',
|
|
attrs: {
|
|
name: 'twitter:card',
|
|
content: 'summary_large_image',
|
|
},
|
|
},
|
|
{
|
|
tag: 'meta',
|
|
attrs: {
|
|
property: 'og:image',
|
|
content: '/og.svg',
|
|
},
|
|
},
|
|
{
|
|
tag: 'meta',
|
|
attrs: {
|
|
name: 'twitter:image',
|
|
content: '/og.svg',
|
|
},
|
|
},
|
|
{
|
|
tag: 'meta',
|
|
attrs: {
|
|
name: 'theme-color',
|
|
content: '#ffffff',
|
|
media: '(prefers-color-scheme: light)',
|
|
},
|
|
},
|
|
{
|
|
tag: 'meta',
|
|
attrs: {
|
|
name: 'theme-color',
|
|
content: '#111216',
|
|
media: '(prefers-color-scheme: dark)',
|
|
},
|
|
},
|
|
],
|
|
customCss: ['./src/styles/custom.css'],
|
|
editLink: {
|
|
baseUrl: githubEditUrl,
|
|
},
|
|
lastUpdated: true,
|
|
tableOfContents: {
|
|
minHeadingLevel: 2,
|
|
maxHeadingLevel: 3,
|
|
},
|
|
pagefind: {
|
|
ranking: {
|
|
pageLength: 0.05,
|
|
termFrequency: 0.2,
|
|
termSaturation: 1.4,
|
|
termSimilarity: 6,
|
|
},
|
|
},
|
|
expressiveCode: {
|
|
emitExternalStylesheet: true,
|
|
removeUnusedThemes: true,
|
|
styleOverrides: {
|
|
borderRadius: '6px',
|
|
},
|
|
},
|
|
plugins: [
|
|
starlightLinksValidator({
|
|
errorOnRelativeLinks: false,
|
|
failOnError: true,
|
|
}),
|
|
starlightCodeblockFullscreen({
|
|
addToUntitledBlocks: true,
|
|
enableEscapeKey: true,
|
|
exitOnBrowserBack: true,
|
|
}),
|
|
],
|
|
social: [
|
|
{
|
|
icon: 'github',
|
|
label: 'GitHub',
|
|
href: githubUrl,
|
|
},
|
|
],
|
|
sidebar: [
|
|
{
|
|
label: '开始使用',
|
|
translations: { en: 'Get Started' },
|
|
items: [
|
|
{ label: '客户端下载', translations: { en: 'Client Downloads' }, slug: 'install/downloads' },
|
|
{ label: '用户支持', translations: { en: 'User Support' }, slug: 'support' },
|
|
{ label: '选择部署方式', translations: { en: 'Choose a Deployment' }, slug: 'install/choose-path' },
|
|
{ label: 'Docker Compose 安装', translations: { en: 'Install with Docker Compose' }, slug: 'install/docker-compose' },
|
|
{ label: 'Helm 部署', translations: { en: 'Helm Deployment' }, slug: 'install/helm' },
|
|
{ label: '生产部署清单', translations: { en: 'Production Checklist' }, slug: 'install/production-checklist' },
|
|
],
|
|
collapsed: false,
|
|
},
|
|
{
|
|
label: '升级与数据',
|
|
translations: { en: 'Upgrades and Data' },
|
|
items: [
|
|
{ label: '升级与迁移', translations: { en: 'Upgrades and Migrations' }, slug: 'operations/upgrades' },
|
|
{ label: '备份与恢复', translations: { en: 'Backup and Restore' }, slug: 'operations/backup-restore' },
|
|
{ label: '数据与保留策略', translations: { en: 'Data and Retention' }, slug: 'operations/data-retention' },
|
|
{ label: '资源生命周期', translations: { en: 'Resource Lifecycle' }, slug: 'operations/resource-lifecycle' },
|
|
],
|
|
collapsed: true,
|
|
},
|
|
{
|
|
label: '配置',
|
|
translations: { en: 'Configuration' },
|
|
items: [
|
|
{ label: '配置加载与优先级', translations: { en: 'Loading and Precedence' }, slug: 'configuration/how-configuration-works' },
|
|
{ label: '配置示例', translations: { en: 'Configuration Examples' }, slug: 'configuration/full-example' },
|
|
{ label: '验证配置', translations: { en: 'Validate Configuration' }, slug: 'configuration/validation' },
|
|
{ label: '安全与密钥', translations: { en: 'Security and Secrets' }, slug: 'configuration/security' },
|
|
{ label: '公开 ID', translations: { en: 'Public IDs' }, slug: 'configuration/public-ids' },
|
|
{ label: '数据库与 Redis', translations: { en: 'Database and Redis' }, slug: 'configuration/database-and-redis' },
|
|
{ label: '服务监听与运行路径', translations: { en: 'Listener and Runtime Paths' }, slug: 'configuration/server-and-runtime' },
|
|
{ label: '初始化 root 用户', translations: { en: 'Bootstrap Root User' }, slug: 'configuration/bootstrap' },
|
|
{
|
|
label: '认证与外部服务',
|
|
translations: { en: 'Authentication and External Services' },
|
|
items: [
|
|
{ label: 'WebAuthn / Passkeys', slug: 'configuration/webauthn' },
|
|
{ label: '邮件与 OAuth2', translations: { en: 'Email and OAuth2' }, slug: 'configuration/email-oauth2' },
|
|
{ label: '媒体 Provider', translations: { en: 'Media Providers' }, slug: 'configuration/media-providers' },
|
|
],
|
|
},
|
|
{
|
|
label: '媒体与实时通信',
|
|
translations: { en: 'Media and Realtime' },
|
|
items: [
|
|
{ label: 'WebRTC', slug: 'configuration/webrtc' },
|
|
{ label: '直播', translations: { en: 'Livestreaming' }, slug: 'configuration/livestream' },
|
|
],
|
|
},
|
|
{
|
|
label: '扩展与性能',
|
|
translations: { en: 'Scale and Performance' },
|
|
items: [
|
|
{ label: '集群', translations: { en: 'Cluster' }, slug: 'configuration/cluster' },
|
|
{ label: 'Metrics', slug: 'configuration/metrics' },
|
|
{ label: '业务缓存', translations: { en: 'Business Cache' }, slug: 'configuration/cache' },
|
|
{ label: 'Proxy slice cache', slug: 'configuration/proxy-slice-cache' },
|
|
{ label: '限流与连接限制', translations: { en: 'Rate and Connection Limits' }, slug: 'configuration/rate-limits' },
|
|
{ label: '内部缓冲区', translations: { en: 'Internal Buffers' }, slug: 'configuration/buffer-sizes' },
|
|
],
|
|
},
|
|
],
|
|
collapsed: true,
|
|
},
|
|
{
|
|
label: '管理',
|
|
translations: { en: 'Administration' },
|
|
items: [
|
|
{ label: '管理入口', translations: { en: 'Administration Overview' }, slug: 'admin' },
|
|
{ label: '用户', translations: { en: 'Users' }, slug: 'admin/users' },
|
|
{ label: '房间与成员', translations: { en: 'Rooms and Members' }, slug: 'admin/rooms-members' },
|
|
{ label: '角色、权限与用户偏好', translations: { en: 'Roles, Permissions, and Preferences' }, slug: 'admin/permissions' },
|
|
{ label: '审核与治理', translations: { en: 'Reviews and Moderation' }, slug: 'admin/reviews-moderation' },
|
|
{ label: 'Provider', slug: 'admin/providers' },
|
|
{ label: '运行设置', translations: { en: 'Runtime Settings' }, slug: 'admin/runtime-settings' },
|
|
{ label: '认证与安全', translations: { en: 'Authentication and Security' }, slug: 'admin/authentication-security' },
|
|
],
|
|
collapsed: true,
|
|
},
|
|
{
|
|
label: '运维',
|
|
translations: { en: 'Operations' },
|
|
items: [
|
|
{ label: '系统架构', translations: { en: 'System Architecture' }, slug: 'operations/architecture' },
|
|
{ label: '部署与运行边界', translations: { en: 'Deployment and Runtime Boundaries' }, slug: 'operations/deployment-boundaries' },
|
|
{ label: '观测与运行手册', translations: { en: 'Observability Runbook' }, slug: 'operations/observability' },
|
|
{ label: '排障', translations: { en: 'Troubleshooting' }, slug: 'operations/troubleshooting' },
|
|
{ label: '容量规划', translations: { en: 'Capacity Planning' }, slug: 'operations/capacity-planning' },
|
|
{ label: '安全加固与密钥轮换', translations: { en: 'Hardening and Secret Rotation' }, slug: 'operations/security-hardening-and-rotation' },
|
|
{ label: '执行维护任务', translations: { en: 'Run Maintenance Tasks' }, slug: 'operations/maintenance' },
|
|
],
|
|
collapsed: true,
|
|
},
|
|
{
|
|
label: 'API 与集成',
|
|
translations: { en: 'API and Integrations' },
|
|
items: [
|
|
{ label: '集成客户端', translations: { en: 'Integrate a Client' }, slug: 'integrations/client-integration' },
|
|
{ label: 'API 调用示例', translations: { en: 'API Examples' }, slug: 'integrations/api-examples' },
|
|
{ label: 'OpenAPI', slug: 'reference/openapi' },
|
|
{ label: 'gRPC', slug: 'reference/grpc' },
|
|
{ label: 'Realtime 协议', translations: { en: 'Realtime Protocol' }, slug: 'integrations/realtime-api' },
|
|
{ label: '订阅 Realtime 资源', translations: { en: 'Subscribe to Realtime Resources' }, slug: 'integrations/realtime-subscriptions' },
|
|
{ label: '播放与代理', translations: { en: 'Playback and Proxy' }, slug: 'integrations/playback-and-proxy' },
|
|
{ label: 'P2P 媒体客户端', translations: { en: 'P2P Media Client' }, slug: 'integrations/p2p-media' },
|
|
],
|
|
collapsed: true,
|
|
},
|
|
{
|
|
label: '参考',
|
|
translations: { en: 'Reference' },
|
|
items: [
|
|
{ label: '配置字段', translations: { en: 'Configuration Fields' }, slug: 'reference/configuration-index' },
|
|
{ label: '环境变量', translations: { en: 'Environment Variables' }, slug: 'reference/environment-variables' },
|
|
{ label: 'Runtime settings', slug: 'reference/runtime-settings' },
|
|
{ label: 'CLI', slug: 'reference/cli' },
|
|
{ label: '错误码', translations: { en: 'Errors' }, slug: 'reference/errors' },
|
|
{ label: 'Metrics Catalog', slug: 'reference/metrics-catalog' },
|
|
{ label: '已知限制', translations: { en: 'Known Limitations' }, slug: 'reference/limitations' },
|
|
{ label: '术语', translations: { en: 'Glossary' }, slug: 'reference/glossary' },
|
|
],
|
|
collapsed: true,
|
|
},
|
|
],
|
|
}),
|
|
],
|
|
});
|