Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add install docs #82

Merged
merged 1 commit into from
Jun 12, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,9 @@ ask questions, get help, or suggest ideas.

## Docs

- [Getting Started](./docs/getting-started.md)
- Tutorials
- [Getting Started](./docs/getting-started.md)
- [Install](./docs/tutorials/install.md)
- Architecture
- [Overview](./docs/architecture/overview.md)
- Manage
Expand Down
48 changes: 48 additions & 0 deletions docs/tutorials/install.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
# Install

Piko consists of a single `piko` binary for both the server and agent, using
`piko server` and `piko agent` respectively.

## Download the binary

Visit the [releases](https://github.com/andydunstall/piko/releases) page (under
'Assets') to download the Piko binary for your architecture and host.

For convenience you can rename the downloaded binary to `piko` and place it
into your `PATH`, such as `/usr/bin/piko` or `/usr/local/bin/piko`.

Run `piko -h` to verify the installation was successful.

## Build from source

Building Piko from source requires [Go](https://golang.org/doc/install) 1.22 or
higher.

Start by cloning the Piko repository from GitHub:
```
git clone https://github.com/andydunstall/piko.git
cd piko
```

Then build the `piko` binary with `make piko`, which outputs the binary to
`bin/piko`.

You can also build the Docker image with `make image`.

Run `piko -h` to verify the installation was successful.

## Docker

Visit the [packages](https://github.com/andydunstall/piko/pkgs/container/piko)
page to see the available Docker images. Each image is tagged with `latest` and
the Piko version:
```
# Latest version.
docker pull ghcr.io/andydunstall/piko:latest

# v0.4.0
docker pull ghcr.io/andydunstall/piko:v0.4.0
```

Run `docker run ghcr.io/andydunstall/piko:latest` to verify the installation
was successful.
Loading