Skip to content

Commit

Permalink
doc: fix broken links and remove slims
Browse files Browse the repository at this point in the history
  • Loading branch information
burgerni10 committed Feb 6, 2025
1 parent 88cac35 commit 92caafb
Show file tree
Hide file tree
Showing 7 changed files with 19 additions and 217 deletions.
2 changes: 1 addition & 1 deletion documentation/docs/guide/engine/ip-filters.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,6 @@ curl --location --request POST "http://localhost:2223/api/ip-filters" --header "
```

:::caution Allowing all with proxy server
Be careful when allowing all IP addresses and using the [proxy server](./engine-settings.mdx#proxy-server): since the
Be careful when allowing all IP addresses and using the [proxy server](./engine-settings.mdx#oibus-proxy-server-configuration): since the
proxy simply forward without authenticating the request, it may be dangerous to accept all sources.
:::
22 changes: 11 additions & 11 deletions documentation/docs/guide/installation/migrate.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -48,23 +48,23 @@ Migrate from OIBus v1 and v2 into the new OIBus v3 version with our migration to

## Download specific version
:::caution OIBus version
The migration will work only with the 3.5.5 OIBus version. If you want to migrate to a later version, first install OIBus v3.5.5
from one of the links below, and then update OIBus from v3.5.5 to a later version.
The migration will work only with the 3.5.10 OIBus version. If you want to migrate to a later version, first install OIBus v3.5.10
from one of the links below, and then update OIBus from v3.5.10 to a later version.
:::

<Tabs>
<TabItem value="windows" label="Windows" default>
<div style={{ display: "flex", justifyContent: "space-around" }}>
<DownloadButton
link='https://github.com/OptimistikSAS/OIBus/releases/download/v3.5.5/oibus-setup-win_x64-v3.5.5.exe'>
link='https://github.com/OptimistikSAS/OIBus/releases/download/v3.5.10/oibus-setup-win_x64-v3.5.10.exe'>
<div>
<div>{`OIBus v3.5.5 (installer)`}</div>
<div>{`OIBus v3.5.10 (installer)`}</div>
<div>Windows (x64)</div>
</div>
</DownloadButton>
<DownloadButton link='https://github.com/OptimistikSAS/OIBus/releases/download/v3.5.5/oibus-win_x64-v3.5.5.zip'>
<DownloadButton link='https://github.com/OptimistikSAS/OIBus/releases/download/v3.5.10/oibus-win_x64-v3.5.10.zip'>
<div>
<div>{`OIBus v3.5.5 (zip)`}</div>
<div>{`OIBus v3.5.10 (zip)`}</div>
<div>Windows (x64)</div>
</div>
</DownloadButton>
Expand All @@ -76,9 +76,9 @@ from one of the links below, and then update OIBus from v3.5.5 to a later versio
<TabItem value="linux" label="Linux">
<div style={{ display: "flex", justifyContent: "space-around" }}>
<DownloadButton
link={`https://github.com/OptimistikSAS/OIBus/releases/download/v3.5.5/oibus-linux_x64-v3.5.5.zip`}>
link={`https://github.com/OptimistikSAS/OIBus/releases/download/v3.5.10/oibus-linux_x64-v3.5.10.zip`}>
<div>
<div>{`OIBus v3.5.5`}</div>
<div>{`OIBus v3.5.10`}</div>
<div>Linux (x64)</div>
</div>
</DownloadButton>
Expand All @@ -90,9 +90,9 @@ from one of the links below, and then update OIBus from v3.5.5 to a later versio
<TabItem value="macos" label="MacOS">
<div style={{ display: "flex", justifyContent: "space-around" }}>
<DownloadButton
link={`https://github.com/OptimistikSAS/OIBus/releases/download/v3.5.5/oibus-macos_x64-v3.5.5.zip`}>
link={`https://github.com/OptimistikSAS/OIBus/releases/download/v3.5.10/oibus-macos_x64-v3.5.10.zip`}>
<div>
<div>{`OIBus v3.5.5`}</div>
<div>{`OIBus v3.5.10`}</div>
<div>MacOS (Intel chip)</div>
</div>
</DownloadButton>
Expand All @@ -109,7 +109,7 @@ from one of the links below, and then update OIBus from v3.5.5 to a later versio
You can zip the data folder, or at least the configuration file `oibus.json` and its `keys` as a backup.
:::

2. Install [OIBus v3.5.5](#download-specific-version). Be careful to specify the **same data folder**. Check
2. Install [OIBus v3.5.10](#download-specific-version). Be careful to specify the **same data folder**. Check
that OIBus v3 run properly by login on `http://localhost:2223` with admin / pass. If everything works, go on with the next step.

3. Stop OIBus v3.
Expand Down
8 changes: 4 additions & 4 deletions documentation/docs/guide/north-connectors/oianalytics.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,13 +20,13 @@ unfolds within the SaaS application, courtesy of its easily configurable setting

Here are the important parameters for configuring connectivity with the OIAnalytics SaaS application:

- **Use OIAnalytics Module**: Use the connection settings of the OIAnalytics module
- **Use OIAnalytics registration**: Use the connection settings of the [OIAnalytics registration](../advanced/oianalytics-registration.mdx).
- **Timeout**: The duration before a connection failure is reported in HTTP requests.
- **Compress data**: Compress the data if not already compressed. Compressed files will be detected with the .gz file
extension,
and JSON payload will be compressed and sent to a specific OIAnalytics endpoint.

If OIAnalytics module is not used, the following fields will be used:
If OIAnalytics registration is not used, the following fields will be used:

- **Host**: The hostname of the SaaS application (e.g., `https://optimistik.oianalytics.com`).
- **Accept unauthorized certificate**: This option is useful when HTTP queries traverse a firewall that strips the
Expand Down Expand Up @@ -54,8 +54,8 @@ If OIAnalytics module is not used, the following fields will be used:
To securely connect OIBus to OIAnalytics, follow these steps:
1. Register OIBus on OIAnalytics:
- This ensures seamless integration and secure communication between OIBus and OIAnalytics.
2. Enable the Use OIAnalytics Module Option:
- In the North connector settings, enable the Use OIAnalytics Module option to establish the connection.
2. Enable the **Use OIAnalytics registration** option:
- In the North connector settings, enable the **Use OIAnalytics registration** option to establish the connection.
- By doing this, you eliminate the need to manually transfer API keys, simplifying the process and enhancing security.

:::tip Proxy client
Expand Down
102 changes: 0 additions & 102 deletions documentation/docs/guide/south-connectors/slims.mdx

This file was deleted.

4 changes: 2 additions & 2 deletions documentation/docs/use-cases/_north_oianalytics.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ your IT team to add a rule allowing communication.
A best practice for sending values into OIAnalytics is to [register OIBus first](../guide/advanced/oianalytics-registration.mdx).

Create the OIAnalytics North connector and populate the relevant fields. If OIBus has been registered into OIAnalytics,
check the `Use OIAnalytics Module` toggle.
check the `Use OIAnalytics registration` toggle.

You can test the settings by clicking the `Test settings` button to verify the connection.

Expand All @@ -24,7 +24,7 @@ to add a rule permitting communication.
For optimal functionality, it is recommended to [register OIBus](../guide/advanced/oianalytics-registration.mdx) before sending
values to OIAnalytics.

If OIBus has been registered with OIAnalytics, activate the `Use OIAnalytics Module` toggle.
If OIBus has been registered with OIAnalytics, activate the `Use OIAnalytics registration` toggle.

<div style={{ textAlign: 'center' }}>
<div>
Expand Down
2 changes: 1 addition & 1 deletion documentation/docs/use-cases/use-case-advanced.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ It is strongly suggested to first [register OIBus into OIAnalytics](../guide/adv
registration inside the [North OIAnalytics connector](../guide/north-connectors/oianalytics).

### Proxy server
Enable the [proxy server](../guide/engine/engine-settings#proxy-server) and be sure the selected port is not used and is allowed on the firewall for inbound connections.
Enable the [proxy server](../guide/engine/engine-settings#oibus-proxy-server-configuration) and be sure the selected port is not used and is allowed on the firewall for inbound connections.

## OIBus OT
This OIBus can be used to access PLCs located in the industrial network.
Expand Down

This file was deleted.

0 comments on commit 92caafb

Please sign in to comment.