Skip to main content

Installing Nogon

The nogon program contains both the search server and the terminal client. For the fastest local setup, download a prebuilt binary and continue with the quickstart guide.

New releases provide Nogon binaries. Older downloads and package listings may still use the Hister name. If your installation provides hister, use that command in place of nogon in these guides.

If someone else already operates the Nogon server you use and you only search through the web interface, you do not need to install this program.

Prebuilt binary

  1. Open the latest stable release.

  2. Download the file that matches your system:

    SystemProcessorFilename ending
    LinuxIntel or AMD 64 bitlinux_amd64
    LinuxARM 64 bitlinux_arm64
    macOSApple silicondarwin_arm64
    macOSInteldarwin_amd64
    WindowsIntel or AMD 64 bitwindows_amd64.exe
  3. Rename the downloaded file to nogon or nogon.exe.

  4. On Linux or macOS, open a terminal in the download directory and make the file executable:

    chmod +x nogon
  5. Start the server:

    ./nogon listen

    On Windows, run .\nogon.exe listen instead.

  6. Open http://127.0.0.1:4433 in your browser, then continue with the quickstart to install the browser extension and begin indexing.

Release pages also contain a checksums file that can be used to verify the download. Development snapshots are available from the rolling release, but stable releases are recommended for new users.

You may optionally move the binary to a directory on your PATH, such as /usr/local/bin or ~/.local/bin.

Upgrading from Hister

Nogon reuses your existing Hister configuration and data. The rename itself does not require moving directories, exporting and importing documents, or reindexing.

  1. Stop the existing server and make a complete backup. Keep the configuration, data directory, service settings, and database connection you already use.
  2. Install the Nogon build using your usual installation method. If you replace a downloaded executable, update your launcher to its installed filename. Packages may still provide hister; use that command when nogon is unavailable.
  3. Before starting the new server, run nogon config path and nogon config show with the same --config option and environment as your server. Check the selected config file and app.directory. If multiple data directories are found, set app.directory or NOGON_DATA_DIR to the existing directory you want to use.
  4. Start the server and check that your documents and settings are present. Keep the same server URL and credentials in the extension and other clients. Follow any separate index compatibility instructions reported by the installed release.

Existing HISTER__* configuration variables, HISTER_CONFIG, HISTER_DATA_DIR, and HISTER_PORT remain supported. You can keep them unchanged. If both spellings are present, the corresponding Nogon variable takes precedence, even when empty; see environment variables for details. Service imports also accept NOGON_IMPORT_* credentials while preserving the legacy HISTER_IMPORT_* names. See the import guide for precedence.

Existing Hister config and data locations remain supported. Nogon config locations are searched first, so creating a second config file can change which file is selected. Keep your existing file or select it explicitly with --config. See configuration locations.

For managed installations, keep existing service identities and storage paths. Follow the Docker upgrade instructions, Systemd, or Nix instructions for your setup. Existing repository, download, and extension store links may still contain hister.

Older Hister releases do not gain Nogon configuration options when you rename their executable. Keep their HISTER_ settings until you install a build that supports the rename. Homebrew and WinGet compatibility changes are prepared for publication; the available commands depend on the package version you install.

Building from source

Building Nogon requires Go 1.26, npm, and a C compiler for CGO dependencies.

git clone https://github.com/asciimoo/nogon.git
cd nogon
./manage.sh build

The build produces a nogon binary in the repository root. Source is also mirrored on Codeberg.

Homebrew

If you use Homebrew, getting started with Nogon is quick and easy to do:

brew install hister

The formula currently installs the hister command. Start the server with hister listen.

Docker

The official container is published at GitHub Container Registry. See the Docker guide for a complete Compose setup, persistent storage, and reverse proxy examples.

Systemd

For a manual Linux installation, install the Nogon executable at /usr/local/bin/nogon and keep hister as an alias to that executable if you use the old command. Copy contrib/systemd/hister.service from the repository to /etc/systemd/system/hister.service.

The service uses the hister user and group, /var/lib/hister for data, and the optional /etc/hister/hister.env environment file. On a fresh installation, create that system user and group first. On an upgrade, keep the existing account, paths, ownership, and environment file.

After updating an existing installation:

sudo systemctl daemon-reload
sudo systemctl reenable hister.service
sudo systemctl restart hister.service

For a fresh installation, use sudo systemctl enable --now hister.service. Enabling the unit also creates the nogon.service alias. Commands such as systemctl status nogon.service refer to the same running service. Keep the installed filename hister.service to preserve existing service overrides.

Nix

Quick usage

Run the Nogon server directly from the repository:

nix run github:asciimoo/nogon -- listen

Add Nogon to the current shell:

nix shell github:asciimoo/nogon

Install it into your user profile:

nix profile install github:asciimoo/nogon

The package provides both nogon and the compatible hister command. The default, nogon, and hister package names select the same installation.

Flake setup

Add the input to flake.nix:

{
  inputs.nogon.url = "github:asciimoo/nogon";

  outputs = { self, nixpkgs, nogon, ... }: {
    nixosConfigurations.yourHostname = nixpkgs.lib.nixosSystem {
      modules = [
        ./configuration.nix
        nogon.nixosModules.default
      ];
    };

    homeConfigurations."yourUsername" = home-manager.lib.homeManagerConfiguration {
      modules = [
        ./home.nix
        nogon.homeModules.default
      ];
    };

    darwinConfigurations."yourHostname" = darwin.lib.darwinSystem {
      modules = [
        ./configuration.nix
        nogon.darwinModules.default
      ];
    };
  };
}

Service configuration

Enable and configure the service in your configuration file:

services.nogon = {
  enable = true;

  # Optional: Set via Nix options. These take precedence over the config file.
  # port = 4433;
  # dataDir = "/var/lib/hister";
  # openFirewall = true; # NixOS only
  # configPath = /path/to/config.yml;
  # environmentFile = "/run/secrets/hister.env";

  settings = {
    app = {
      search_url = "https://google.com/search?q={query}";
      log_level = "info";
    };
    server = {
      address = "127.0.0.1:4433";
      database = "db.sqlite3";
    };
  };
};

The NixOS module uses a hardened systemd service. The Linux Home Manager module uses a systemd user service, while the Darwin modules use a launchd agent. Use environmentFile for secrets on supported Linux services instead of placing them in the world readable Nix store.

Existing services.hister settings and hister module imports still work. Both option names configure the same service; conflicting values produce a Nix configuration error. Linux retains hister.service, with nogon.service as an alias. Darwin retains the existing launchd agent name. Keep your current data paths and environment files when upgrading.

To install only the package without enabling a service:

{ inputs, pkgs, ... }: {
  environment.systemPackages = [ inputs.nogon.packages.${pkgs.stdenvNoCC.hostPlatform.system}.default ];
}

For Home Manager:

{ inputs, pkgs, ... }: {
  home.packages = [ inputs.nogon.packages.${pkgs.stdenvNoCC.hostPlatform.system}.default ];
}

Proxmox VE

Nogon is available through the Proxmox VE Community Scripts project for LXC installations:

bash -c "$(curl -fsSL https://raw.githubusercontent.com/community-scripts/ProxmoxVED/main/ct/hister.sh)"

This installer is maintained by the community scripts project, not by Nogon. Review the script before running it on your Proxmox host.