Skip to content

Commit

Permalink
docs: fix broken pages and add MacOS ARM64 release
Browse files Browse the repository at this point in the history
  • Loading branch information
burgerni10 committed Jun 11, 2024
1 parent df7cd1c commit 914f429
Show file tree
Hide file tree
Showing 6 changed files with 21 additions and 15 deletions.
6 changes: 6 additions & 0 deletions documentation/docs/guide/installation/macos.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,12 @@ import packageInfo from '../../../package.json'
<div>MacOS (Intel chip)</div>
</div>
</DownloadButton>
<DownloadButton link={`https://github.com/OptimistikSAS/OIBus/releases/download/v${packageInfo.version}/oibus-macos_arm64-v${packageInfo.version}.zip`}>
<div>
<div>{`OIBus v${packageInfo.version} (zip)`}</div>
<div>MacOS (ARM 64)</div>
</div>
</DownloadButton>
</div>

macOS OIBus binary can be run through its executable. Once unzipped, start a Terminal and enter the following command:
Expand Down
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.3.1 OIBus version. If you want to migrate to a later version, first install OIBus v3.3.1
from one of the links below, and then update OIBus from v3.3.1 to a later version.
The migration will work only with the 3.3.4 OIBus version. If you want to migrate to a later version, first install OIBus v3.3.4
from one of the links below, and then update OIBus from v3.3.4 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.3.1/oibus-setup-win_x64-v3.3.1.exe'>
link='https://github.com/OptimistikSAS/OIBus/releases/download/v3.3.4/oibus-setup-win_x64-v3.3.4.exe'>
<div>
<div>{`OIBus v3.3.1 (installer)`}</div>
<div>{`OIBus v3.3.4 (installer)`}</div>
<div>Windows (x64)</div>
</div>
</DownloadButton>
<DownloadButton link='https://github.com/OptimistikSAS/OIBus/releases/download/v3.3.1/oibus-win_x64-v3.3.1.zip'>
<DownloadButton link='https://github.com/OptimistikSAS/OIBus/releases/download/v3.3.4/oibus-win_x64-v3.3.4.zip'>
<div>
<div>{`OIBus v3.3.1 (zip)`}</div>
<div>{`OIBus v3.3.4 (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.3.1 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.3.1/oibus-linux_x64-v3.3.1.zip`}>
link={`https://github.com/OptimistikSAS/OIBus/releases/download/v3.3.4/oibus-linux_x64-v3.3.4.zip`}>
<div>
<div>{`OIBus v3.3.1`}</div>
<div>{`OIBus v3.3.4`}</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.3.1 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.3.1/oibus-macos_x64-v3.3.1.zip`}>
link={`https://github.com/OptimistikSAS/OIBus/releases/download/v3.3.4/oibus-macos_x64-v3.3.4.zip`}>
<div>
<div>{`OIBus v3.3.1`}</div>
<div>{`OIBus v3.3.4`}</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.3.1 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.3.1](#download-specific-version). Be careful to specify the **same data folder**. Check
2. Install [OIBus v3.3.4](#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
2 changes: 1 addition & 1 deletion documentation/docs/guide/south-connectors/odbc.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ This connector proves valuable when retrieving data from IP21 ODBC interfaces or
- **Use remote agent**: If set to `No`, ensure that an ODBC [driver is installed](#driver-installation) on the machine
where OIBus is deployed. Alternatively, you can opt to [install an OIBus agent](../oibus-agent/installation) on a remote
machine equipped with the necessary drivers.
- **Remote agent URL**: Specify the URL of the remote OIBus agent, e.g., http://ip-address-or-host:2224.
- **Remote agent URL**: Specify the URL of the remote OIBus agent, e.g., `http://ip-address-or-host:2224`.
- **Retry interval**: Time to wait before retrying connection.
- **Request timeout**: Determine the timeout duration for each query.
- **Connection timeout**: Timeout setting for establishing the connection.
Expand Down
2 changes: 1 addition & 1 deletion documentation/docs/guide/south-connectors/opc-hda.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ The HDA module can also be used as a standalone, to perform OPC history extracti
## Specific settings
OIBus exchanges commands and data with the HDA agent through a TCP server/client communication. Therefore, several
fields must be filled to make OIBus communicate with the HDA Agent:
- **Remote agent URL**: Specify the URL of the remote OIBus agent, e.g., http://ip-address-or-host:2224.
- **Remote agent URL**: Specify the URL of the remote OIBus agent, e.g., `http://ip-address-or-host:2224`.
- **Connection timeout**: Set the timeout for establishing a connection.
- **Retry interval**: Time to wait before retrying connection.
- **Server host**: Address of the OPC server (from the remote OIBus agent machine).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ OIBus agent 可以根据其[文档](../oibus-agent/installation)中的说明单

## 特定设置
- **使用远程代理**:如果设置为 `No`,确保在部署 OIBus 的机器上安装了 ODBC [驱动程序](#驱动程序安装)。或者,您可以选择在配备必要驱动程序的远程机器上[安装 OIBus agent](../oibus-agent/installation)
- **远程代理 URL**:指定远程 OIBus agent 的 URL,例如,http://ip-address-or-host:2224。
- **远程代理 URL**:指定远程 OIBus agent 的 URL,例如,`http://ip-address-or-host:2224`
- **重试间隔**:在重新尝试连接前的等待时间。
- **请求超时**:确定每个查询的超时持续时间。
- **连接超时**:建立连接的超时设置。
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ HDA模块也可以作为独立使用,以命令行方式执行OPC历史数据

## 特定设置
OIBus通过TCP服务器/客户端通信与HDA代理交换命令和数据。因此,需要填写几个字段,使OIBus能够与HDA代理通信:
- **远程代理URL**:指定远程OIBus代理的URL,例如,http://ip-address-or-host:2224。
- **远程代理URL**:指定远程OIBus代理的URL,例如,`http://ip-address-or-host:2224`
- **连接超时**:设置建立连接的超时时间。
- **重试间隔**:重新尝试连接前的等待时间。
- **服务器主机**:OPC服务器的地址(来自远程OIBus代理机器)。
Expand Down

0 comments on commit 914f429

Please sign in to comment.