-
-
Notifications
You must be signed in to change notification settings - Fork 17
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: update OIBus Agent installation documentation
- Loading branch information
1 parent
e1f41e5
commit 4decdc0
Showing
3 changed files
with
52 additions
and
70 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,25 +1,65 @@ | ||
--- | ||
sidebar_position: 1 | ||
--- | ||
import Tabs from '@theme/Tabs'; | ||
import TabItem from '@theme/TabItem'; | ||
import WindowsInstallation from './installation/_windows.mdx'; | ||
import LinuxInstallation from './installation/_linux.mdx'; | ||
|
||
import DownloadButton from "@site/src/components/DownloadButton"; | ||
|
||
# Concept and installation | ||
OIBus Agent is a tool used to embed through HTTP some protocol specific queries. For now, [ODBC](./odbc) and | ||
[OPCHDA](./opchda) are supported. | ||
|
||
OIBus can request the agent through its South connectors [ODBC](../south-connectors/odbc) and [OPCHDA](../south-connectors/opc-hda). | ||
|
||
<div style={{ display: "flex", justifyContent: "space-around" }}> | ||
<DownloadButton link={`https://github.com/OptimistikSAS/OIBusAgentRelease/releases/latest/download/oibus-agent-win_x64.zip`}> | ||
<div>Windows (x64)</div> | ||
</DownloadButton> | ||
<DownloadButton link={`https://github.com/OptimistikSAS/OIBusAgentRelease/releases/latest/download/oibus-agent-win_x86.zip`}> | ||
<div>Windows (x86)</div> | ||
</DownloadButton> | ||
<DownloadButton link={`https://github.com/OptimistikSAS/OIBusAgentRelease/releases/latest/download/oibus-agent-win_arm64.zip`}> | ||
<div>Windows (arm64)</div> | ||
</DownloadButton> | ||
</div> | ||
|
||
|
||
## Setup | ||
Unzip the archive, from which you will get three files: | ||
- OIBusAgent.exe: binary used to run the agent | ||
- install-agent.bat: script used to install the agent as a Windows service | ||
- uninstall-agent.bat: script used to uninstall the service | ||
|
||
### Installation | ||
By default, running `install-agent.bat` install the agent as a service with the name `OIBusAgent` and will listen to port `2224`: | ||
``` | ||
install-agent.bat | ||
``` | ||
|
||
But it is also possible to specify a name and a port through the command line: | ||
``` | ||
install-agent.bat -n="My OIBus Agent" -p=2225 | ||
``` | ||
|
||
### Uninstalling | ||
If the agent has been set up with default values, running the uninstallation script is enough: | ||
``` | ||
uninstall-agent.bat | ||
``` | ||
|
||
If the agent has been installed with a specific name, you must specify its name: | ||
``` | ||
uninstall-agent.bat -n="My OIBus Agent" | ||
``` | ||
|
||
## Running the agent | ||
If you just want to run the agent without using the service manager, simply run the following command in a terminal: | ||
``` | ||
OIBusAgent.exe | ||
``` | ||
|
||
<Tabs> | ||
<TabItem value="windows" label="Windows" default> | ||
<WindowsInstallation/> | ||
</TabItem> | ||
<TabItem value="linux" label="Linux"> | ||
<LinuxInstallation/> | ||
</TabItem> | ||
</Tabs> | ||
That will run the OIBus agent on its default HTTP port 2224. You can specify another port with: | ||
``` | ||
OIBusAgent.exe -p 2225 | ||
``` | ||
|
||
|
27 changes: 0 additions & 27 deletions
27
documentation/docs/guide/oibus-agent/installation/_linux.mdx
This file was deleted.
Oops, something went wrong.
31 changes: 0 additions & 31 deletions
31
documentation/docs/guide/oibus-agent/installation/_windows.mdx
This file was deleted.
Oops, something went wrong.