2 Install
Gwen Gullett edited this page 2026-07-19 17:38:02 -04:00

Writers Notebook runs on many different platforms and has two primary options; Desktop app, or, Server but not all are available for all platforms.

The desktop application will open a window and acts like any other application you might run on your computer.

The server mode is "headless" where it does not open a new window but instead will start a local web server that you may reach at http://localhost:5173.

MacOS Installation

  1. Open the Releases page Releases
  2. Download the latest *.dmg file
  3. Double-click the dmg file to open it
  4. Accept the license
  5. Drag and Drop the Writers Notebook app into the Applications directory in the finder window (follow the arrow)
  6. Open the App

NOTE: You might get an error trying to open the app after install. Go to System Settings > Privacy and Security and scroll to the bottom. There should be an option to allow the app to open. After accepting, it should work.

Apple instructions for unsigned apps

Windows

NOTE: You will likely get an error about a "Windows Protected.." popup when running this the first time, that is to be expected! Click on "More Info" and then "Run Anyway" to install or run the application.

There are two options for Windows with and without an installer.

  1. Open the Releases page Releases
  2. Download one of these assets for the latest version:
    • WritersNotebook-vX.Y.Z-windows-amd64-installer.exe (recommended)
    • WritersNotebook-vX.Y.Z-windows-amd64.exe (portable binary)
  3. If you downloaded the installer, run it and follow the prompts.
  4. If you downloaded the portable .exe, place it somewhere like C:\Program Files\WritersNotebook\ and optionally add that folder to your PATH.

Linux

Use one of the following copy/paste commands to fetch and run the repo installer script:

Linux install with curl

curl -fsSL "https://code.legionsalliance.com/WritersNotebook/WritersNotebook/raw/branch/main/scripts/linux_install" -o /tmp/linux_install && chmod +x /tmp/linux_install && /tmp/linux_install

Linux install with wget

wget -qO /tmp/linux_install "https://code.legionsalliance.com/WritersNotebook/WritersNotebook/raw/branch/main/scripts/linux_install" && chmod +x /tmp/linux_install && /tmp/linux_install

The installer downloads the latest WritersNotebook-vX.Y.Z-linux-amd64 release, renames it to writers-notebook, and installs it to a standard PATH location (/usr/local/bin when possible).