summaryrefslogtreecommitdiffstats
path: root/packaging/makeself/README.md
diff options
context:
space:
mode:
authorTasos Katsoulas <12612986+tkatsoulas@users.noreply.github.com>2023-11-06 18:40:01 +0200
committerGitHub <noreply@github.com>2023-11-06 18:40:01 +0200
commit77996e73eedbcfba043b02902934f64d147a9c13 (patch)
treea0fd78b8bfaee169fe4c30e1b7d5bf27062ff228 /packaging/makeself/README.md
parentece352867ce5c006837e0d1ed4367eeed9bc57ea (diff)
Update packaging instructions (#16344)
1. Add repo clean up instructions for the netdata/netdata repo (clean up from previous builds) 2. Make the static build instruction to use the more generic script --------- Signed-off-by: Tasos Katsoulas <tasos@netdata.cloud> Co-authored-by: Austin S. Hemmelgarn <austin@netdata.cloud>
Diffstat (limited to 'packaging/makeself/README.md')
-rw-r--r--packaging/makeself/README.md17
1 files changed, 13 insertions, 4 deletions
diff --git a/packaging/makeself/README.md b/packaging/makeself/README.md
index 9219aefc51..1f2c746bfa 100644
--- a/packaging/makeself/README.md
+++ b/packaging/makeself/README.md
@@ -19,13 +19,20 @@ will be used by default for installation.
If you want to enforce the usage of a static build and have the installer return a failure if one is not available,
you can do so by adding `--static-only` to the options you pass to the installer.
+## Requirements
+
+- Container runtime tool (Docker or Podman)
+
## Building a static binary package
-To build the static binary 64-bit distribution package, run:
+Before you begin, make sure that your repo and the repo's submodules are clean from any previous builds and up to date.
+Otherwise, [perform a cleanup](https://github.com/netdata/netdata/blob/master/packaging/installer/methods/manual.md#perform-a-cleanup-in-your-netdata-repo)
+
+
+To build the static binary 64-bit distribution package, into the root folder on the netdata repo, run:
```bash
-cd /path/to/netdata.git
-./packaging/makeself/build-x86_64-static.sh
+./packaging/makeself/build-static.sh x86_64
```
The program will:
@@ -37,13 +44,15 @@ The program will:
Once finished, a file named `netdata-vX.X.X-gGITHASH-x86_64-DATE-TIME.run` will be created in the current directory. This is the Netdata binary package that can be run to install Netdata on any other computer.
+You can build static binaries for other architectures such as `armv7l`, `aarch64`, and `ppc64le`.
+
## Building binaries with debug info
To build Netdata binaries with debugging / tracing information in them, use:
```bash
cd /path/to/netdata.git
-./packaging/makeself/build-x86_64-static.sh debug
+./packaging/makeself/build-static.sh x86_64 debug
```
These binaries are not optimized (they are a bit slower), they have certain features disables (like log flood protection), other features enables (like `debug flags`) and are not stripped (the binary files are bigger, since they now include source code tracing information).