From 088a9006cdc98a52f9daa468bfe0d61c971e664b Mon Sep 17 00:00:00 2001 From: Kris Zyp Date: Wed, 22 Apr 2026 10:33:49 -0600 Subject: [PATCH 1/4] Update harperdb->harper --- .../harper-applications-in-depth.mdx | 6 ++-- .../install-and-connect-harper.mdx | 32 +++++++++---------- 2 files changed, 19 insertions(+), 19 deletions(-) diff --git a/learn/developers/harper-applications-in-depth.mdx b/learn/developers/harper-applications-in-depth.mdx index 48483525..b3ac25a0 100644 --- a/learn/developers/harper-applications-in-depth.mdx +++ b/learn/developers/harper-applications-in-depth.mdx @@ -70,7 +70,7 @@ Within every Harper installation are these core files and directories: ┠─ keys/ ┠─ log/ ┠─ harper-application-lock.json - ┠─ harperdb-config.yaml + ┠─ harper-config.yaml ┠─ hdb.pid ┠─ operations-server ┗━ README.md @@ -90,7 +90,7 @@ The directories themselves are fairly self-explanatory: The `harper-application-lock.json` file is similar to any sort of lockfile. Its purpose is to ensure Harper is installing the correct versions of applications and plugins. This is an internal file and you shouldn't ever have to modify it yourself. -Finally, and most importantly is the `harperdb-config.yaml`. This is the main configuration file for your Harper installation. Lets open this file and inspect its contents. Local users should open it in their editor of choice, Fabric users should navigate to the "Config" tab from their main organization view. +Finally, and most importantly is the `harper-config.yaml`. This is the main configuration file for your Harper installation. Lets open this file and inspect its contents. Local users should open it in their editor of choice, Fabric users should navigate to the "Config" tab from their main organization view. You should see a number of top-level properties such as `http`, `threads`, `authentication`, and more. Each of these corresponds to one of Harper's built-in core features. This file is the source of truth for Harper configuration values. You can make changes directly to the file and then restart Harper for them to take affect. @@ -477,7 +477,7 @@ Harper provides the ability to launch a proper debugger as part of the Harper pr Harper v4 ships as a built and minified package, so debugging the Harper source may be confusing; you generally will only want to debug your custom code. However, in the near future, as Harper v5 is released using our new open source core, you will be able to debug Harper's core too! ::: -Before getting started, either open the `harperdb-config.yaml` file or use the Operations API to inspect how Harper is currently configured (using the `get_configuration` operation). We are looking for the `"threads"` part of the configuration object in particular. +Before getting started, either open the `harper-config.yaml` file or use the Operations API to inspect how Harper is currently configured (using the `get_configuration` operation). We are looking for the `"threads"` part of the configuration object in particular. diff --git a/learn/getting-started/install-and-connect-harper.mdx b/learn/getting-started/install-and-connect-harper.mdx index 1213e437..fb6c5489 100644 --- a/learn/getting-started/install-and-connect-harper.mdx +++ b/learn/getting-started/install-and-connect-harper.mdx @@ -7,7 +7,7 @@ import TabItem from '@theme/TabItem'; import GeneralPrerequisites from '../../src/components/learn/general-prerequisites.mdx'; -One of Harper's primary goals since day one was to be easy to install and get started with. The core Harper application itself is just a Node.js application with some native module dependencies. The simplest and easiest way to get started using Harper is by installing it using npm (or any npm compatible Node.js package manager). In addition to installing Harper directly to your local development environment, the Harper team provides a Docker image ([`harperdb/harperdb`](https://hub.docker.com/r/harperdb/harperdb)), and most recently a platform service called [Harper Fabric](https://fabric.harper.fast). +One of Harper's primary goals since day one was to be easy to install and get started with. The core Harper application itself is just a Node.js application with some native module dependencies. The simplest and easiest way to get started using Harper is by installing it using npm (or any npm compatible Node.js package manager). In addition to installing Harper directly to your local development environment, the Harper team provides a Docker image ([`harperfast/harper`](https://hub.docker.com/r/harper/harper)), and most recently a platform service called [Harper Fabric](https://fabric.harper.fast). This guide will demonstrate all three ways to get started as well as introduce some basic Harper features such as the CLI and our built in health endpoint. @@ -33,12 +33,12 @@ If you want to use the cloud-hosted, platform service Harper Fabric instead of a -Harper is published to the npm registry as [`harperdb`](https://www.npmjs.com/package/harperdb) and requires Node.js current, active LTS, or maintenance LTS versions to run. +Harper is published to the npm registry as [`harper`](https://www.npmjs.com/package/harper) and requires Node.js current, active LTS, or maintenance LTS versions to run. The fastest way to get started is by installing Harper globally using an npm compatible package manager: ```bash -npm install -g harperdb +npm install -g harper ``` Then, execute the Harper CLI: @@ -47,7 +47,7 @@ Then, execute the Harper CLI: harper ``` -When installing locally on your machine, you can specify any destination for Harper, we recommend using something within your home directory such as `$HOME/hdb`. Keep note of what you specify for the username and password. Make sure you select the `dev` default config and set the hostname to `localhost`. +When installing locally on your machine, you can specify any destination for Harper, we recommend using something within your home directory such as `$HOME/harper`. Keep note of what you specify for the username and password. Make sure you select the `dev` default config and set the hostname to `localhost`. :::important Do not actually enter `$HOME` in the destination prompt; it should automatically fill in the value of your home directory. Otherwise, specify the absolute path for the Harper installation. @@ -59,7 +59,7 @@ Starting HarperDB install... Terms & Conditions can be found at https://harperdb.io/legal/end-user-license-agreement and can be viewed by typing or copying and pasting the URL into your web browser. I agree to the HarperDB Terms and Conditions: (yes/no) yes -Please enter a destination for HarperDB: $HOME/hdb +Please enter a destination for HarperDB: $HOME/harper Please enter a username for the administrative user: HDB_ADMIN Please enter a password for the administrative user: [hidden] Default Config - dev (easy access/debugging) or prod (security/performance): (dev/prod) dev @@ -73,7 +73,7 @@ HarperDB installation was successful. -Harper is readily available as a Docker image [`harperdb/harperdb`](https://hub.docker.com/r/harperdb/harperdb). +Harper is readily available as a Docker image [`harperfast/harper`](https://hub.docker.com/r/harper/harper). The image is based off of a Node.js image and the default tag is always published using the latest Harper version and latest Node.js Active LTS version. @@ -82,19 +82,19 @@ The image uses sensible default environment variables, agreeing to the terms and Using a Docker compatible container manager of choice, the simplest way to get started is using: ```bash -docker pull harperdb/harperdb +docker pull harperfast/harper docker run -it \ --name harper \ - -v $HOME/hdb:/home/harperdb/hdb \ - -v $HOME/dev:/home/harperdb/dev \ + -v $HOME/harper:/home/harper/harper \ + -v $HOME/dev:/home/harper/dev \ -e DEFAULTS_MODE=dev \ -e REPLICATION_HOSTNAME=localhost \ -p 9925:9925 \ -p 9926:9926 \ - harperdb/harperdb + harperfast/harper ``` -The `-v` options will mount the Harper installation (`hdb/`) as well as a development directory (`dev/`) to the container host which is useful for development purposes. The `hdb/` path will contain the Harper installation parts, and the `dev/` directory can be used to create projects (which future guides will require). +The `-v` options will mount the Harper installation (`harper/`) as well as a development directory (`dev/`) to the container host which is useful for development purposes. The `harper/` path will contain the Harper installation parts, and the `dev/` directory can be used to create projects (which future guides will require). The additional environment variables specified by `-e` options ensures the installation is setup for local development. @@ -140,21 +140,21 @@ Starting HarperDB... Debugger listening on ws://127.0.0.1:9229/ For help, see: https://nodejs.org/en/docs/inspector [main/0] [info]: All root applications loaded -[http/1] [info]: Domain socket listening on /hdb/operations-server +[http/1] [info]: Domain socket listening on /harper/operations-server HarperDB 4.y.z successfully started [main/0] [notify]: HarperDB successfully started. Hostname: localhost Worker Threads: 1 -Root Path: /hdb +Root Path: /harper Debugging: enabled: true -Logging: level: info, location: /hdb/log/hdb.log, stdout/err +Logging: level: info, location: /harper/log/hdb.log, stdout/err Default: HTTP (and WS): 9926, CORS: enabled for * -Operations API: HTTP: 9925, CORS: enabled for *, unix socket: /hdb/operations-server +Operations API: HTTP: 9925, CORS: enabled for *, unix socket: /hdharperb/operations-server MQTT: TCP: 1883, TLS: 8883, WS: 9926 Replication: WS: 9925, WSS: 9933 -Note that log messages are being sent to the console (stdout and stderr) in addition to the log file /hdb/log/hdb.log. This can be disabled by setting logging.stdStreams to false, and the log file can be directly monitored/tailed. +Note that log messages are being sent to the console (stdout and stderr) in addition to the log file /harper/log/hdb.log. This can be disabled by setting logging.stdStreams to false, and the log file can be directly monitored/tailed. This server does not have valid usage licenses, this should only be used for educational and development purposes. ``` From 28724118d374854558b4a1f0d469bdfad1933e32 Mon Sep 17 00:00:00 2001 From: Kris Zyp Date: Wed, 22 Apr 2026 10:53:03 -0600 Subject: [PATCH 2/4] Mention harper-pro as well --- learn/getting-started/install-and-connect-harper.mdx | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/learn/getting-started/install-and-connect-harper.mdx b/learn/getting-started/install-and-connect-harper.mdx index fb6c5489..b15efb37 100644 --- a/learn/getting-started/install-and-connect-harper.mdx +++ b/learn/getting-started/install-and-connect-harper.mdx @@ -47,6 +47,13 @@ Then, execute the Harper CLI: harper ``` +Harper also has a "pro" version, which includes full enterprise scale capabilities, such as replication, certificate management, and more advanced analytics. This is also the version running on Fabric. However, this is licensed with Elastic 2.0, and you need a usage license through Harper if you want to use this for a managed service. The oper and pro versions offer the same APIs for development, so the pro version is not necessary to start building applications. If you do want to install, it is available with at `@harperfast/harper-pro`: + +```bash +npm install -g @harperfast/harper-pro +``` +(Harper pro can be started with the `harper` command as well). + When installing locally on your machine, you can specify any destination for Harper, we recommend using something within your home directory such as `$HOME/harper`. Keep note of what you specify for the username and password. Make sure you select the `dev` default config and set the hostname to `localhost`. :::important From 6fbf47f22e2865577f3806b7e31fc7b33c37845e Mon Sep 17 00:00:00 2001 From: Kris Zyp Date: Wed, 22 Apr 2026 13:04:53 -0600 Subject: [PATCH 3/4] Fix typo --- learn/getting-started/install-and-connect-harper.mdx | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/learn/getting-started/install-and-connect-harper.mdx b/learn/getting-started/install-and-connect-harper.mdx index b15efb37..21e21a2e 100644 --- a/learn/getting-started/install-and-connect-harper.mdx +++ b/learn/getting-started/install-and-connect-harper.mdx @@ -52,6 +52,7 @@ Harper also has a "pro" version, which includes full enterprise scale capabiliti ```bash npm install -g @harperfast/harper-pro ``` + (Harper pro can be started with the `harper` command as well). When installing locally on your machine, you can specify any destination for Harper, we recommend using something within your home directory such as `$HOME/harper`. Keep note of what you specify for the username and password. Make sure you select the `dev` default config and set the hostname to `localhost`. @@ -157,7 +158,7 @@ Root Path: /harper Debugging: enabled: true Logging: level: info, location: /harper/log/hdb.log, stdout/err Default: HTTP (and WS): 9926, CORS: enabled for * -Operations API: HTTP: 9925, CORS: enabled for *, unix socket: /hdharperb/operations-server +Operations API: HTTP: 9925, CORS: enabled for *, unix socket: /harper/operations-server MQTT: TCP: 1883, TLS: 8883, WS: 9926 Replication: WS: 9925, WSS: 9933 From c5aff9d9cf1125322a14b6b15d7e87f804a53794 Mon Sep 17 00:00:00 2001 From: Kris Zyp Date: Wed, 22 Apr 2026 13:57:26 -0600 Subject: [PATCH 4/4] Apply suggestion from @cb1kenobi Co-authored-by: Chris Barber --- learn/getting-started/install-and-connect-harper.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/learn/getting-started/install-and-connect-harper.mdx b/learn/getting-started/install-and-connect-harper.mdx index 21e21a2e..befe44ed 100644 --- a/learn/getting-started/install-and-connect-harper.mdx +++ b/learn/getting-started/install-and-connect-harper.mdx @@ -55,7 +55,7 @@ npm install -g @harperfast/harper-pro (Harper pro can be started with the `harper` command as well). -When installing locally on your machine, you can specify any destination for Harper, we recommend using something within your home directory such as `$HOME/harper`. Keep note of what you specify for the username and password. Make sure you select the `dev` default config and set the hostname to `localhost`. +When installing locally on your machine, you can specify any destination for Harper. We recommend using something within your home directory such as `$HOME/harper`. Keep note of what you specify for the username and password. Make sure you select the `dev` default config and set the hostname to `localhost`. :::important Do not actually enter `$HOME` in the destination prompt; it should automatically fill in the value of your home directory. Otherwise, specify the absolute path for the Harper installation.