diff --git a/docs/install-harperdb/index.md b/docs/install-harperdb/index.md index 1c8841fc..84de45de 100644 --- a/docs/install-harperdb/index.md +++ b/docs/install-harperdb/index.md @@ -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) \ No newline at end of file diff --git a/docs/install-harperdb/mac.md b/docs/install-harperdb/mac.md new file mode 100644 index 00000000..e4f97bea --- /dev/null +++ b/docs/install-harperdb/mac.md @@ -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. + +or from the command line: +```bash +npm install -g harperdb +harperdb +``` diff --git a/docs/install-harperdb/node-ver-requirement.md b/docs/install-harperdb/node-ver-requirement.md new file mode 100644 index 00000000..ae4e6e0b --- /dev/null +++ b/docs/install-harperdb/node-ver-requirement.md @@ -0,0 +1,7 @@ +# Node Version Requirement + +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. \ No newline at end of file diff --git a/docs/install-harperdb/offline.md b/docs/install-harperdb/offline.md new file mode 100644 index 00000000..b1ff72de --- /dev/null +++ b/docs/install-harperdb/offline.md @@ -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): + +Download Install Package + + +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. \ No newline at end of file diff --git a/docs/install-harperdb/other.md b/docs/install-harperdb/other.md new file mode 100644 index 00000000..9fc7a500 --- /dev/null +++ b/docs/install-harperdb/other.md @@ -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 + diff --git a/docs/install-harperdb/windows.md b/docs/install-harperdb/windows.md new file mode 100644 index 00000000..d9713b1e --- /dev/null +++ b/docs/install-harperdb/windows.md @@ -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/). diff --git a/images/xcode.png b/images/xcode.png new file mode 100644 index 00000000..eaaa3526 Binary files /dev/null and b/images/xcode.png differ