> For the complete documentation index, see [llms.txt](https://klayoracle.gitbook.io/v1.0.0/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://klayoracle.gitbook.io/v1.0.0/fundamentals/installing-klayoracle.md).

# Installing KlayOracle

*KlayOracle v1* is still in active development, therefore the recommended installation method is by running from source.

## Installing from source

### System Requirements

* [Install Go](https://go.dev/doc/install) version 18 and above.
* Mac/Linux machine, with at least 4GB of RAM and 10GB of storage
* Docker desktop

To get started installing KlayOracle, clone the [klayoracle-monorepo](https://github.com/KlayOracle/klayoracle-monorepo.git) locally.

```bash
git clone https://github.com/KlayOracle/klayoracle-monorepo.git
cd klayoracle-monorepo
```

KlayOracle is written in Go. Go code is grouped into packages, and packages are grouped into modules. Each module specifies dependencies needed to run the code, including the Go version and the set of other modules it requires.

While installing from source, the data provider and nodes need to be configured and run through their respective packages within the monorepo.

* [Install & run data provider locally](/v1.0.0/data-providers/install-and-run-data-providers-locally.md)
* Install & run node locally

## Installing from Docker

The [KlayOracle team](https://github.com/KlayOracle/klayoracle-monorepo#contributors) is actively working on Docker images for faster installation & setup of nodes and data providers. Pending a full launch, an experimental version has been released, along with a video guide to get started.

{% embed url="<https://www.youtube.com/watch?v=Tu1QkayeXYk>" %}

This documentation will be updated in the near future with step-by-step instructions for using KlayOracle with Docker.


---

# 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://klayoracle.gitbook.io/v1.0.0/fundamentals/installing-klayoracle.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.
