Skip to content
This repository has been archived by the owner on Jun 16, 2021. It is now read-only.

Latest commit

 

History

History
57 lines (40 loc) · 3.13 KB

README.md

File metadata and controls

57 lines (40 loc) · 3.13 KB

This repository is discontinued: See https://github.com/vault12/zax-dashboard for the new reference dashboard implementation.

Zax-Dash

Zax-Dash is a simple AngularJS single page app to interact with Zax Relay, a NaCl-based Cryptographic Relay. Zax-Dash uses the Glow library to provide a user-friendly access point to given relay internal mailboxes. We maintain a live Test Server that runs our latest build. For testing purposes expiration of any communication on that relay is set for 30 minutes. You can read the full technical specification here.

Dashboard

The default Zax-Dash deployment is included in the Zax repository and can be accessed via /public. You do not need to clone this repository to have the dashboard functionality included on your Zax server.

Getting Started

NodeJS

In order to build and use Zax-Dash from source, you need to have a relatively recent version of nodeJS installed.

Installation

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

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

# install dependencies
cd zax-dash
npm install

# run the build script
node_modules/gulp/bin/gulp.js build

Running Zax

To connect to your relay, first make sure that it is running on localhost:8080 via rails s -p 8080.

Alternatively, you can modify the relayUrl method in crypto.service.coffee to use an alternate relay or to use Zax-dash in standalone mode.

To run Zax-Dash locally (outside of a Zax instance) run this command:

node_modules/gulp/bin/gulp.js watch

​ Note that if you have Gulp installed globally, you can also simply type: ​

gulp watch

Contributing

We encourage you to contribute to Zax-Dash using pull requests! Please check out the Contributing to Zax Guide for guidelines about how to proceed.

Slack Community Slack Status

We've set up a public slack community Vault12 Dwellers. Request an invite by clicking here.

License

Zax-Dash 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.