zax-dashboard v1.0.7

Zax Dashboard

Zax Dashboard is a simple single page web app powered by Angular, introducing typical interactions with Zax Relay, a NaCl-based Cryptographic Relay. Zax Dashboard uses the Glow.ts library to provide a user-friendly access point to encrypted Mailboxes on a given relay. You can read the full technical specification here.

Demo

We maintain a live Test Server that runs the stable build of Zax Dashboard. For testing purposes expiration of any communication on that relay is set to 30 minutes.

You can also check the latest build of main branch on Github Pages.

Features

• Create mailboxes
• Send and receive end-to-end encrypted messages between mailboxes
• Send and receive encrypted files via Zax 2.0 File Commands
• Switch Zax relays on the fly

Getting started

Node.js

In order to build and use Zax Dashboard from source, you need to have a relatively recent version of Node.js installed.

Installation

Zax Dashboard can be easily installed via npm, which is included when you install Node.js. In a terminal, navigate to the directory in which you'd like to install Glow and type the following:

npm install zax-dashboard

Development

In a terminal, navigate to the directory in which you'd like to install Zax Dashboard and type the following:

# get the source
git clone git@github.com:vault12/zax-dashboard.git

# install dependencies
cd zax-dashboard
npm install

# run the dev server
npm run start

Then navigate to http://localhost:4200 in your browser. The app will automatically reload if you change any of the source files.

Configuration

To change the default relay, modify private setDefaultRelay() method of app.component.ts. By default, it uses the same domain where Zax Dashboard is running, but falls back to our test server when run on localhost or Github Pages.

Build

Run npm run dist to build the project. The build artifacts will be stored in the dist/ directory. The docs/ directory which serves as a root for Github Pages can be built with npm run github-pages.

Ecosystem

License

Zax Dashboard is released under the MIT License.

Legal Reminder

Exporting/importing and/or use of strong cryptography software, providing cryptography hooks, or even just communicating technical details about cryptography software is illegal in some parts of the world. If you import this software to your country, re-distribute it from there or even just email technical suggestions or provide source patches to the authors or other people you are strongly advised to pay close attention to any laws or regulations which apply to you. The authors of this software are not liable for any violations you make - it is your responsibility to be aware of and comply with any laws or regulations which apply to you.