From c3803f268789c70bb612bc0257fb0eae4f4186a9 Mon Sep 17 00:00:00 2001 From: Chengxun Lee <24319042+bclswl0827@users.noreply.github.com> Date: Sat, 10 Feb 2024 20:09:43 +0800 Subject: [PATCH] Update configuration --- docs/AnyShake Observer/Configuration/seedlink.md | 14 +++++++++++++- docs/AnyShake Observer/Configuration/server.md | 3 ++- docs/AnyShake Observer/quick-start.md | 9 ++++++--- 3 files changed, 21 insertions(+), 5 deletions(-) diff --git a/docs/AnyShake Observer/Configuration/seedlink.md b/docs/AnyShake Observer/Configuration/seedlink.md index f123e90..4b4aa4a 100644 --- a/docs/AnyShake Observer/Configuration/seedlink.md +++ b/docs/AnyShake Observer/Configuration/seedlink.md @@ -26,6 +26,16 @@ This object manages SeedLink settings for AnyShake Observer, which are optional - Type: `int` - Description: SeedLink server port +### size + + - Type: `int` + - Description: SeedLink buffer size + +### buffer + + - Type: `string` + - Description: Path to SeedLink buffer file + ## Example ```json @@ -33,7 +43,9 @@ This object manages SeedLink settings for AnyShake Observer, which are optional "seedlink_settings": { "enable": false, "host": "0.0.0.0", - "port": 18000 + "port": 18000, + "size": 43200, + "buffer": "/data/sl_buffer.dat" } } ``` diff --git a/docs/AnyShake Observer/Configuration/server.md b/docs/AnyShake Observer/Configuration/server.md index 7c106a3..6ec0bc6 100644 --- a/docs/AnyShake Observer/Configuration/server.md +++ b/docs/AnyShake Observer/Configuration/server.md @@ -41,6 +41,7 @@ This object manages server settings for AnyShake Observer. "host": "0.0.0.0", "port": 8073, "cors": true, - "debug": false + "debug": false, + "rate": 30 } } diff --git a/docs/AnyShake Observer/quick-start.md b/docs/AnyShake Observer/quick-start.md index 76c8f4e..50bab30 100644 --- a/docs/AnyShake Observer/quick-start.md +++ b/docs/AnyShake Observer/quick-start.md @@ -8,7 +8,7 @@ You need to configure AnyShake Observer after installing it. Here is a quick con ## Configuration -The configuration file is in JSON format. You can use any text editor to edit it. The demo configuration is taken from [v2.5.0](https://github.com/anyshake/observer/releases/tag/v2.5.1). +The configuration file is in JSON format. You can use any text editor to edit it. The demo configuration is taken from [v2.8.0](https://github.com/anyshake/observer/releases/tag/v2.8.0). ```json { @@ -67,7 +67,8 @@ The configuration file is in JSON format. You can use any text editor to edit it "host": "0.0.0.0", // Web server host "port": 8073, // Web server port "cors": true, // Enable CORS - "debug": false // Enable debug mode, /api/v1/devel endpoint will be available + "debug": false, // Enable debug mode, /api/v1/devel endpoint will be available + "rate": 30 // Rate limit in requests per second for API endpoints }, "miniseed_settings": { "enable": false, // Enable MiniSEED archiver @@ -77,7 +78,9 @@ The configuration file is in JSON format. You can use any text editor to edit it "seedlink_settings": { "enable": false, // Enable SeedLink streamer "host": "0.0.0.0", // SeedLink streamer host - "port": 18000 // SeedLink streamer port + "port": 18000, // SeedLink streamer port + "size": 43200, // SeedLink buffer size + "buffer": "/data/sl_buffer.dat" // Path to SeedLink buffer file } } ```