ecodash/BUILD.md

28 lines
1.6 KiB
Markdown

# 👷 Building EcoDash
Here's how to build EcoDash in both binaries and as a Docker container. This is not necessary for most cases - we provide both pre-built binaries and containers for Linux ARM and x86_64 - however in devices with unsupported architectures it's necessary.
You're encouraged to first check the installation instructions to see if a pre-built container or binary is already available.
If you really have to build it yourself, we recommend you Docker over binaries.
## Binaries
### Linux
1. Download the Go Compiler from https://go.dev/dl/ or from your repository's package manager (it's usually called `go` or `golang`)
2. Download the Git SCM from https://git-scm.com/download/linux or from your package manager (it's always called `git`)
3. Clone the repository by running `git clone https://gitea.massivebox.net/ecodash/ecodash.git ` inside a command prompt
4. Switch to the project directory with `cd ecodash`
5. Download the dependencies with `go get ecodash`
6. Build with `go build`. This will generate an executable, `ecodash`, in the same directory.
### Windows
1. Install the latest release of the Go Compiler for Windows from https://go.dev/dl/
2. Install the Git SCM from https://git-scm.com/download/win. The "Standalone installer" is recommended. All the default settings will work fine.
3. Clone the repository by running `git clone https://gitea.massivebox.net/ecodash/ecodash.git ` inside a command prompt
4. Switch to the project directory with `cd ecodash`
5. Download the dependencies with `go get ecodash`
6. Build with `go build`. This will generate an executable, `ecodash.exe`, in the same directory.
## Docker