Skip to content

Commit

Permalink
Add guide on how to run jalapeno via Docker (#43)
Browse files Browse the repository at this point in the history
Co-authored-by: Antti Kivimäki <[email protected]>
  • Loading branch information
kaplas and majori authored Sep 7, 2023
1 parent 88eb5ac commit eca285f
Show file tree
Hide file tree
Showing 2 changed files with 43 additions and 5 deletions.
47 changes: 42 additions & 5 deletions docs/docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,52 @@ title: Installation

## From the Binary Releases

Every release of Jalapeno provides binary releases for a variety of OSes. These binary versions can be manually downloaded and installed.
Cross-platform binaries are provided with each release of Jalapeno. These can manually be
downloaded and installed from [GitHub releases](https://github.com/futurice/jalapeno/releases/).

1. Download your [desired version](https://github.com/futurice/jalapeno/releases)
1. Make the binary executable (`chmod +x jalapeno-linux-amd64`)
1. Rename and move the binary to proper location (`mv jalapeno-linux-amd64 /usr/local/bin/jalapeno`)
In short the process is:

1. Download [the latest version of jalapeno](https://github.com/futurice/jalapeno/releases/latest)
for your platform
2. Make the binary executable
3. Rename and move the binary to proper location

For example on MacOS (running on Apple Silicon) this can be done with:

```bash
curl -L https://github.com/futurice/jalapeno/releases/latest/download/jalapeno-darwin-arm64 -o jalapeno
chmod +x jalapeno
mv jalapeno /usr/local/bin/jalapeno
```

## Use via Docker

It is possible to use jalapeno via Docker without installing it locally. Jalapeno image is available
from the GitHub Container Registry, and thus the following command on a *nix system is equivalent
to running `jalapeno` locally:

MacOS and Linux:

```bash
docker run -it --rm -v $(pwd):/workdir ghcr.io/futurice/jalapeno:v0.1.4
```

Windows Command Line:

```batch
docker run -it --rm -v %cd%:/workdir ghcr.io/futurice/jalapeno:v0.1.4
```

PowerShell:

```powershell
docker run -it --rm -v ${PWD}:/workdir ghcr.io/futurice/jalapeno:v0.1.4
```

## Build From Source

First, make sure you have [Go](https://go.dev/doc/install) and [Task](https://taskfile.dev/installation) installed.
First, make sure you have [Go](https://go.dev/doc/install) and
[Task](https://taskfile.dev/installation) installed.

Then you can compile the binary with following commands:

Expand Down
1 change: 1 addition & 0 deletions docs/docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,7 @@ const config = {
prism: {
theme: lightCodeTheme,
darkTheme: darkCodeTheme,
additionalLanguages: ['batch', 'powershell'],
},
}),
};
Expand Down

0 comments on commit eca285f

Please sign in to comment.