Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
5 changes: 2 additions & 3 deletions .github/workflows/deploy.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@ on:
push:
branches:
- main
- docs-in-hdb
# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:

Expand Down Expand Up @@ -83,8 +82,8 @@ jobs:
needs: build
name: Deploy to GitHub Pages
runs-on: ubuntu-latest
# Only deploy on push to specific branches, not on PRs
if: github.event_name == 'push' && (github.ref == 'refs/heads/main' || github.ref == 'refs/heads/docs-in-hdb')
# Only deploy on push to main or manual trigger, not on PRs
if: (github.event_name == 'push' && github.ref == 'refs/heads/main') || github.event_name == 'workflow_dispatch'

permissions:
pages: write
Expand Down
2 changes: 1 addition & 1 deletion docs/administration/administration.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Harper provides robust capabilities for analytics and observability to facilitat
- Analytics provides statistics on usage, request counts, load, memory usage with historical tracking. The analytics data can be [accessed through querying](../technical-details/reference/analytics).
- A large variety of real-time statistics about load, system information, database metrics, thread usage can be retrieved through the [`system_information` API](../developers/operations-api/system-operations).
- Information about the current cluster configuration and status can be found in the [cluster APIs](../developers/operations-api/clustering).
- Analytics and system information can easily be exported to Prometheus with our [Prometheus exporter component](https:/github.com/HarperDB-Add-Ons/prometheus_exporter), making it easy visualize and monitor Harper with Graphana.
- Analytics and system information can easily be exported to Prometheus with our [Prometheus exporter component](https://github.com/HarperDB-Add-Ons/prometheus_exporter), making it easy visualize and monitor Harper with Graphana.

### Replication Transaction Logging

Expand Down
6 changes: 3 additions & 3 deletions docs/administration/cloning.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ To start clone run `harperdb` in the CLI with either of the following variables
For example:

```
HDB_LEADER_URL=https:/node-1.my-domain.com:9925 REPLICATION_HOSTNAME=node-1.my-domain.com HDB_LEADER_USERNAME=... HDB_LEADER_PASSWORD=... harperdb
HDB_LEADER_URL=https://node-1.my-domain.com:9925 REPLICATION_HOSTNAME=node-1.my-domain.com HDB_LEADER_USERNAME=... HDB_LEADER_PASSWORD=... harperdb
```

#### Command line variables
Expand All @@ -39,7 +39,7 @@ HDB_LEADER_URL=https:/node-1.my-domain.com:9925 REPLICATION_HOSTNAME=node-1.my-d
For example:

```
harperdb --HDB_LEADER_URL https:/node-1.my-domain.com:9925 --REPLICATION_HOSTNAME node-1.my-domain.com --HDB_LEADER_USERNAME ... --HDB_LEADER_PASSWORD ...
harperdb --HDB_LEADER_URL https://node-1.my-domain.com:9925 --REPLICATION_HOSTNAME node-1.my-domain.com --HDB_LEADER_USERNAME ... --HDB_LEADER_PASSWORD ...
```

Each time clone is run it will set a value `cloned: true` in `harperdb-config.yaml`. This value will prevent clone from
Expand Down Expand Up @@ -143,7 +143,7 @@ docker run -d \
-v <host directory>:/home/harperdb/hdb \
-e HDB_LEADER_PASSWORD=password \
-e HDB_LEADER_USERNAME=admin \
-e HDB_LEADER_URL=https:/1.123.45.6:9925 \
-e HDB_LEADER_URL=https://1.123.45.6:9925 \
-e REPLICATION_HOSTNAME=1.123.45.6 \
-p 9925:9925 \
-p 9926:9926 \
Expand Down
4 changes: 2 additions & 2 deletions docs/administration/harper-studio/create-account.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,15 @@ title: Create a Studio Account

# Create a Studio Account

Start at the [Harper Studio sign up page](https:/studio.harperdb.io/sign-up).
Start at the [Harper Studio sign up page](https://studio.harperdb.io/sign-up).

1. Provide the following information:
- First Name
- Last Name
- Email Address
- Subdomain

_Part of the URL that will be used to identify your Harper Cloud Instances. For example, with subdomain “demo” and instance name “c1” the instance URL would be: https:/c1-demo.harperdbcloud.com._
_Part of the URL that will be used to identify your Harper Cloud Instances. For example, with subdomain “demo” and instance name “c1” the instance URL would be: [https://c1-demo.harperdbcloud.com](https://c1-demo.harperdbcloud.com)._

- Coupon Code (optional)

Expand Down
2 changes: 1 addition & 1 deletion docs/administration/harper-studio/enable-mixed-content.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@ title: Enable Mixed Content

Enabling mixed content is required in cases where you would like to connect the Harper Studio to Harper Instances via HTTP. This should not be used for production systems, but may be convenient for development and testing purposes. Doing so will allow your browser to reach HTTP traffic, which is considered insecure, through an HTTPS site like the Studio.

A comprehensive guide is provided by Adobe [here](https:/experienceleague.adobe.com/docs/target/using/experiences/vec/troubleshoot-composer/mixed-content.html).
A comprehensive guide is provided by Adobe [here](https://experienceleague.adobe.com/docs/target/using/experiences/vec/troubleshoot-composer/mixed-content.html).
4 changes: 2 additions & 2 deletions docs/administration/harper-studio/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ title: Harper Studio

Harper Studio is the web-based GUI for Harper. Studio enables you to administer, navigate, and monitor all of your Harper instances in a simple, user-friendly interface without any knowledge of the underlying Harper API. It’s free to sign up, get started today!

[Sign up for free!](https:/studio.harperdb.io/sign-up)
[Sign up for free!](https://studio.harperdb.io/sign-up)

Harper now includes a simplified local Studio that is packaged with all Harper installations and served directly from the instance. It can be enabled in the [configuration file](../../deployments/configuration#localstudio). This section is dedicated to the hosted Studio accessed at [studio.harperdb.io](https:/studio.harperdb.io).
Harper now includes a simplified local Studio that is packaged with all Harper installations and served directly from the instance. It can be enabled in the [configuration file](../../deployments/configuration#localstudio). This section is dedicated to the hosted Studio accessed at [studio.harperdb.io](https://studio.harperdb.io).

---

Expand Down
6 changes: 3 additions & 3 deletions docs/administration/harper-studio/instance-configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Harper instance configuration can be viewed and managed directly through the Har

All instance configuration is handled through the **config** page of the Harper Studio, accessed with the following instructions:

1. Navigate to the [Harper Studio Organizations](https:/studio.harperdb.io/organizations) page.
1. Navigate to the [Harper Studio Organizations](https://studio.harperdb.io/organizations) page.

1. Click the appropriate organization that the instance belongs to.

Expand Down Expand Up @@ -62,7 +62,7 @@ Note: For Harper Cloud instances, upgrading RAM may add additional CPUs to your

1. Once your instance upgrade is complete, it will appear on the instance dashboard as status OK with your newly selected instance size.

_Note, if Harper Cloud instance reprovisioning takes longer than 20 minutes, please submit a support ticket here: https:/harperdbhelp.zendesk.com/hc/en-us/requests/new._
_Note, if Harper Cloud instance reprovisioning takes longer than 20 minutes, please submit a support ticket here: [https://harperdbhelp.zendesk.com/hc/en-us/requests/new](https://harperdbhelp.zendesk.com/hc/en-us/requests/new)._

## Update Instance Storage

Expand All @@ -79,7 +79,7 @@ Note: Instance storage can only be upgraded once every 6 hours.
1. The instance will shut down and begin reprovisioning itself. The instance will not be available during this time. You will be returned to the instance dashboard and the instance status will show UPDATING INSTANCE.
1. Once your instance upgrade is complete, it will appear on the instance dashboard as status OK with your newly selected instance size.

_Note, if this process takes longer than 20 minutes, please submit a support ticket here: https:/harperdbhelp.zendesk.com/hc/en-us/requests/new._
_Note, if this process takes longer than 20 minutes, please submit a support ticket here: [https://harperdbhelp.zendesk.com/hc/en-us/requests/new](https://harperdbhelp.zendesk.com/hc/en-us/requests/new)._

## Remove Instance

Expand Down
2 changes: 1 addition & 1 deletion docs/administration/harper-studio/instance-metrics.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ title: Instance Metrics

The Harper Studio display instance status and metrics on the instance status page, which can be accessed with the following instructions:

1. Navigate to the [Harper Studio Organizations](https:/studio.harperdb.io/organizations) page.
1. Navigate to the [Harper Studio Organizations](https://studio.harperdb.io/organizations) page.
1. Click the appropriate organization that the instance belongs to.
1. Select your desired instance.
1. Click **status** in the instance control bar.
Expand Down
18 changes: 9 additions & 9 deletions docs/administration/harper-studio/instances.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,19 +14,19 @@ All interactions between the Studio and your instances take place directly from

## Organization Instance List

A summary view of all instances within an organization can be viewed by clicking on the appropriate organization from the [Harper Studio Organizations](https:/studio.harperdb.io/organizations) page. Each instance gets their own card. Harper Cloud and Enterprise instances are listed together.
A summary view of all instances within an organization can be viewed by clicking on the appropriate organization from the [Harper Studio Organizations](https://studio.harperdb.io/organizations) page. Each instance gets their own card. Harper Cloud and Enterprise instances are listed together.

## Create a New Instance

1. Navigate to the [Harper Studio Organizations](https:/studio.harperdb.io/organizations) page.
1. Navigate to the [Harper Studio Organizations](https://studio.harperdb.io/organizations) page.
1. Click the appropriate organization for the instance to be created under.
1. Click the **Create New Harper Cloud Instance + Register Enterprise Instance** card.
1. Select your desired Instance Type.
1. For a Harper Cloud Instance or a Harper 5G Wavelength Instance, click **Create Harper Cloud Instance**.
1. Fill out Instance Info.
1. Enter Instance Name

_This will be used to build your instance URL. For example, with subdomain “demo” and instance name “c1” the instance URL would be: https:/c1-demo.harperdbcloud.com. The Instance URL will be previewed below._
_This will be used to build your instance URL. For example, with subdomain “demo” and instance name “c1” the instance URL would be: [https://c1-demo.harperdbcloud.com](https://c1-demo.harperdbcloud.com). The Instance URL will be previewed below._

1. Enter Instance Username

Expand All @@ -52,13 +52,13 @@ A summary view of all instances within an organization can be viewed by clicking

1. Click **Confirm Instance Details** to move to the next page.
1. Review your Instance Details, if there is an error, use the back button to correct it.
1. Review the [Privacy Policy](https:/harperdb.io/legal/privacy-policy/) and [Terms of Service](https:/harperdb.io/legal/harperdb-cloud-terms-of-service/), if you agree, click the **I agree** radio button to confirm.
1. Review the [Privacy Policy](https://harperdb.io/legal/privacy-policy/) and [Terms of Service](https://harperdb.io/legal/harperdb-cloud-terms-of-service/), if you agree, click the **I agree** radio button to confirm.
1. Click **Add Instance**.
1. Your Harper Cloud instance will be provisioned in the background. Provisioning typically takes 5-15 minutes. You will receive an email notification when your instance is ready.

## Register Enterprise Instance

1. Navigate to the [Harper Studio Organizations](https:/studio.harperdb.io/organizations) page.
1. Navigate to the [Harper Studio Organizations](https://studio.harperdb.io/organizations) page.
1. Click the appropriate organization for the instance to be created under.
1. Click the **Create New Harper Cloud Instance + Register Enterprise Instance** card.
1. Select **Register Enterprise Instance**.
Expand Down Expand Up @@ -95,7 +95,7 @@ A summary view of all instances within an organization can be viewed by clicking

1. Click **Confirm Instance Details** to move to the next page.
1. Review your Instance Details, if there is an error, use the back button to correct it.
1. Review the [Privacy Policy](https:/harperdb.io/legal/privacy-policy/) and [Terms of Service](https:/harperdb.io/legal/harperdb-cloud-terms-of-service/), if you agree, click the **I agree** radio button to confirm.
1. Review the [Privacy Policy](https://harperdb.io/legal/privacy-policy/) and [Terms of Service](https://harperdb.io/legal/harperdb-cloud-terms-of-service/), if you agree, click the **I agree** radio button to confirm.
1. Click **Add Instance**.
1. The Harper Studio will register your instance and restart it for the registration to take effect. Your instance will be immediately available after this is complete.

Expand All @@ -108,7 +108,7 @@ Instance deletion has two different behaviors depending on the instance type.

An instance can be deleted as follows:

1. Navigate to the [Harper Studio Organizations](https:/studio.harperdb.io/organizations) page.
1. Navigate to the [Harper Studio Organizations](https://studio.harperdb.io/organizations) page.
1. Click the appropriate organization that the instance belongs to.
1. Identify the proper instance card and click the trash can icon.
1. Enter the instance name into the text box.
Expand All @@ -125,14 +125,14 @@ Harper instances can be resized on the [Instance Configuration](instance-configu

The Studio enables users to log in and out of different database users from the instance control panel. To log out of an instance:

1. Navigate to the [Harper Studio Organizations](https:/studio.harperdb.io/organizations) page.
1. Navigate to the [Harper Studio Organizations](https://studio.harperdb.io/organizations) page.
1. Click the appropriate organization that the instance belongs to.
1. Identify the proper instance card and click the lock icon.
1. You will immediately be logged out of the instance.

To log in to an instance:

1. Navigate to the [Harper Studio Organizations](https:/studio.harperdb.io/organizations) page.
1. Navigate to the [Harper Studio Organizations](https://studio.harperdb.io/organizations) page.
1. Click the appropriate organization that the instance belongs to.
1. Identify the proper instance card, it will have an unlocked icon and a status reading PLEASE LOG IN, and click the center of the card.
1. Enter the database username.
Expand Down
2 changes: 1 addition & 1 deletion docs/administration/harper-studio/login-password-reset.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ title: Login and Password Reset

To log into your existing Harper Studio account:

1. Navigate to the [Harper Studio](https:/studio.harperdb.io/).
1. Navigate to the [Harper Studio](https://studio.harperdb.io/).
1. Enter your email address.
1. Enter your password.
1. Click **sign in**.
Expand Down
8 changes: 4 additions & 4 deletions docs/administration/harper-studio/manage-applications.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,14 +35,14 @@ The Applications editor stores unsaved changes in cache. This means that occasio

Accessing your application endpoints varies with which type of endpoint you're creating. All endpoints, regardless of type, will be accessed via the [Harper HTTP port found in the Harper configuration file](../../deployments/configuration#http). The default port is `9926`, but you can verify what your instances is set to by navigating to the [instance config page](instance-configuration) and examining the read only JSON version of your instance's config file looking specifically for either the `http: port: 9926` or `http: securePort: 9926` configs. If `port` is set, you will access your endpoints via `http` and if `securePort` is set, you will access your endpoints via `https`.

Below is a breakdown of how to access each type of endpoint. In these examples, we will use a locally hosted instance with `securePort` set to `9926`: `https:/localhost:9926`.
Below is a breakdown of how to access each type of endpoint. In these examples, we will use a locally hosted instance with `securePort` set to `9926`: `https://localhost:9926`.

- **Standard REST Endpoints**\
Standard REST endpoints are defined via the `@export` directive to tables in your schema definition. You can read more about these in the [Adding an Endpoint section of the Applications documentation](../../developers/applications/#adding-an-endpoint). Here, if we are looking to access a record with ID `1` from table `Dog` on our instance, [per the REST documentation](../../developers/rest), we could send a `GET` (or since this is a GET, we could post the URL in our browser) to `https:/localhost:9926/Dog/1`.
Standard REST endpoints are defined via the `@export` directive to tables in your schema definition. You can read more about these in the [Adding an Endpoint section of the Applications documentation](../../developers/applications/#adding-an-endpoint). Here, if we are looking to access a record with ID `1` from table `Dog` on our instance, [per the REST documentation](../../developers/rest), we could send a `GET` (or since this is a GET, we could post the URL in our browser) to `https://localhost:9926/Dog/1`.
- **Augmented REST Endpoints**\
Harper Applications enable you to write [Custom Functionality with JavaScript](../../developers/applications/#custom-functionality-with-javascript) for your resources. Accessing these endpoints is identical to accessing the standard REST endpoints above, though you may have defined custom behavior in each function. Taking the example from the [Applications documentation](../../developers/applications/#custom-functionality-with-javascript), if we are looking to access the `DogWithHumanAge` example, we could send the GET to `https:/localhost:9926/DogWithHumanAge/1`.
Harper Applications enable you to write [Custom Functionality with JavaScript](../../developers/applications/#custom-functionality-with-javascript) for your resources. Accessing these endpoints is identical to accessing the standard REST endpoints above, though you may have defined custom behavior in each function. Taking the example from the [Applications documentation](../../developers/applications/#custom-functionality-with-javascript), if we are looking to access the `DogWithHumanAge` example, we could send the GET to `https://localhost:9926/DogWithHumanAge/1`.
- **Fastify Routes**\
If you need more functionality than the REST applications can provide, you can define your own custom endpoints using [Fastify Routes](../../developers/applications/#define-fastify-routes). The paths to these routes are defined via the application `config.yaml` file. You can read more about how you can customize the configuration options in the [Define Fastify Routes documentation](../../developers/applications/define-routes). By default, routes are accessed via the following pattern: `[Instance URL]:[HTTP Port]/[Project Name]/[Route URL]`. Using the example from the [Harper Application Template](https:/github.com/HarperDB/application-template/), where we've named our project `application-template`, we would access the `getAll` route at `https:/localhost/application-template/getAll`.
If you need more functionality than the REST applications can provide, you can define your own custom endpoints using [Fastify Routes](../../developers/applications/#define-fastify-routes). The paths to these routes are defined via the application `config.yaml` file. You can read more about how you can customize the configuration options in the [Define Fastify Routes documentation](../../developers/applications/define-routes). By default, routes are accessed via the following pattern: `[Instance URL]:[HTTP Port]/[Project Name]/[Route URL]`. Using the example from the [Harper Application Template](https://github.com/HarperDB/application-template/), where we've named our project `application-template`, we would access the `getAll` route at `https://localhost/application-template/getAll`.

## Creating a New Application

Expand Down
2 changes: 1 addition & 1 deletion docs/administration/harper-studio/manage-instance-users.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Harper users and roles can be managed directly through the Harper Studio. It is

Instance user configuration is handled through the **users** page of the Harper Studio, accessed with the following instructions:

1. Navigate to the [Harper Studio Organizations](https:/studio.harperdb.io/organizations) page.
1. Navigate to the [Harper Studio Organizations](https://studio.harperdb.io/organizations) page.

1. Click the appropriate organization that the instance belongs to.

Expand Down
2 changes: 1 addition & 1 deletion docs/administration/harper-studio/manage-replication.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Harper instance clustering and replication can be configured directly through th

All clustering configuration is handled through the **replication** page of the Harper Studio, accessed with the following instructions:

1. Navigate to the [Harper Studio Organizations](https:/studio.harperdb.io/organizations) page.
1. Navigate to the [Harper Studio Organizations](https://studio.harperdb.io/organizations) page.

1. Click the appropriate organization that the instance belongs to.

Expand Down
Loading