Tam Nguyen Duc
28d08ade88
The tap distributes kage as a Cask (prebuilt binary), not a Formula, so brew needs --cask to find it. Without the flag brew errors out with "No available formula or cask with the name kage".
92 lines
2.4 KiB
Markdown
92 lines
2.4 KiB
Markdown
---
|
|
title: "Installation"
|
|
description: "Install kage from Go, Homebrew, Scoop, a release archive, a Linux package, or the container image, and point it at a browser."
|
|
weight: 20
|
|
---
|
|
|
|
kage is a single binary. Pick whichever channel suits you.
|
|
|
|
## Go
|
|
|
|
```bash
|
|
go install github.com/tamnd/kage/cmd/kage@latest
|
|
```
|
|
|
|
## Homebrew (macOS)
|
|
|
|
```bash
|
|
brew install --cask tamnd/tap/kage
|
|
```
|
|
|
|
The cask installs the prebuilt macOS binary. On Linux, use the packages below or
|
|
`go install`.
|
|
|
|
## Scoop (Windows)
|
|
|
|
```bash
|
|
scoop bucket add tamnd https://github.com/tamnd/scoop-bucket
|
|
scoop install kage
|
|
```
|
|
|
|
## Linux (apt and dnf)
|
|
|
|
A signed apt and dnf repository tracks every release, so `apt upgrade` and
|
|
`dnf upgrade` keep kage current.
|
|
|
|
```bash
|
|
# Debian, Ubuntu
|
|
curl -fsSL https://tamnd.github.io/linux-repo/gpg.key \
|
|
| sudo gpg --dearmor -o /usr/share/keyrings/tamnd.gpg
|
|
echo "deb [signed-by=/usr/share/keyrings/tamnd.gpg] https://tamnd.github.io/linux-repo/apt stable main" \
|
|
| sudo tee /etc/apt/sources.list.d/tamnd.list
|
|
sudo apt update && sudo apt install kage
|
|
|
|
# Fedora, RHEL
|
|
sudo dnf config-manager --add-repo https://tamnd.github.io/linux-repo/dnf/tamnd.repo
|
|
sudo dnf install kage
|
|
```
|
|
|
|
## Release archives and Linux packages
|
|
|
|
Every [release](https://github.com/tamnd/kage/releases) attaches `tar.gz`
|
|
archives (and a `.zip` for Windows) for Linux, macOS, Windows, and FreeBSD, plus
|
|
`.deb`, `.rpm`, and `.apk` packages and a `checksums.txt` with a cosign
|
|
signature. Download the one for your platform, extract `kage`, and put it on your
|
|
`PATH`. To install a package directly without the repo above:
|
|
|
|
```bash
|
|
# Debian/Ubuntu
|
|
sudo dpkg -i kage_*_amd64.deb
|
|
|
|
# Fedora/RHEL
|
|
sudo rpm -i kage-*.x86_64.rpm
|
|
```
|
|
|
|
## Container
|
|
|
|
The image bundles Chromium, so it needs nothing else:
|
|
|
|
```bash
|
|
docker run -v "$PWD/out:/out" ghcr.io/tamnd/kage clone example.com
|
|
```
|
|
|
|
The mirror lands in `./out/example.com/` on your host.
|
|
|
|
## You need a browser
|
|
|
|
kage drives a real Chrome to render pages. Outside the container image, it needs
|
|
Chrome or Chromium available on the machine. It looks for a system install
|
|
automatically (Google Chrome on macOS and Windows, `google-chrome`/`chromium` on
|
|
Linux). To use a specific binary:
|
|
|
|
```bash
|
|
kage clone example.com --chrome /path/to/chromium
|
|
# or
|
|
export KAGE_CHROME=/path/to/chromium
|
|
```
|
|
|
|
If no browser is found, kage's launcher can download a private copy of Chromium
|
|
on first use.
|
|
|
|
Next: [the quick start](/getting-started/quick-start/).
|