Getting Started beta

Table of Contents

• Requirements
• Installation
• Pre-Install Setup (Linux)
• Configuration
• Setup
• Starting

Requirements

• Git
• NodeJS version 16 or higher with crypto support
• TypeScript or;
• SWC CLI
• 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

Installation

WARNING

Folderr holds sensitive data. Other users should not be able to access Folderr.

That's why we chmod 770 the folderr directory

Linux, Admin

cd /etc
sudo git clone https://github.com/Folderr/Folderr folderr
sudo chown folderr:folderr folderr
sudo chmod 770 folderr
cd folderr
npm install

Linux, User

git clone https://github.com/Folderr/Folderr folderr
chmod 770 folderr
cd folderr
npm install

Configuration

Once Folderr has finished installing continue on to the configuration guide here

Setup

This initially sets folderr up for your owner account and configures encryption keys.

We recommend trying SWC before TypeScript

SWC

cd folderr
npm run build
npm run setup

TypeScript

cd folderr
npm run build:tsc
npm run setup

Starting/Deploying

This has been moved to Deployment