Build the lightest node binary possible

[jsdario]

I am working right now onto installing node.js onto OpenWRT routers. Due to memory restrictions I am afraid that it employs more space that we actually pursue, and sometimes way more than routers can actually hold.

How can we achieve the smallest node binary possible?

We want to (cross-)compile node from source to achieve the minimal disk use possible SSL/TLS is mandatory for us, but for example npm is not.

Links will be appreciated. I have been querying google for a couple of days now, but got little information. Thank you all. Hope that this question is reusable for the community.

[bnoordhuis]

Can I suggest cross-compiling?

[jsdario]

Sure I was considering it, but can you give some more insight on what you are pointing? There are lots of cross-compilers and methods, but I am more interested on removing dependencies and editing makefiles.

[imyller]

I maintain OpenEmbedded build recipes for all Node.js releases at https://github.com/imyller/meta-nodejs

I've separated nodejs and nodejs-npm for separate cross-compilable packages for deployment to embedded devices. There is also a build time helper for calling cross-compiling capable npm install so that Node.js based software with native dependencies can be pre-compiled and packaged for deployment to minimal storage devices.

This is considered production quality so it can be used in shipping embedded products.

I know OpenWRT is not using OE compatible build system, but thought this might give you some pointers to right direction.

[imyller]

.. also you can separate the bundled openssl and zlib from the node.js binary and use shared libraries potentially saving you some space; especially if those libraries are used elsewhere in your embedded device software stack.

[jsdario]

Great @imyller that is so useful. I will share any progress into that direction.

I believe it is possible to configure SSL layer though other software (e.g a localhost proxy) and so zlib as you were pointing.

In any case if someone has faced the same question I would still like to read it.

[bnoordhuis]

I read your question as "compiling on the device itself, how can we use the least space possible?" but I gather it's more about reducing the size of the final binary? Strip the debug info (it's enabled by default), link everything dynamically and disable i18n; ./configure --help has the details.

Linking against a shared openssl and v8 are probably the biggest wins but please note that dynamic linking is not really supported and may not work unless you're linking against the exact same version that node uses (including any patches we float.)

[jsdario]

Just edited the question to reflect @bnoordhuis point. Yes it is more about reducing the size of the final binary. Also it is really helpful to note:

linking is not really supported and may not work unless you're linking against the exact same version that node uses Since node is a priority for our design, is important to take that in account. Thank you.

[rvagg]

and don't include ICU .. it's kind of large

[piranna]

I'm using musl as libc on NodeOS and binary size got reduced a couple of megabytes (about 9.6mb for Node.js v0.11.14). Also it was suggested to move build-ins to global node_modules folder, so binary size gets smaller and use less memory since only get loaded required modules. I was going to open an issue requesting an option for it, but after I've seen this issue maybe we can disscuss it here.

[stopspazzing]

Funny you asked this question, I working on the same project @jsdario started few days ago also. Working on modding Gargoyle Firmware which uses OpenWRT sources to build a custom version of the firmware. Size contraints require the size well below 4mb binary. Only need the bare minimum to run an app that uses express.js and io.js (you guys just merged so guess no longer needed separately) to create a webpage which will be the router webpage and access system information. Currently uses javascript files with sh files running through a hasbrel interpreter which I believe is totally archaic. I have lots of time today to work on this project, however, I am not sure how to start building a custom version of node. I do have a workspace to do such a task, so if someone could point me in right direction could make some custom "light" versions. I think we can both benefit from this project @jsdario :)

[piranna]

As @heavyk commented on NodeOS issues, I would start by moving all the build-in modules from the /lib to an external node_modules folder and force Node.js to use it, so the binary gets smaller and you can be able to remove the modules that you are not using.

[jbergstroem]

my 2c (this will not give you a full test pass build though, so beware):

• use musl
• disable openssl
• use a shared zlib
• no icu
• go wild with strip
• compile a 32-bit binary

optionals:

• try -Os
• theres a ton of flags to both linker and gcc (google will show the way)

[srl295]

@rvagg : "don't include ICU"

configure ... --with-intl=none

.. note what's off though.

[stopspazzing]

thank you @piranna Could you point me to the correct location so I can read up on how to force node to use an external folder?

[piranna]

It's not currently possible on Node.js "as is", but according to the suggestion on the link I put before, seems it should be easy. If you do it please keep us informed. El 26/09/2015 05:14, "Jeremy Zimm" notifications@github.com escribió:

thank you @piranna https://github.com/piranna Could you point me to the correct location so I can read up on how to force node to use an external folder?

— Reply to this email directly or view it on GitHub https://github.com/nodejs/node/issues/2948#issuecomment-143393874.

[jasnell]

@nodejs/documentation @nodejs/build ... just making a note on this one: having some documentation on how to build the smallest possible node binary would be beneficial.

Going to close this issue, however, as there does not appear to be anything actionable here.

[Knighton910]

+1 Going to close this issue, however, as there does not appear to be anything actionable here.

[jsdario]

:+1: Thanks all for your contributions, we made good progress from this.

[drensber]

Could you please report the approximate size of the reduced binary that you were able to achieve? I think that would be useful for others who are considering using node.js in an embedded system and come across this thread.

[markstos]

disable openssl

Might you need OpenSSL for outgoing connections even if you don't need it for incoming connections? I guess it's safe to disable as long as you know you don't need it for connections in either direction.

[HardlyMirage]

Version 8.11.1

./configure && make -rwxr-xr-x 1 root root 34.7M Apr 18 19:00 out/Release/node

./configure --without-intl --without-ssl && make -rwxr-xr-x 1 root root 23.4M Apr 18 19:32 out/Release/node

./configure --without-intl --without-ssl && make CFLAGS='-Os' -rwxr-xr-x 1 root root 23.1M Apr 18 19:45 out/Release/node

Note that the debugger and eslint will break with the leaner binary: https://github.com/nodejs/node/issues/12758 https://github.com/nodejs/node/issues/5610

[jasnell]

Building against shared libraries for the dependencies may help as well. Note also that building without intl and ssl will disable many core APIs and cripple the binary in many ways. Proceed with caution.

[HardlyMirage]

I'm building upon Alpine, what shared libraries can I use here?

[ORESoftware]

what's the size of the nodejs binary these days?

[piranna]

what's the size of the nodejs binary these days?

71MB (73729384 bytes) for Node.js v14.11.0 on Ubuntu Linux x86_64

[piranna]

So far I remember it was about 14MB in 2016, probably this size increment is due to ICU internationalization rules and data.

[srl295]

14MB sounds about right. You can try building with "--without-intl " and compare the difference.

[markstos]

On Arch Linux, the nodejs package is built with --with-intl=system-icu and the resulting binary is 25M. So that's probably about the savings that can be expected.

I did some comparisons of the startup times and memory use of the Arch builds vs the official builds, which are 71M. The startup times and RSS memory use are very close in both builds, so the primary difference really seems to be the file size.

 time node -e 'c = require("child_process"); c.exec(`ps u | grep "node

-e"`, (e, o) => console.log(o))'

On Wed, Sep 23, 2020 at 9:36 AM Steven R. Loomis notifications@github.com wrote:

14MB sounds about right. You can try building with "--without-intl " and compare the difference.

— You are receiving this because you commented. Reply to this email directly, view it on GitHub https://github.com/nodejs/node/issues/2948#issuecomment-697368937, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAAGJZOVTHEWHFTECLK77FLSHH2XPANCNFSM4BP645YQ .

-- Mark Stosberg Director of Systems and Security RideAmigos

[guest271314]

Any progress and recipe for minimal Node.js build?

[Ashvith10]

@jasnell what about the JS libraries within the deps folder? Wouldn't it be impossible to separate them, as they're circular dependencies?