mirror of
https://github.com/superseriousbusiness/gotosocial.git
synced 2025-10-29 17:42:25 -05:00
* [docs/zh] Update zh docs: synced to e10de84
* [docs/zh] update mkdocs config of zh docs
* [docs/zh] update repo docs translations (README, ROADMAP, CONTRIBUTING) + update swagger schema metadata of docs/zh
This commit is contained in:
CDN
GitHub
parent
2aa3524739
commit
62f25ea08a
42 changed files with 1789 additions and 152 deletions
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
在部署 GoToSocial 之前，有几个关键点需要你仔细考虑，因为这些选择将影响你如何运行和管理 GoToSocial。
|
||||
|
||||
!!! danger
|
||||
!!! danger "危险"
|
||||
|
||||
在同一域名上切换不同实现是不被 Fediverse 支持的。这意味着如果你在 example.org 上运行 GoToSocial，而尝试切换到其他实现如 Pleroma/Akkoma、Misskey/Calckey 等，你会遇到联合问题。
|
||||
|
||||
|
|
@ -24,7 +24,7 @@ GoToSocial 致力于为在小型设备上运行的使用场景优化，因此我
|
|||
|
||||
你应该在这种情况下预留一些余量，若有需要，可以[配置一些交换内存](#交换内存)。
|
||||
|
||||
!!! tip
|
||||
!!! tip "提示"
|
||||
在内存受限的环境中，你可以将 `cache.memory-target` 设置为低于默认的 100MB （查看数据库配置选项[这里](../configuration/database.md#settings)）。设置为 50MB 已被证明可以正常运行。
|
||||
|
||||
这将使总内存使用稍微降低，但代价是某些请求的延迟略高，因为 GtS 需要更频繁地访问数据库。
|
||||
|
|
@ -46,7 +46,7 @@ GoToSocial 使用存储来保存其数据库文件，以及存储和服务媒体
|
|||
|
||||
对于媒体存储，以及[缓存的外站媒体文件存储](../admin/media_caching.md)，你应该预算大约 5GB-10GB 的空间。GoToSocial 会自动执行自我清理，在一段时间后从缓存中删除未使用的外站媒体。如果存储空间是个问题，你可以[调整媒体清理行为](../admin/media_caching.md#清理)以更频繁地清理和/或减少外站媒体的缓存时间。
|
||||
|
||||
!!! info
|
||||
!!! info "附注"
|
||||
如果你的 sqlite.db 文件或 Postgres 容量在一开始增长很快，请不要惊慌，这是正常的。当你首次部署实例并开始联合时，你的实例会迅速发现并存储来自其他实例的账号和贴文。然而，随着实例的长期部署，这种增长会逐渐减缓，因为你会自然而然地看到更少的新账号（即，你的实例尚未见过并因此尚未在数据库中存储的账号）。
|
||||
|
||||
### 单板计算机
|
||||
|
|
@ -106,7 +106,7 @@ SQLite 是默认的驱动，并已被证明在 1-30 用户范围内的实例表
|
|||
|
||||
无论你选择哪种数据库驱动，为了获得良好的性能，它们都应在快速、稳定的低延迟存储上运行。虽然可以在网络附加存储上运行数据库，但这会增加可变延迟和网络拥堵，还有源存储上的潜在 I/O 争用。
|
||||
|
||||
!!! tip
|
||||
!!! tip "提示"
|
||||
请[备份你的数据库](../admin/backup_and_restore.md)。数据库包含实例和任何用户账户的加密密钥。如果丢失这些密钥，你将无法再次从同一域进行联合！
|
||||
|
||||
## 域名
|
||||
|
|
@ -119,7 +119,7 @@ SQLite 是默认的驱动，并已被证明在 1-30 用户范围内的实例表
|
|||
|
||||
如果你打算这样部署 GoToSocial 实例，请阅读[分域部署](../advanced/host-account-domain.md)文档以了解详细信息。
|
||||
|
||||
!!! danger
|
||||
!!! danger "危险"
|
||||
无法在联合已经事实发生后安全地更改实例域名和账号域名。这需要重新生成数据库，并在任何已联合的服务器造成混乱情况。一旦你的实例域名和账号域名设置好，便不可更改。
|
||||
|
||||
## TLS
|
||||
|
|
@ -128,7 +128,7 @@ SQLite 是默认的驱动，并已被证明在 1-30 用户范围内的实例表
|
|||
|
||||
GoToSocial 内置 Lets Encrypt 证书配置支持。它也可以从磁盘加载证书。如果你有连接到 GoToSocial 的反向代理，可以在代理层处理 TLS。
|
||||
|
||||
!!! tip
|
||||
!!! tip "提示"
|
||||
请确保配置使用现代版本的 TLS，TLSv1.2 及更高版本，以确保服务器和客户端之间的通信安全。当 GoToSocial 处理 TLS 终端时，这会自动为你配置。如果使用反向代理，请使用 [Mozilla SSL 配置生成器](https://ssl-config.mozilla.org/)。
|
||||
|
||||
## 端口
|
||||
|
|
@ -140,7 +140,7 @@ GoToSocial 需要开放端口 `80` 和 `443`。
|
|||
|
||||
如果你无法在机器上开放 `443` 和 `80` 端口，不要担心！你可以在 GoToSocial 中配置这些端口，但还需要配置端口转发，以将 `443` 和 `80` 上的流量准确转发到你选择的端口。
|
||||
|
||||
!!! tip
|
||||
!!! tip "提示"
|
||||
你应该在机器上配置防火墙，并配置一些防范暴力 SSH 登录尝试的保护措施。参阅我们的[防火墙文档](../advanced/security/firewall.md)以获取配置建议和可帮助你的工具。
|
||||
|
||||
## 集群 / 多节点部署
|
||||
|
|
@ -167,7 +167,7 @@ GoToSocial 不支持[集群或任何形式的多节点部署](https://github.com
|
|||
|
||||
虽然可以在没有交换内存的情况下运行系统，但为了安全地做到这一点并确保一致的性能和服务可用性，你需要相应调整内核、系统和工作负载。这需要对内核的内存管理系统及你所运行的工作负载的内存使用模式有良好的理解。
|
||||
|
||||
!!! tip
|
||||
!!! tip "提示"
|
||||
交换内存用于确保内核可以高效地回收内存。这在系统没有经历内存争用时也很有用，比如在进程启动时仅使用过的内存腾出。这允许更多活跃使用的东西被缓存于内存中。内存交换不是让你的程序变慢的原因。内存争用才是造成缓慢的原因。
|
||||
|
||||
[sysctl]: https://man7.org/linux/man-pages/man8/sysctl.8.html
|
||||
|
|
|
|||
|
|
@ -44,7 +44,7 @@ nano docker-compose.yaml
|
|||
* `snapshot`：指向当前在主分支上的代码。不保证稳定，可能经常出错。谨慎使用。
|
||||
* `vX.Y.Z`：发布标签。这指向 GoToSocial 的特定、稳定的版本。
|
||||
|
||||
!!! tip
|
||||
!!! tip "提示"
|
||||
`latest` 和 `snapshot` 标签是动态标签，而 `vX.Y.Z` 标签是固定的。拉取动态标签的结果可能每天都会变化。同一系统上的 `latest` 可能与不同系统上的 `latest` 不同。建议使用 `vX.Y.Z` 标签，以便你始终确切知道运行的是 GoToSocial 的哪个版本。发布列表可以在[这里](https://github.com/superseriousbusiness/gotosocial/releases)找到，最新的发布在顶部。
|
||||
|
||||
### 主机
|
||||
|
|
@ -87,7 +87,7 @@ nano docker-compose.yaml
|
|||
如果你决定稍后设置/更改这些变量，请确保在更改后重新创建 GoToSocial 实例容器。
|
||||
|
||||
|
||||
!!! tip
|
||||
!!! tip "提示"
|
||||
|
||||
有关将 config.yaml 文件中的变量名称转换为环境变量的帮助，请参阅[配置部分](../../configuration/index.md#environment-variables)。
|
||||
|
||||
|
|
|
|||
|
|
@ -33,7 +33,7 @@ cd /gotosocial
|
|||
|
||||
现在，下载与你运行的操作系统和架构相对应的最新 GoToSocial 发行版压缩包。
|
||||
|
||||
!!! tip
|
||||
!!! tip "提示"
|
||||
你可以在[这里](https://github.com/superseriousbusiness/gotosocial/releases)找到按发布时间排列的发布列表，最新的发行版位于最上面。
|
||||
|
||||
例如，下载适用于 64 位 Linux 的版本：
|
||||
|
|
@ -52,7 +52,7 @@ tar -xzf gotosocial_${GTS_VERSION}_${GTS_TARGET}.tar.gz
|
|||
|
||||
这将在你的当前目录放置 `gotosocial` 二进制文件，以及包含网页前端资源的 `web` 文件夹和包含示例配置文件的 `example` 文件夹。
|
||||
|
||||
!!! danger
|
||||
!!! danger "危险"
|
||||
如果你想使用基于当前主分支代码的 GoToSocial 快照构建，可以从[这里](https://minio.s3.superseriousbusiness.org/browser/gotosocial-snapshots)下载最近的二进制 .tar.gz 文件（基于提交哈希）。仅在你很清楚自己的操作时使用，否则请使用稳定版。
|
||||
|
||||
## 编辑配置文件
|
||||
|
|
|
|||
|
|
@ -48,7 +48,7 @@ sudo systemctl restart gotosocial.service
|
|||
|
||||
### 使用 mod_md 启用 TLS
|
||||
|
||||
!!! note
|
||||
!!! note "注意"
|
||||
`mod_md` 自 Apache 2.4.30 开始可用，仍被视为实验性的。实际上，它在实践中表现良好，是最便捷的方法。
|
||||
|
||||
现在我们将配置 Apache HTTP 服务器来处理 GoToSocial 请求。
|
||||
|
|
@ -166,7 +166,7 @@ sudo systemctl restart apache2
|
|||
|
||||
### 使用外部管理证书启用 TLS
|
||||
|
||||
!!! note
|
||||
!!! note "注意"
|
||||
我们有关于如何[配置 TLS 证书](../../advanced/certificates.md)的额外文档，其中还提供了不同发行版的其他内容和教程链接，可能值得查看。
|
||||
|
||||
如果你更喜欢手动设置或使用不同服务（如 Certbot）来管理 SSL，可以为你的 Apache HTTP 服务器使用更简单的设置。
|
||||
|
|
|
|||
|
|
@ -11,7 +11,7 @@ GoToSocial 可以直接暴露到互联网上。不过，许多人更愿意使用
|
|||
* 如果你使用了 Lets Encrypt，在 GoToSocial 中禁用它。将 `letsencrypt-enabled` 设置为 `false`
|
||||
* 配置反向代理以处理 TLS 并将请求代理到 GoToSocial
|
||||
|
||||
!!! warning
|
||||
!!! warning "警告"
|
||||
不要更改 `host` 配置选项的值。这必须保持为其他实例在互联网上看到的实际域名。相反，改变 `bind-address` 并更新 `port` 和 `trusted-proxies`。
|
||||
|
||||
### 容器
|
||||
|
|
@ -41,3 +41,7 @@ GoToSocial 可以直接暴露到互联网上。不过，许多人更愿意使用
|
|||
使用反向代理时，必须特别注意允许 WebSockets 正常工作。因为许多客户端应用程序使用 WebSockets 来流式传输你的时间线。WebSockets 不用于联合。
|
||||
|
||||
请确保阅读 [WebSocket](websocket.md) 文档，并相应地配置你的反向代理。
|
||||
|
||||
## 可信代理
|
||||
|
||||
使用反向代理时，可能会遇到速率限制和 `trusted-proxies` 相关的问题。如有任何问题，请查阅[可信代理](../../configuration/trusted_proxies.md)文档。
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
要使用 NGINX 作为 GoToSocial 的反向代理，你需要在服务器上安装它。如果你打算让 NGINX 处理 TLS，你还需要[配置 TLS 证书](../../advanced/certificates.md)。
|
||||
|
||||
!!! tip
|
||||
!!! tip "提示"
|
||||
通过在 `server` 块中包含 `http2 on;` 来启用 NGINX 的 HTTP/2。这样可以加快客户端的体验。请参阅 [ngx_http_v2_module 文档](https://nginx.org/en/docs/http/ngx_http_v2_module.html#example)。
|
||||
|
||||
NGINX 已为[多个发行版打包](https://repology.org/project/nginx/versions)。你很可能可以使用发行版的包管理器来安装它。你也可以使用 Docker Hub 上发布的[官方 NGINX 镜像](https://hub.docker.com/_/nginx)通过容器运行 NGINX。
|
||||
|
|
@ -112,7 +112,7 @@ sudo systemctl restart nginx
|
|||
|
||||
## 设置 TLS
|
||||
|
||||
!!! warning
|
||||
!!! warning "警告"
|
||||
我们有关于如何[配置 TLS 证书](../../advanced/certificates.md)的附加文档，还提供了有关不同发行版的附加内容和教程链接，值得一看。
|
||||
|
||||
你现在可以运行 certbot，它将引导你完成启用 https 的步骤。
|
||||
|
|
@ -145,7 +145,7 @@ sudo systemctl start gotosocial
|
|||
|
||||
如果你再次打开 NGINX 配置，你会发现 Certbot 添加了一些额外的行。
|
||||
|
||||
!!! warning
|
||||
!!! warning "警告"
|
||||
根据你设置 Certbot 时选择的选项，以及使用的 NGINX 版本，可能会有所不同。
|
||||
|
||||
```nginx
|
||||
|
|
|
|||
|
|
@ -29,7 +29,7 @@
|
|||
|
||||
例如，将用户提升为管理员后，你需要重启 GoToSocial 服务器，以便从数据库加载新值。
|
||||
|
||||
!!! tip
|
||||
!!! tip "提示"
|
||||
|
||||
要查看其他可用的 CLI 命令，请点击[这里](../admin/cli.md)。
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue