📂User Folder

Learn about the important User Folder and what you can find in it.

WrangleBot creates a folder called wranglebot in your user account folder of your operating system. For macOS users, this is always be /Users/<username>/, on Linux builds it will usually be /home/<username>/

In the folder you will find a few folders and files.

Folders

custom

The custom folder is either created by WrangleBot or manually, you can copy extensions here, that you create or download from the internet.

LUTs

This folder is where you can copy 3D-LUTs to, in order to use them in the transcode features. WrangleBot supports .cube files.

thumbnails

If you create thumbnails, caches are created and saved here.

transactions

These cryptic folders and files are your database. Don't touch this folder ever. It should only be written and read by WrangleBot.

Files

log.txt

This file contains all logs written by WrangleBot (more specifically its sibling LogBot) and are neatly prepared for you to read as a human. You can conveniently open it with any text editor.

If the log ever reaches an unreasonable size you can simply delete it. LogBot will create a new one the next time it logs information.

As a developer you can use this to debug your extensions and see if it loaded your files without error.

config.json

The config is an important setting file and allows you to change core settings of WrangleBot. It's okay to change values in this file from other processes. Be aware though, that WrangleBot won't nessecarily respect your changes if it's already running, especially changes that require a restart.

Sample config.json

{
  "jwt-secret": "<jwt-secret>",
  "app-name": "wranglebot",
  "wb-version": "7", 
  "auth-server": "https://wranglebot.io",
  "ml-server": "https://ai.wranglebot.io",
  "database": "https://db2.wranglebot.io",
  "luts": "/Users/<username>/wranglebot/LUTs",
  "mail": {
    "host": "myhost.com",
    "port": "25",
    "auth": {
      "user": "example@wranglebot.io",
      "pass": "xxxx-xxxx-xxxx-xxxx"
    }
  }
}

mailConfig

If you want to send Emails with WrangleBot from your instances, you must setup a mailConfig in your config.json. If you do not setup a mailConfig, the instance won't be able to send any Emails to Users. To reset passwords without administrative intervention you will need to setup a mailConfig.

"mail": {
    "host": "myhost.com",
    "port": "25",
    "auth": {
      "user": "example@wranglebot.io",
      "pass": "xxxx-xxxx-xxxx-xxxx"
    }
  }

Last updated