finished install section

This commit is contained in:
Dan Anglin 2024-02-25 15:27:26 +00:00
parent 26a909d276
commit 93c30fc438
Signed by: dananglin
GPG key ID: 0C1D44CFBEE68638

View file

@ -43,7 +43,36 @@ during compilation. You can visit the https://magefile.org/[Mage website] for in
==== Install with mage ==== Install with mage
==== Install with go build You can install Enbas with Mage using the following commands:
[source,console]
----
git clone https://github.com/dananglin/enbas.git
cd enbas/internal/build/
mage install
----
By default Mage will attempt to install Enbas to `/usr/local/bin/enbas` which will most likely fail as you won't
the permission to write to `/usr/local/bin/`. You will need to either run `sudo mage install`, or you can
(preferably) change the install prefix to a directory that you have permission to write to using
the `ENBAS_INSTALL_PREFIX` environment variable. For example:
[source,console]
----
ENBAS_INSTALL_PREFIX=${HOME}/.local mage install
----
This will install Enbas to `~/.local/bin/enbas`.
==== Install with go
If your `GOBIN` directory is included in your `PATH` then you can install Enbas with Go.
[source,console]
----
git clone https://github.com/dananglin/enbas.git
cd enbas
go install ./cmd/enbas
----
== Configuration == Configuration