Skip to content

GETTING-STARTED.md

Latest commit

 

History

History
108 lines (76 loc) · 3.48 KB

GETTING-STARTED.md

File metadata and controls

108 lines (76 loc) · 3.48 KB
Raw

KRONOS GETTING STARTED

KRONOS INFORMATION

Kronos creates a /data and a /kronosleveldb folder for storing your data and local databases. Kronos data is encrypted using a randomly generated secret key upon the first launch of Kronos.

Kronos Data Directory for Linux/macOS ~/Kronos/DATA or Windows C:/Users/<user>/AppData/Roaming/Kronos/DATA

If you wish to start fresh with Kronos and get back to the selection screen, delete the /data and /kronosleveldb folders after shutting down Kronos. Kronos logs are stored in the Kronos Data Directory ~/Kronos/DATA/kronos.log or C:/Users/<user>/AppData/Roaming/Kronos/DATA/kronos.log

Helpful Commands

nohup npm run headless & To run Kronos in a headless mode on your LAN (typically ran from Raspberry Pi) (Outputs log to nohup.out) node -r esm ./bin/kronos Alternative command to the npm run headless command, no log output npm run kronos To run Kronos in app mode with Electron, also outputs LAN server (can be ran from OS of choice with GUI)

KRONOS BASH INSTALLER SCRIPT

Simply run the single command below in your Terminal or via SSH, then choose one of the options if you want to Install Kronos with or without Denarius chaindata or if you want to just update!:

wget -qO- https://raw.githubusercontent.com/metaspartan/kronos/master/installkronos.sh | bash

or

curl -o- https://raw.githubusercontent.com/metaspartan/kronos/master/installkronos.sh | bash

You can choose an option 1-3 from the installer script above to either install Kronos, install Kronos with Denarius chaindata, or Update Kronos!

RUN KRONOS HEADLESS MODE (Raspberry Pi, etc.):

Install NodeJS v12.x via NodeSource or Installer from https://nodejs.org

# Using Ubuntu
sudo apt install -y curl
curl -sL https://deb.nodesource.com/setup_12.x | sudo -E bash -
sudo apt-get install -y nodejs

# Using Debian, as root
apt install -y curl
curl -sL https://deb.nodesource.com/setup_12.x | bash -
apt-get install -y nodejs

Run sudo apt-get install -y nodejs to install Node.js 12.x and npm

You may also need development tools to build native addons: sudo apt-get install gcc g++ make

To install the Yarn package manager, run:

     curl -sL https://dl.yarnpkg.com/debian/pubkey.gpg | sudo apt-key add -
     echo "deb https://dl.yarnpkg.com/debian/ stable main" | sudo tee /etc/apt/sources.list.d/yarn.list
     sudo apt-get update && sudo apt-get install yarn

Install and Run Kronos

sudo apt install build-essential gcc g++ make

sudo mkdir -p ~/Kronos/DATA/storage

sudo mkdir -p ~/Kronos/DATA/kronosleveldb

git clone https://github.com/metaspartan/kronos.git

cd kronos

sudo su

npm install -g electron electron-forge electron-rebuild node-gyp

npm install

nohup npm run headless &

RUNNING THE KRONOS ELECTRON APP (Windows, macOS, etc.):

Install NodeJS v16.9.1 via NVM or Installer from https://nodejs.org

git clone https://github.com/metaspartan/kronos.git

cd kronos

npm install -g electron electron-forge electron-rebuild electron-builder node-gyp windows-build-tools

npm install

npm run kronos

BUILDING THE KRONOS ELECTRON APP (If you want to build your own binaries):

Install NodeJS v16.9.1 via NVM or Installer from https://nodejs.org

git clone https://github.com/metaspartan/kronos.git

cd kronos

npm install -g electron electron-forge electron-rebuild electron-builder node-gyp windows-build-tools

npm install

npm run buildwin