Update doc.

ossrs · Aug 25, 2023 · ba97854 · ba97854
1 parent e959c97
commit ba97854
Show file tree

Hide file tree

Showing 8 changed files with 30 additions and 6 deletions.
diff --git a/i18n/en-us/docusaurus-plugin-content-docs/current/doc/http-callback.md b/i18n/en-us/docusaurus-plugin-content-docs/current/doc/http-callback.md
@@ -151,7 +151,11 @@ Description about some fields:
 * `stream_url`: The stream identify without extension, such as `/live/livestream`.
 * `stream_id`: The id of stream, by which you can query the stream information.
 
-Note: For more information, read the section hooks.callback.vhost.com in conf/full.conf
+> Note: The callbacks for streaming are `on_publish` and `on_unpublish`, while the callbacks for playback are `on_play` and `on_stop`.
+
+> Note: Before SRS 4, there were `on_connect` and `on_close`, which are events defined by RTMP and only applicable to RTMP streams. These events overlap with streaming and playback events, so their use is not recommended.
+
+> Note: You can refer to the hooks.callback.vhost.com example in the conf/full.conf configuration file.
 
 ## Protocol
 

diff --git a/i18n/en-us/docusaurus-plugin-content-docs/current/tools/utility.md b/i18n/en-us/docusaurus-plugin-content-docs/current/tools/utility.md
@@ -9,6 +9,7 @@ hide_table_of_contents: false
 
 * [Console](https://ossrs.net/srs-console/trunk/research/console/)
 * [App Download](https://ossrs.net/releases/app.html)
+* [HTTP-REST](https://ossrs.net/http-rest/)
 * [HTTP-FLV Player](https://ossrs.net/releases/demo.html?page=srs_player.html)
 * [WebRTC Player](https://ossrs.net/releases/demo.html?page=rtc_player.html)
 * [GB28181 Player](https://ossrs.net/releases/demo.html?page=srs_gb28181.html)

diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/current/doc/http-callback.md b/i18n/zh-cn/docusaurus-plugin-content-docs/current/doc/http-callback.md
@@ -151,7 +151,11 @@ vhost your_vhost {
 * `stream_url`: 流的URL，无扩展名信息，例如：`/live/livestream`.
 * `stream_id`: 流的ID，可以通过API查询流的详细信息。
 
-备注：可以参考conf/full.conf配置文件中的hooks.callback.vhost.com实例。
+> Note: 推流的回调是`on_publish`和`on_unpublish`，播放的回调是`on_play`和`on_stop`。
+
+> Note: SRS 4之前，还有`on_connect`和`on_close`，这是RTMP定义的事件，只有RTMP流才有，而且和推流和播放的事件是重叠的，所以不推荐使用。
+
+> Note: 可以参考conf/full.conf配置文件中的hooks.callback.vhost.com实例。
 
 ## Protocol
 

diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/current/tools/utility.md b/i18n/zh-cn/docusaurus-plugin-content-docs/current/tools/utility.md
@@ -9,6 +9,7 @@ hide_table_of_contents: false
 
 * [Console 控制台](https://ossrs.net/srs-console/trunk/research/console/)
 * [App 应用下载](https://ossrs.net/releases/app.html)
+* [HTTP-REST](https://ossrs.net/http-rest/)
 * [HTTP-FLV Player](https://ossrs.net/releases/demo.html?page=srs_player.html)
 * [WebRTC Player](https://ossrs.net/releases/demo.html?page=rtc_player.html)
 * [GB28181 Player](https://ossrs.net/releases/demo.html?page=srs_gb28181.html)

diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-5.0/doc/http-callback.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-5.0/doc/http-callback.md
@@ -151,7 +151,11 @@ vhost your_vhost {
 * `stream_url`: 流的URL，无扩展名信息，例如：`/live/livestream`.
 * `stream_id`: 流的ID，可以通过API查询流的详细信息。
 
-备注：可以参考conf/full.conf配置文件中的hooks.callback.vhost.com实例。
+> Note: 推流的回调是`on_publish`和`on_unpublish`，播放的回调是`on_play`和`on_stop`。
+
+> Note: SRS 4之前，还有`on_connect`和`on_close`，这是RTMP定义的事件，只有RTMP流才有，而且和推流和播放的事件是重叠的，所以不推荐使用。
+
+> Note: 可以参考conf/full.conf配置文件中的hooks.callback.vhost.com实例。
 
 ## Protocol
 

diff --git a/i18n/zh-cn/docusaurus-plugin-content-pages/faq-srs-stack.md b/i18n/zh-cn/docusaurus-plugin-content-pages/faq-srs-stack.md
@@ -551,11 +551,14 @@ SRS Stack的使用说明，请参考视频[SRS Stack：起步、购买和入门]
     * 从MIT协议切换到AGPL协议. v1.0.307
     * 使用一个版本策略，统一版本. v5.8.20
     * 总是检查测试结果，无论超时还是取消. v5.8.21
-    * 使用本地LFS文件作为测试源。 v5.8.21
     * 开启SRT配置，支持SRT推流。 v5.8.22
     * 2023.08.19: 添加高性能HLS的单元测试用例。 v5.8.23
     * 2023.08.20: 迁移文档到新站点。 v5.8.23
     * 2023.08.20: 解决宝塔插件文件名问题. v5.8.24
+    * 2023.08.21: 新增NGINX分发HLS的例子. v5.8.25
+    * 2023.08.22: 从SRS下载测试源文件. v5.8.26
+    * 2023.08.23: 取消对版本获取的依赖. v5.8.26
+    * 2023.08.23: Fix Failed to execute 'insertBefore' on 'Node'. v5.8.26
 * v5.7
     * 优化DigitalOcean droplet镜像。v1.0.302
     * 支持本地测试所有脚本。v1.0.302

diff --git a/src/pages/faq-srs-stack.md b/src/pages/faq-srs-stack.md
@@ -536,11 +536,14 @@ The following are the update records for the SRS Stack server.
     * Switch MIT to AGPL License. v1.0.307
     * Use one version strategy. v5.8.20
     * Always check test result. v5.8.21
-    * Add lfs mp4 samples for test. v5.8.21
     * SRT: Enable srt in default vhost. v5.8.22
     * 2023.08.19: Add utest for HP HLS. v5.8.23
     * 2023.08.20: Migrate docs to new website. v5.8.23
     * 2023.08.20: BT and aaPanel plugin ID should match filename. v5.8.24
+    * 2023.08.21: Add Nginx HLS Edge tutorial. v5.8.25
+    * 2023.08.22: Download test file from SRS. v5.8.26
+    * 2023.08.23: Do not require version. v5.8.26
+    * 2023.08.23: Fix Failed to execute 'insertBefore' on 'Node'. v5.8.26
 * v5.7
     * Refine DigitalOcean droplet image. v1.0.302
     * Support local test all script. v1.0.302

diff --git a/versioned_docs/version-5.0/doc/http-callback.md b/versioned_docs/version-5.0/doc/http-callback.md
@@ -151,7 +151,11 @@ Description about some fields:
 * `stream_url`: The stream identify without extension, such as `/live/livestream`.
 * `stream_id`: The id of stream, by which you can query the stream information.
 
-Note: For more information, read the section hooks.callback.vhost.com in conf/full.conf
+> Note: The callbacks for streaming are `on_publish` and `on_unpublish`, while the callbacks for playback are `on_play` and `on_stop`.
+
+> Note: Before SRS 4, there were `on_connect` and `on_close`, which are events defined by RTMP and only applicable to RTMP streams. These events overlap with streaming and playback events, so their use is not recommended.
+
+> Note: You can refer to the hooks.callback.vhost.com example in the conf/full.conf configuration file.
 
 ## Protocol