README
Server
Table of Contents
About
CoBox is an encrypted p2p file system and distributed back-up tool. README provides a map of the project.
server is a core component of the CoBox App. It exposes a VueJS UI, an ExpressJS JSON API, and a Yargs CLI for interacting with CoBox 'spaces', 'backups' and 'seeders'. Check out our docs for more details on what a space is, how backups work and... what's a 'seeder'?
Installing and Updating
Install and Update Script
To install or update cobox-server, you should run the install script. To do that, you may either download and run the script manually, or use the following cURL or Wget command:
curl -o- https://cobox.cloud/releases/cobox-v1.0.0-alpha.1/download.sh | bash
wget -qO- https://cobox.cloud/releases/cobox-1.0.0-alpha.1/download.sh | bash
Running either of the above commands downloads a script and runs it. The script downloads a tarball that contains the release binary required by your operating system with additional assets and unpacks the contents to the install directory.
Troubleshooting on Linux
On Linux, after running the install script, if you get cobox: command not found or see no feedback from your terminal after you type command -v cobox, simply close your current terminal, open a new terminal, and try verifying again.
Verify Installation
To verify that CoBox has been installed correctly, do:
command -v cobox
We strongly recommend you produce a checksum of your download to ensure that our code hasn't been tampered with.
sha256sum ~/.cobox/releases/latest/cobox
This will vary depending on the version you have downloaded.
cobox --version
You can view a list of published versions and their checksums on our website.
NPM Install
npm install -g @coboxcoop/server
cobox
Git Install
Before you get started, ensure you have git and node installed. We currently release using v12.16.3 which we recommend using. You can download and install nodejs from your distribution package manager, or direct from their website.
# clone the repository
git clone http://gitlab.com/coboxcoop/cobox-server && cd cobox-server
npm install -g yarn
# install dependencies
yarn
# start the app
yarn start
# use the cli
node bin
Usage
CoBox Server is accessible through a UI in the browser, and through a CLI in the terminal.
CoBox 1.0 - an encrypted peer-to-peer file system and distributed back-up tool
Copyright (C) 2019 Magma Collective T&DT, License GNU AGPL v3+
This is free software: you are free to change and redistribute it
For the latest sourcecode go to <https://code.cobox.cloud/>
Usage: cobox <command> [options]
Commands:
cobox start [options] start the app
cobox whoami display your nickname and public key
cobox nickname <name> change your nickname
cobox spaces <command> view and interact with your spaces
cobox seeders <command> register, pair with and send commands to your seeder(s)
cobox backups <command> back-up your peers' spaces locally
cobox export [options] export your keys
cobox import [options] import your keys
cobox setup <command> setup options and settings
cobox down [options] stop the app
Options:
-h, --help, --help Show help [boolean]
-v, --version, --version Show version number [boolean]
For more information on cobox read the manual: man cobox
Please report bugs on <http://gitlab.com/coboxcoop/core/issues>.
API
See swagger documentation... (we won't have this for a while).
Contributing
PRs accepted.
Small note: If editing the README, please conform to the standard-readme specification.