Getting Started

Installation

Zbox supports a variety of programming languages, choose your favourite and follow the steps below to install Zbox.

Browser

Simply download and include with a script tag. Zbox class will be globally available.

  1. Download zbox-browser-0.3.0.tar.gz from the latest release

  2. Extract and copy the whole zbox-browser-0.3.0 folder to your website's static or public folder, and change its name to zbox-browser

  3. Import using <script> tag. For example,

<script src="/zbox-browser/index.js" async defer></script>

Same origin

Because of same-origin policy restriction, use this package as a cross-origin script, such as CDN, won't work.

Node.js

Install Zbox via npm:

npm install @zbox/nodejs

This will automatically install platform-specific library, which currently supports Linux, Windows and macOS. If your platform is not supported, please raise an issue.

Rust

Install Zbox via Cargo by adding the following dependency to your project Cargo.toml:

[dependencies]
zbox = { version = "0.8.3", features = ["storage-zbox-native"] }

Zbox depends on libsodium. If you don't want to install it by yourself, simply specify libsodium-bundled feature in the dependency, which will automatically download, verify and build libsodium.

[dependencies]
zbox = { version = "0.8.3", features = ["storage-zbox-native", "libsodium-bundled"] }

Create a Repo

Before start using Zbox, you need to create a repo on zbox.io. Alternatively, you can create a test repo on zbox.io/try without sign up, it will be valid to use for 48 hours.

After repo is created, you will get an URI which is an unique URL-like identifier of a repo. For example,

zbox://d9Ysc4PJa5sT7NKJyxDjMpZg@jRpbY2DEra6qMR

Here d9Ysc4PJa5sT7NKJyxDjMpZg is the access key and jRpbY2DEra6qMR is the repo ID.

Keep access key safe

The access key cannot decrypt your repo, it is only used for API access authtication. But anyone who obtained the access key can potentially delete repo, so you still need to keep it safe.

Start Using Zbox

Using Zbox is simple and straightforward. First make sure you have read through installation guides above, and created a repo on zbox.io.

Now let's create our first app.

Browser

  1. First, create an empty Express project zbox-app:

    mkdir zbox-app
    cd zbox-app
    npm init -y
    npm install express --save
    
  2. Then create a app.js file in zbox-app folder:

    const express = require('express');
    const app = express();
    const port = 3333;
    
    app.use(express.static(__dirname + '/'));
    app.listen(port, () => console.log(`My Zbox app listening on port ${port}!`));
    
  3. Download zbox-browser-0.3.0.tar.gz from GitHub, extract it to zbox-app folder and rename to zbox-browser.

  4. Create a HTML file index.html in the same folder, replace [your_repo_uri] with your repo's URI.

    <html>
      <head>
        <title>My First Zbox App</title>
        <meta charset="utf-8"/>
        <script src="zbox-browser/index.js"></script>
        <script>
          (async () => {
            // create a Zbox instance
            const zbox = new Zbox();
    
            // initialise Zbox environment and enable debug logs
            await zbox.initEnv({ log: { level: 'debug' } });
    
            // open the repo
            var repo = await zbox.openRepo({
              uri: '[your_repo_uri]',
              pwd: 'secret password',
              opts: { create: true }
            });
    
            // close repo and exit Zbox
            await repo.close();
            await zbox.exit();
          })();
        </script>
      </head>
      <body>
        <h1>Welcome to Zbox!</h1>
        <p>Open "Developer Tools" to watch the logs.</p>
      </body>
    </html>
    
  5. Save all the files and start the web server:

    node app.js
    
  6. Open http://localhost:3333/ in browser, remember to open developer tools to watch the logs.

    If you can see logs like below, you're all done.

    ZboxFS 0.8.3 - Zero-details, privacy-focused in-app file system
    ...[logs omitted]
    ZboxFS exited
    

That's it, now you have a private Zbox file system running in browser!

Node.js

  1. First, create an empty project zbox-app and install Zbox package:

    mkdir zbox-app
    cd zbox-app
    npm init -y
    npm install @zbox/nodejs --save
    
  2. Create zbox-test.js file in zbox-app folder, replace [your_repo_uri] with your repo's URI.

    // zbox-test.js
    const Zbox = require('@zbox/nodejs');
    
    (async () => {
      // create a Zbox instance
      const zbox = new Zbox();
    
      // initialise Zbox environment and turn on debug logs
      await zbox.initEnv({ log: { level: 'debug' } });
    
      // open the repo
      var repo = await zbox.openRepo({
        uri: '[your_repo_uri]',
        pwd: 'secret password',
        opts: { create: true }
      });
    
      // close repo and exit Zbox
      await repo.close();
      await zbox.exit();
    })();
    
  3. Now run the zbox-test.js file:

    node zbox-test.js
    

That's it, now you have a private Zbox file system running in Node.js!

Rust

  1. Create an empty Rust project zbox-app:

    cargo new --bin zbox-app
    cd zbox-app
    
  2. Add Zbox as dependency in Cargo.toml:

    [dependencies]
    zbox = { version = "0.8.3", features = ["storage-zbox-native", "libsodium-bundled"] }
    
  3. Write src/main.rs with code below and replace [your_repo_uri] with your repo's URI.

    extern crate zbox;
    
    use zbox::{init_env, RepoOpener};
    
    fn main() {
        // initialise zbox environment, called first
        init_env();
    
        // create and open a repository
        let mut _repo = RepoOpener::new()
            .create(true)
            .open("[your_repo_uri]", "your password")
            .unwrap();
    }
    
  4. Enable debug logs and run the app:

    export RUST_LOG=zbox=debug
    cargo run
    

That's it, now you have a private Zbox file system running in Rust!

What's Next

Next, you can check out more examples on the tutorials or look up in API reference.

If you have any issues, please raise it on our GitHub repos: