> For the complete documentation index, see [llms.txt](https://docs.bosonnetwork.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.bosonnetwork.io/getting-started/install.md).

# Try Boson Locally

What you install depends on what you want to do.

| I want to...                           | Install                                            | Guide                                          |
| -------------------------------------- | -------------------------------------------------- | ---------------------------------------------- |
| Build an application with the Java SDK | **Nothing.** The SDK is published to Maven Central | [Java SDK](/build-applications/java-sdk.md)    |
| Try a super node on my own computer    | The ZIP archive                                    | This page                                      |
| Run a node on a server                 | A DEB package or the public setup tool             | [Installation](/deploy-a-node/installation.md) |

This page covers the ZIP archive: a complete super node you can run from your home directory, without installing a system service. It is meant for trying Boson out and for developing against a local node. For a node other people or devices depend on, use the [server installation](/deploy-a-node/installation.md) instead.

***

## Download

Get the archive for your platform from [Boson.Releases](https://github.com/bosonnetwork/Boson.Releases/releases):

| Platform             | Archive                              |
| -------------------- | ------------------------------------ |
| macOS, Apple Silicon | `boson-<version>-macos-aarch64.zip`  |
| macOS, Intel         | `boson-<version>-macos-x86_64.zip`   |
| Linux, x86\_64       | `boson-<version>-linux-x86_64.zip`   |
| Linux, aarch64       | `boson-<version>-linux-aarch64.zip`  |
| Windows, x86\_64     | `boson-<version>-windows-x86_64.zip` |

Each archive includes its own Java runtime.

***

## Unpack and start

{% tabs %}
{% tab title="macOS" %}

```bash
unzip boson-<version>-macos-aarch64.zip
cd boson-<version>
xattr -rd com.apple.quarantine .    # allow the bundled runtime and tools to run
./bin/boson.sh
```

{% endtab %}

{% tab title="Linux" %}

```bash
sudo apt-get install libsodium23    # Debian/Ubuntu; use your distribution's libsodium package elsewhere
unzip boson-<version>-linux-x86_64.zip
cd boson-<version>
./bin/boson.sh
```

{% endtab %}

{% tab title="Windows" %}
The launchers are shell scripts, so run them from Git Bash or WSL:

```bash
unzip boson-<version>-windows-x86_64.zip
cd boson-<version>
./bin/boson.sh
```

{% endtab %}
{% endtabs %}

The first time you start it, `boson.sh` finds no configuration and runs the [setup wizard](/deploy-a-node/installation/setup-wizard.md) interactively. It asks for a node name and a few optional details, generates the node's identity, and writes the configuration to `~/.config/boson`. When it finishes, start the node:

```bash
./bin/boson.sh
```

The node runs in the foreground; press `Ctrl-C` to stop it. It logs to `~/.local/state/boson/logs/boson.log`, or the log directory you chose in the wizard.

***

## Check that it works

Ask the node for its status. It uses a self-signed certificate, so tell `curl` not to verify it:

```bash
curl -k https://localhost:9000/api/v1/client/node
```

Then open the web consoles in a browser, accepting the certificate warning:

| URL                              | What it is           |
| -------------------------------- | -------------------- |
| `https://localhost:9000/`        | The node's home page |
| `https://localhost:9000/admin/`  | Admin dashboard      |
| `https://localhost:9000/portal/` | User portal          |

A node on a laptop behind a home router joins the DHT and works fine for development, but other people's devices cannot reach its services. That is what the [server installation](/deploy-a-node/installation.md) is for.

***

## What is in the archive

```
boson-<version>/
  bin/
    boson.sh              Start the super node (runs the setup wizard on first start)
    bootstrap.sh          Start a DHT-only bootstrap node
    dht-shell.sh          Interactive DHT shell
    boson-director-cli    Admin command-line tool
    boson-cli             Key and encoding utilities
  lib/                    Java libraries
  jre/                    Bundled Java runtime
  web/                    Admin dashboard, user portal and home page
```

***

## Next steps

* [Run Your First Node](/getting-started/first-node.md): look around the node you just started
* [Explore with the DHT Shell](/getting-started/dht-shell.md)
* [Hello Boson](/getting-started/hello-boson.md): your first application


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.bosonnetwork.io/getting-started/install.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
