diff --git a/docsite/docs/connecting-servers/setup-periphery.md b/docsite/docs/connecting-servers/setup-periphery.md index 9b8d02cbc..1e443cbca 100644 --- a/docsite/docs/connecting-servers/setup-periphery.md +++ b/docsite/docs/connecting-servers/setup-periphery.md @@ -8,6 +8,11 @@ The easiest way to setup periphery is to use the [Periphery setup script](https: 2. Create and edit your config files, following the [config example](https://github.com/mbecker20/monitor/blob/main/config_example/periphery.config.example.toml). + :::note + See the [periphery config docs](https://docs.rs/monitor_client/latest/monitor_client/entities/config/periphery/index.html) + for more information on configuring periphery. + ::: + 3. Ensure that inbound connectivity is allowed on the port specified in periphery.config.toml (default 8000). 4. Install docker. Make sure whatever user periphery is run as has access to the docker group without sudo. diff --git a/docsite/docs/core-setup.md b/docsite/docs/core-setup.md index b21a1ee3e..282e79dbe 100644 --- a/docsite/docs/core-setup.md +++ b/docsite/docs/core-setup.md @@ -20,7 +20,7 @@ the redirect uri is `/auth/google/callback` for google and ` :::note all configuration can additionally be passed using environment variables, which override the value in the config file. -see ###CONFIG_RUST_DOCS###. +see [config docs](https://docs.rs/monitor_client/latest/monitor_client/entities/config/core/index.html). ::: ## 2. start monitor core diff --git a/docsite/docusaurus.config.ts b/docsite/docusaurus.config.ts index b5dd48c83..c7dac5857 100644 --- a/docsite/docusaurus.config.ts +++ b/docsite/docusaurus.config.ts @@ -78,9 +78,14 @@ const config: Config = { position: "left", label: "docs", }, + { + href: "https://docs.rs/monitor_client/latest/monitor_client/", + label: "docs.rs", + position: "right", + }, { href: "https://github.com/mbecker20/monitor", - label: "GitHub", + label: "github", position: "right", }, ], diff --git a/docsite/src/components/HomepageFeatures/index.tsx b/docsite/src/components/HomepageFeatures/index.tsx index 757956193..5f0ead90b 100644 --- a/docsite/src/components/HomepageFeatures/index.tsx +++ b/docsite/src/components/HomepageFeatures/index.tsx @@ -28,7 +28,7 @@ const FeatureList: FeatureItem[] = [ }, { title: "powered by Rust 🦀", - description: <>The core API and periphery client are written in Rust, + description: <>The core API and periphery agent are written in Rust, }, ];