This commit is contained in:
mbecker20
2024-05-14 01:33:38 -07:00
parent 8a4611c380
commit a518806d8b
4 changed files with 13 additions and 3 deletions

View File

@@ -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.

View File

@@ -20,7 +20,7 @@ the redirect uri is `<base_url>/auth/google/callback` for google and `<base_url>
:::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

View File

@@ -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",
},
],

View File

@@ -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</>,
},
];