Deploy Folderr beta

Table of contents

• Assumptions
  • Install directories
• Ways to Deploy Folderr
• Extended Deployment
  • Systemd Configuration
  • Running Folderr
• Get Status of Folderr
• Logs
• Log rotation
  • Example

Assumptions

Supported operating systems for deployment: Linux We assume you are knowledgeable enough to convert commands from Rocky Linux/RHEL linux distros to your distro of choice We also assume you have already configured Folderr and set it up.

Install directories

• /etc/folderr/ - This is used for scripts for users that are sudoers/root or otherwise a superuser/admin
• /home/folderr/folderr - Used for non admins.

Regardless of whether you are installing as a system admin or a user, change the respective directory (ex /home/folderr/folderr) to your install directory.

Ways to Deploy Folderr

There are several ways to deploy Folderr

• PM2 - Our favorite, for non-Linux platforms and beginners. However it is memory intensive for small deployments.
• Systemd - Not very memory intensive, not very feature-full, limited to Linux operating systems

If you have any others you would like us to include, hit the Edit this page link at the bottom of the page.

Testing? Click me!

Permissions required: read, write, and execute for all directories and read, and write for all files

# assumption: your directory is the directory that Folderr is installed in
npm run start

Extended Deployment

Systemd Configuration

This file should be called folderr.service and be placed in your systemd directory.

Google will be your best friend for finding out where that is.

Systemd, RHEL Admin

[Unit]
Description=Folderr FOSS File Host
Documentation=https://docs.folderr.net
# Author=Folderr
After=network.target mongod.service # Remove mongod.service if you do not have mongodb install locally

[Service]
Type=simple
User=folderr
WorkingDirectory=/etc/folderr # This should ALWAYs be set to the directory you have installed Folderr at.
#Environment=DEBUG='true' # In the event you run into an issue, uncomment this line.
ExecStart=/usr/bin/node /etc/folderr/dist/src/backend/index.js
RestartSec=10
Restart=always

[Install]
WantedBy=default.target

Systemd, User

[Unit]
Description=Folderr FOSS File Host
Documentation=https://docs.folderr.net
# Author=Folderr
After=network.target mongod.service # Remove mongod.service if you do not have mongodb install locally

[Service]
Type=simple
WorkingDirectory=/home/folderr/folderr # This should ALWAYs be set to the directory you have installed Folderr at.
#Environment=DEBUG='true' # In the event you run into an issue, uncomment this line.
ExecStart=/usr/bin/node /home/folderr/folderr/dist/src/backend/index.js # You may have to change /usr/bin/node to the directory stated by `which node`
RestartSec=10
Restart=always

[Install]
WantedBy=default.target

You may remove mongod.service if you do not have MongoDB installed on the system Folderr will run on

Debugging or Submitting an issue to our github?

Please add --enable-source-maps to the ExecStart when debugging or submitting an issue on GitHub

Running Folderr

PM2

# assumption: you are in your folderr install directory
pm2 start dist/src/backend/index.js

Systemd, Admin

sudo systemctl start folderr

Systemd, User

systemctl --user start folderr
# Make Folderr stay online when you logout
loginctl enable-linger $USER

Get status of Folderr

PM2

pm2 monit # This shows logs and all that jazz, as well as node version.
# or
pm2 ls

Systemd, Admin

sudo systemctl status folderr

Systemd, User

systemctl --user status folderr

Logs

Your logs are going to be in /etc/Folderr/logs the files you're looking for are

• all.log - As the filename suggests, all logs go here.
• error.log - Every error goes here. They're easiest to find here.
• debug.log - This is only active when DEBUG mode is enabled.
• warn.log - This is where warnings from Folderr are kept. Check it once and a while.

Rotate logs

Folderr recommends using the builtin logrotate daemon on Linux.

Warning Non-Admin Users!

Non-Administrative Users need to setup the logrotate daemon for themselves or have a system admin do it.

Example (requires modification)

Put this in /etc/logrotate.d/folderr This will keep your logs for 7 days

Rocky Linux/RHEL Admin

/etc/folderr/logs/*.log {
       su folderr folderr
       daily
       rotate 7
       delaycompress
       compress
       notifempty
       missingok
       copytruncate
}

Rocky Linux/RHEL User

/home/folderr/folderr/logs/*.log {
       daily
       rotate 7
       delaycompress
       compress
       notifempty
       missingok
       copytruncate
}