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
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions docs/install-harperdb/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ This section contains technical details and reference materials for installing H

* [Linux](linux.md)
* [Docker](docker.md)
* Mac
* Windows (WSL2)
* Offline
* [Mac](mac.md)
* [Windows](windows.md)
* [Offline](offline.md)
* [Other](other.md)
17 changes: 17 additions & 0 deletions docs/install-harperdb/mac.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Mac Development Requirements

MacOS is not recommended as a production operating system, but it is great for development. For more information on standard HarperDB installation visit the HarperDB Command Line Interface guide. This page details the unique cases you may run into when installing on Mac.



Please note, HarperDB suggests Node.js v18.12.0 as a prerequisite to installation, but we allow Node.js versions 14.0.0 & higher. [Learn more here](https://harperdb.io/docs/install-harperdb/node-version/).

---

To install HarperDB please visit the npm install guide: https://www.npmjs.com/package/harperdb.
Comment thread
terraHDB marked this conversation as resolved.

or from the command line:
```bash
npm install -g harperdb
harperdb
```
7 changes: 7 additions & 0 deletions docs/install-harperdb/node-ver-requirement.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Node Version Requirement
Comment thread
kriszyp marked this conversation as resolved.

HarperDB installations suggest Node.js v18.12.0, but we allow Node.js versions 14.0.0 & higher, in order to be installed. We recommend using Node Version Manager (nvm) to manage your Node.js installations, an example of how to install HarperDB using nvm can be found on our Linux Install doc.



HarperDB 4.0.0, our current release, suggests Node.js v18.12.0.
14 changes: 14 additions & 0 deletions docs/install-harperdb/offline.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Offline Install

If you need to install HarperDB on a device that doesn't have an Internet connection, you can download the npm package and install it directly (you’ll still need Node.js and NPM):

<a href="https://registry.npmjs.org/harperdb/-/harperdb-3.3.0.tgz" style = "background:#403b8a !important; color: white !important; border:none; outline:none; width:100%; cursor:pointer; margin-top: 1.5rem !important; margin-bottom: 3rem !important; bs-btn-padding-x: .75rem; --bs-btn-padding-y: .375rem; --bs-btn-font-family: ; --bs-btn-font-size: 1rem; --bs-btn-font-weight: 400; --bs-btn-line-height: 1.5; --bs-btn-color: #212529; --bs-btn-bg: transparent; --bs-btn-border-width: 1px; --bs-btn-border-color: transparent; --bs-btn-border-radius: .375rem; --bs-btn-hover-border-color: transparent; --bs-btn-box-shadow: inset 0 1px 0 rgba(255,255,255,.15),0 1px 1px rgba(0,0,0,.075); --bs-btn-disabled-opacity: .65; --bs-btn-focus-box-shadow: 0 0 0 .25rem rgba(var(--bs-btn-focus-shadow-rgb),.5); display: inline-block; padding: var(--bs-btn-padding-y) var(--bs-btn-padding-x); font-family: var(--bs-btn-font-family); font-size: var(--bs-btn-font-size); font-weight: var(--bs-btn-font-weight); line-height: var(--bs-btn-line-height); color: var(--bs-btn-color); text-align: center; text-decoration: none; vertical-align: middle; user-select: none; border: var(--bs-btn-border-width) solid var(--bs-btn-border-color); border-radius: var(--bs-btn-border-radius); background-color: var(--bs-btn-bg); transition: color .15s ease-in-out,background-color .15s ease-in-out,border-color .15s ease-in-out,box-shadow .15s ease-in-out; -webkit-appearance: button; text-transform: none;">Download Install Package</a>


Once you’ve downloaded the .tgz file, run the following command from the directory where you’ve placed it:

```bash
npm install -g harperdb-X.X.X.tgz harperdb install
```

For more information visit the [HarperDB Command Line Interface](https://harperdb.io/docs/administration/harperdb-cli/) guide.
9 changes: 9 additions & 0 deletions docs/install-harperdb/other.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Other Install Information


If you are installing on a platform other than linux-amd64, linux-arm64, darwin-amd64, darwin-arm64, windows-amd64, you will need to ensure that you have installed:
* [Go](https://go.dev/dl/): version 1.19.1
* GCC
* Make
* Python v3.7, v3.8, v3.9, or v3.10

13 changes: 13 additions & 0 deletions docs/install-harperdb/windows.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Install HarperDB on Windows

Running HarperDB on Windows 10 or 11 is a great way to test and develop with HarperDB. We do not, though, recommend HarperDB on Windows for production workloads.

---

Install HarperDB on Windows

```bash
npm install -g harperdb
harperdb
````
HarperDB will automatically start after installation. For more information visit the [HarperDB Command Line Interface guide](https://harperdb.io/docs/administration/harperdb-cli/).
Binary file added images/xcode.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.