Set up a local dev environment
Note: during the private beta, it is not possible to run CipherStash locally. You can connect to the hosted version instead

Install Dependencies

To use the CipherStash client you will need Node.js version 14.x.x or higher and you must be running macOS or Linux. Windows is not officially supported at this time, but you may have some success with WSL2.
To build the client, you will also need:
    OpenSSL
    gmp
    A C compiler and build tools

Installing Deps on MacOS

Installing the dependencies can be done using Homebrew:
1
brew install openssl gmp
Copied!
You will also need the Xcode command line tools which you can usually install via:
1
xcode-select --install
Copied!

Install Dependencies on Linux

Specific steps will depend on your distribution:
On Fedora/Centos/Redhat:
1
sudo dnf install openssl-devel gmp-devel make automake gcc
2
3
# Or on older versions still using yum
4
sudo yum install openssl-devel gmp-devel make automake gcc
Copied!
On Debian/Ubuntu:
1
sudo apt-get install build-essential libgmp-dev openssl-dev
Copied!

Install CipherStash Client

To install the client, either add to your project's package.json file directly, or run:
1
npm install @cipherstash/stashjs --save
Copied!
Please ensure you are running at least version 0.2.12 of @cipherstash/stashjs.
Last modified 3mo ago