Installation & Setup

Visit our website and log in to your account.
Go to the download page.
Select and download the single executable for Windows or Linux.
Run the program, and open the url given by the program.
Login to your account
Done.

Program Options (settings.yaml)

The settings.yaml file allows you to configure Burjuva TradeHub’s core behavior, including data storage, server settings, and update preferences.
The file must be located in the same directory as the application executable in order for the program to load it

Available Options

`dataPath`

Type: String (Path)
Linux Default: /home/<Username>/.local/share/burjuva-tradehub
Windows Default: c:\Users\<Username>\AppData\Roaming\burjuva-tradehub
Description:
The absolute path where all your data will be stored.
Example:
```
dataPath: "/home/user/tradehub"
```

Server Configuration (server)

Defines settings for the built-in HTTP server (used for web UI or API access).

host
- Type: IPv4 address
- Default: 127.0.0.1
- Description: Network interface to bind the server to. Use 127.0.0.1 for local access only.
- Example:
```
server:
  host: "127.0.0.1"
```
port
- Type: Number (Valid port range)
- Default: 3000
- Description: Port on which the server will run.
- Example:
```
server:
  port: 3000
```
tls
- Type: Boolean
- Default: false
- Description: Enable or disable TLS/HTTPS for secure connections.
  If set to true, you must provide the following files at:
  {dataPath}/tls/key.pem
  {dataPath}/tls/cert.pem
Example:
```
server:
  tls: true
```
cors
- Type: Boolean
- Default: false
- Description: Enable or disable CORS for API access from other domains. If you don’t need this functionality, its better to keep it false
- Example:
```
server:
  cors: false
```

Update Configuration (update)

Controls how application updates are handled.

Automatic Updates (Default)

By default, the program updates itself automatically.
You will always have the latest version without needing to download it manually.

Manual Updates (Optional)

If you prefer manual updates or having trouble with auto-update:
1. Download the latest executable from the Download page.
2. Replace (overwrite) your existing executable with the new one.
This is basically the same as using the automatic update feature.
method
- Type: String
- Default: auto
- Allowed Values: auto, only_download, manual
- Description:
  - auto → Download and install updates automatically.
  - only_download → Download updates but prompt before installing.
  - manual → Check for updates manually.
- Example:
```
update:
  method: auto
```
channel
- Type: String
- Default: stable
- Allowed Values: stable, beta
- Description: If you are not a beta tester, this option has no effect
  Choose the update channel:
  - stable → Official stable releases (recommended).
  - beta → Pre-release versions with early features.
- Example:
```
update:
  channel: stable
```

✅ Example `settings.yaml`

dataPath: "/home/user/tradehub/data"
server:
  host: "127.0.0.1"
  port: 3000
  tls: false
  cors: false
update:
  method: auto
  channel: stable