Folderr Admininistration w/FoldCLI beta

This assumes you have already followed the getting started for Folderr CLI

This page is for setting up, installing, and updating Folderr through the CLI.

Table of Contents

• Table of Contents
• Requirements
• Pre-install setup (Linux Only)
• Initalize Folderr & Databases
  • Init Folderr
  • Init Database
• Install Folderr
• Setup the Owner Account & Folderrs Database
  • Setup Owner
  • Setup Database
• Building Folderr
• Deployment

Requirements

• Git
• NodeJS version 16 or higher with crypto support
• TypeScript
• Node-gyp used to build dependencies
• MongoDB Server Community or Enterprise or Atlas

Linux Info

Node-Gyp is included in most linux node installers. But node is typically old.

Pre-install setup (Linux Only)

TIP

This guide was done with Rocky Linux/RHEL. If you are using a different OS we recommend knowing how to convert the commands to your OS

Linux Administrator Specific Setup

Prepare a user and add yourself to it

# create a system account named "folderr"
sudo useradd -r folderr
# add yourself to the user group
sudo usermod -aG folderr $USER
# You can drop yourself from the group once you're done setting up Folderr

NOTICE

LOGOUT AND LOGIN AGAIN

We use /etc/folderr throughout the documentation to reference its installation directory You can install Folderr anywhere. For normal user installation we use /home/folderr/folderr as an example

Initalize Folderr & Databases

Init Folderr

Initalizing Folderr can be done with the foldcli init folderr command found at commands/setup

Examples:

Linux, Admin

foldcli init folderr /etc/folderr <repository>

Linux, User

foldcli init folderr /home/folderr/folderr <repository>

Init Database

Database initializing is similar, with foldcli init db (found at commands/setup)

Ex:

foldcli init db mongodb://localhost/folderrV2 folderrV2

Install Folderr

Installing Folderr with the cli is as easy as

foldcli install folderr

Setup the Owner Account & Folderrs Database

Setup Owner

To setup the owner account you can use the foldcli setup owner command found at commands/setup applications and services

Example: foldcli setup owner --email folderr@example.com --username folderr --password IFailThePasswordCheck

Setup Database

Setting up the owner is very similar, just use foldcli setup db (found at commands/setup applications and services)

Just run

foldcli setup db

...and it's done, your keys will be automatically installed to Folderr if

• You installed Folderr
• The install location is the same as what you set up with foldcli init folderr

Building Folderr

To build Folderr do

Linux, Admin

cd /etc/folderr
npm run build:production

Linux, User

cd /home/folderr/folderr
npm run build:production

Deployment

Starting & Deploying Folderr can be done by following the deployment guide for Folderr