Pkg Binaries

Collection of NodeJS precompiled binaries to use with pkg. Please submit a pull request if you have others that are not present here.

ALL BINARIES HAVE BEEN MOVED TO RELEASES ASSETS. YOU WILL FIND ALL BINARIES HERE

Usage

Download the binary inside pkg cache folder before compiling your application.

Example with armv7 node v16.16.0 linux:

CACHE=~/.pkg-cache/custom #custom cache folder
mkdir -p $CACHE
export PKG_CACHE_PATH=$CACHE
export PKG_IGNORE_TAG=true # prevents pkg-fetch to add a tag folder
curl https://github.com/yao-pkg/pkg-binaries/releases/download/node16/built-v16.16.0-linux-armv7 -LO $CACHE/built-v16.16.0-linux-armv7 # download the binary, be sure it is prefixewd with built-, otherwise it will not work
npx pkg -t node16-linux-armv7 . # compile your application

ATTENTION

Once you have placed the file in .pkg-cache folder check that the output of file command gives you the correct interpreter:

pi@NanoPi-NEO-Plus2:~/.pkg-cache/v2.6$ file fetched-v8.11.3-linux-arm64
fetched-v8.11.3-linux-arm64: ELF 64-bit LSB shared object, ARM aarch64, version 1 (GNU/Linux), dynamically linked, interpreter /lib/ld-, for GNU/Linux 3.7.0, BuildID[sha1]=02bf3444ecc520c4da40e89cbfbf6831e3a205ea, not stripped

Sometimes when using wget it could be downloaded as HTML text file and it wouldn't work.

Utils

In utils folder you will find a bash script package.sh that I have created to package my nodejs application.

Copy the script in your app directory and edit it with your appName and the destination folder of the pkg compiled output.

# EDIT THIS WITH YOUR VALUES
APP="appName"
PKG_FOLDER="pkg"

It also automatically scan node_modules folder and adds required .node files that pkg is not able to package.

You will find all your files inside the destination folder and they will be also packaged inside a .zip file with appName and version choosed.

If you want to make things more easy add a script in your package.json file:

"scripts": {
  "start": "sudo node ./bin/www", //default to start the application
  "package": "sudo chmod +x package.sh && ./package.sh"
}

Than simply run npm run package to start the script

Compilation guide

Using Docker

This allows to compile nodejs pkg binary for arm32 (armv7l, armv6) and arm64 archs from a x86_64.

Steps

# Clone this repo
git clone https://github.com/robertsLando/pkg-binaries.git
cd pkg-binaries
# Build the required binary
chmod +x build.sh
./build.sh
# Follow build steps and wait for nodejs to be compiled (WILL TAKE AROUND 24 HOURS!)

Manually

This requires to run commands in a CPU with the required build ARCH

Here is a guide to manually compile a nodejs binary from source. Usually pkg automatically compiles this binary if it doesn't find them in his resources but this process may fail and this is how to do it by your self. In this example I'm compiling nodejs 8 LTS using a device with Linux with architecture arm64 (to check the information about your device run the comand uname -a).

1. Install required build tools:

   sudo apt-get install build-essential

2. Than clone node:

   git clone https://github.com/nodejs/node.git

3. Checkout to the desired version:

   cd node git checkout v8.11.3

4. Create the patch file inside the node dir and paste the content from the patch file you find on pkg-fetch github inside patch directory (https://raw.githubusercontent.com/zeit/pkg-fetch/master/patches/node.v8.11.3.cpp.patch)

   sudo nano node.v8.11.3.cpp.patch (Ctrl+Maiusc+V - Ctrl+X - Y)

   git apply node.v8.11.3.cpp.patch

   ./configure

   make (this takes many minutes, even hours in some devices)

5. Finally copy the binary:

   cp node ~/.pkg-cache/v2.6/fetched-v8.11.3-linux-arm64