Skip to main content

Installation Guide 📥

Step 1: download and install freeware Wolfram Engine for developers.

Step 2: install WLJS from the binaries hosted at Github or homebrew.

Alternatively you can skip steps 1, 2 and use a complete Docker Image (see further).

see also

All releases

Windows​

Download and install the latest .exe. Only x86/64-bit architecture is supported

Linux​

sudo apt install ./wljs-notebook.deb

⚠ Ubuntu 24.04 users: If you encounter AppArmor issues, run:

sudo sysctl -w kernel.apparmor_restrict_unprivileged_userns=0
Using .zip Archive​

Extract and run the wljs-notebook executable.

macOS​

Using .dmg Installer​
  • Apple Silicon users: Download the -arm64.dmg version.
  • Intel Mac users: Use the regular .dmg version.
Using Homebrew​
brew install --cask wljs-notebook

🚢 Running using Docker​

note

Certain features such as image/sound recording might require https connection if you are running it not on a local machine. See how to set up a proxy in 📦 Docker Container Setup

Step 1: register and get developer license for freeware Wolfram Engine at wolfram.com

Step 2: deploy WLJS Notebook in a single line of code to any machine!

docker run -it \
  -v wljs_data:/wljs \
  -v ~/wljs:"/home/wljs/WLJS Notebooks" \
  -v ~/wljs/Licensing:/home/wljs/.WolframEngine/Licensing \
  -e PUID=$(id -u) \
  -e PGID=$(id -g) \
  -p 8000:3000 \
  --name wljs \
  ghcr.io/wljsteam/wolfram-js-frontend:main

Then open http://127.0.0.1:8000

🛠️ GitHub Repo
📦 Docker Container Setup

In the case if you do not have docker, clone it directly from the repository as follows.

warning

Some features require WLJS Desktop App:

  • Export[_, _, "PDF"] - export to PDF
  • Rasterize - expressions rasterization
  • SystemOpen - open files/folders using OS system calls
  • SystemInputDialog - open system file dialog
  • automatic core updates

⚙️ Running WLJS Notebook as a Local Server​

note

Certain features such as image/sound recording might require https connection if you are running it not on a local machine

You can run WLJS Notebook without a desktop app—just using wolframscript.

git clone https://github.com/JerryI/wolfram-js-frontend
cd wolfram-js-frontend
wolframscript -f Scripts/start.wls

For a specific hostname and port setup:

wolframscript -f Scripts/start.wls host 0.0.0.0 http 8080 ws 8081 ws2 8082 docs 8085

Additional options:

wolframscript -f Scripts/start.wls folder "Demos"  # Set home folder
wolframscript -f Scripts/start.wls noautolaunch True  # Disable autolaunch

On-demand license​

If you want to try WLJS Notebook without binding the free license to your machine, you can issue license entitlement using Wolfram Cloud or a friend. Then

git clone https://github.com/JerryI/wolfram-js-frontend
cd wolfram-js-frontend
wolframscript -f Scripts/start.wls -entitlement XXX-CODE-OF-ENTITLEMENT-XXX

Note: in this regime the evaluation kernel works much slower

🔗 Useful Links​

⚖️ Licensing​

WLJS Notebooks (including all extensions, frontend and backend) is licensed under GPLv3 👩🏼‍⚖️ The algorithms, functions, and other components of Wolfram Language provided by the Wolfram Engine are the intellectual property of Wolfram Research, Inc. See the license agreement for details.

Last updated on