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

# Installation

Iris is a cross-platform software.

The only requirement is the [Go Programming Language](https://go.dev/dl/), version 1.20 and above.

## Install

```bash
$ go get github.com/kataras/iris/v12@latest
```

Or edit your project's `go.mod` file.

```bash
module your_project_name

go 1.20

require (
    github.com/kataras/iris/v12 v12.2.0
)
```

> `$ go build`

## Troubleshooting

If you get a network error during installation please make sure you set a valid [GOPROXY environment variable](https://github.com/golang/go/wiki/Modules#are-there-always-on-module-repositories-and-enterprise-proxies).

```bash
go env -w GOPROXY=direct
```

Perform a clean of your go modules cache if none of the above worked:

```sh
go clean --modcache
```