1 line
35 KiB
JavaScript
1 line
35 KiB
JavaScript
"use strict";(self.webpackChunkof_dl=self.webpackChunkof_dl||[]).push([[74],{3614:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>t,contentTitle:()=>o,default:()=>h,frontMatter:()=>l,metadata:()=>r,toc:()=>a});var i=s(4848),d=s(8453);const l={sidebar_position:2},o="Configuration",r={id:"config/configuration",title:"Configuration",description:"The config.conf file contains all the options you can change, these options are listed below:",source:"@site/docs/config/configuration.md",sourceDirName:"config",slug:"/config/configuration",permalink:"/OF-DL/docs/config/configuration",draft:!1,unlisted:!1,tags:[],version:"current",sidebarPosition:2,frontMatter:{sidebar_position:2},sidebar:"generatedSidebar",previous:{title:"Authentication",permalink:"/OF-DL/docs/config/auth"},next:{title:"Custom Filename Formats",permalink:"/OF-DL/docs/config/custom-filename-formats"}},t={},a=[{value:"FFmpegPath",id:"ffmpegpath",level:2},{value:"DownloadAvatarHeaderPhoto",id:"downloadavatarheaderphoto",level:2},{value:"DownloadPaidPosts",id:"downloadpaidposts",level:2},{value:"DownloadPosts",id:"downloadposts",level:2},{value:"DownloadArchived",id:"downloadarchived",level:2},{value:"DownloadStreams",id:"downloadstreams",level:2},{value:"DownloadStories",id:"downloadstories",level:2},{value:"DownloadHighlights",id:"downloadhighlights",level:2},{value:"DownloadMessages",id:"downloadmessages",level:2},{value:"DownloadPaidMessages",id:"downloadpaidmessages",level:2},{value:"DownloadImages",id:"downloadimages",level:2},{value:"DownloadVideos",id:"downloadvideos",level:2},{value:"DownloadAudios",id:"downloadaudios",level:2},{value:"IgnoreOwnMessages",id:"ignoreownmessages",level:2},{value:"DownloadPostsIncrementally",id:"downloadpostsincrementally",level:2},{value:"BypassContentForCreatorsWhoNoLongerExist",id:"bypasscontentforcreatorswhonolongerexist",level:2},{value:"DownloadDuplicatedMedia",id:"downloadduplicatedmedia",level:2},{value:"SkipAds",id:"skipads",level:2},{value:"DownloadPath",id:"downloadpath",level:2},{value:"DownloadOnlySpecificDates",id:"downloadonlyspecificdates",level:2},{value:"DownloadDateSelection",id:"downloaddateselection",level:2},{value:"CustomDate",id:"customdate",level:2},{value:"PaidPostFileNameFormat",id:"paidpostfilenameformat",level:2},{value:"PostFileNameFormat",id:"postfilenameformat",level:2},{value:"PaidMessageFileNameFormat",id:"paidmessagefilenameformat",level:2},{value:"MessageFileNameFormat",id:"messagefilenameformat",level:2},{value:"RenameExistingFilesWhenCustomFormatIsSelected",id:"renameexistingfileswhencustomformatisselected",level:2},{value:"CreatorConfigs",id:"creatorconfigs",level:2},{value:"FolderPerPaidPost",id:"folderperpaidpost",level:2},{value:"FolderPerPost",id:"folderperpost",level:2},{value:"FolderPerPaidMessage",id:"folderperpaidmessage",level:2},{value:"FolderPerMessage",id:"folderpermessage",level:2},{value:"IncludeExpiredSubscriptions",id:"includeexpiredsubscriptions",level:2},{value:"IncludeRestrictedSubscriptions",id:"includerestrictedsubscriptions",level:2},{value:"IgnoredUsersListName",id:"ignoreduserslistname",level:2},{value:"NonInteractiveMode",id:"noninteractivemode",level:2},{value:"NonInteractiveModeListName",id:"noninteractivemodelistname",level:2},{value:"NonInteractiveModePurchasedTab",id:"noninteractivemodepurchasedtab",level:2},{value:"Timeout",id:"timeout",level:2},{value:"LimitDownloadRate",id:"limitdownloadrate",level:2},{value:"DownloadLimitInMbPerSec",id:"downloadlimitinmbpersec",level:2},{value:"LoggingLevel",id:"logginglevel",level:2}];function c(e){const n={a:"a",admonition:"admonition",code:"code",h1:"h1",h2:"h2",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",...(0,d.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"configuration",children:"Configuration"}),"\n",(0,i.jsxs)(n.p,{children:["The ",(0,i.jsx)(n.code,{children:"config.conf"})," file contains all the options you can change, these options are listed below:"]}),"\n",(0,i.jsx)(n.h1,{id:"configuration---external-tools",children:"Configuration - External Tools"}),"\n",(0,i.jsx)(n.h2,{id:"ffmpegpath",children:"FFmpegPath"}),"\n",(0,i.jsxs)(n.p,{children:["Type: ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsxs)(n.p,{children:["Default: ",(0,i.jsx)(n.code,{children:'""'})]}),"\n",(0,i.jsxs)(n.p,{children:["Allowed values: Any valid path or ",(0,i.jsx)(n.code,{children:'""'})]}),"\n",(0,i.jsxs)(n.p,{children:["Description: This is the path to the FFmpeg executable (",(0,i.jsx)(n.code,{children:"ffmpeg.exe"})," on Windows and ",(0,i.jsx)(n.code,{children:"ffmpeg"})," on Linux/macOS).\nIf the path is not set then the program will try to find it in both the same directory as the OF-DL executable as well\nas the PATH environment variable."]}),"\n",(0,i.jsx)(n.admonition,{type:"note",children:(0,i.jsxs)(n.p,{children:["If you are using a Windows path, you will need to escape the backslashes, e.g. ",(0,i.jsx)(n.code,{children:'"C:\\\\ffmpeg\\\\bin\\\\ffmpeg.exe"'}),"\nFor example, this is not valid: ",(0,i.jsx)(n.code,{children:'"C:\\some\\path\\ffmpeg.exe"'}),", but ",(0,i.jsx)(n.code,{children:'"C:/some/path/ffmpeg.exe"'})," and ",(0,i.jsx)(n.code,{children:'"C:\\\\some\\\\path\\\\ffmpeg.exe"'})," are both valid."]})}),"\n",(0,i.jsx)(n.h1,{id:"configuration---download-settings",children:"Configuration - Download Settings"}),"\n",(0,i.jsx)(n.h2,{id:"downloadavatarheaderphoto",children:"DownloadAvatarHeaderPhoto"}),"\n",(0,i.jsxs)(n.p,{children:["Type: ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n",(0,i.jsxs)(n.p,{children:["Default: ",(0,i.jsx)(n.code,{children:"true"})]}),"\n",(0,i.jsxs)(n.p,{children:["Allowed values: ",(0,i.jsx)(n.code,{children:"true"}),", ",(0,i.jsx)(n.code,{children:"false"})]}),"\n",(0,i.jsxs)(n.p,{children:["Description: Avatar and header images will be downloaded if set to ",(0,i.jsx)(n.code,{children:"true"})]}),"\n",(0,i.jsx)(n.h2,{id:"downloadpaidposts",children:"DownloadPaidPosts"}),"\n",(0,i.jsxs)(n.p,{children:["Type: ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n",(0,i.jsxs)(n.p,{children:["Default: ",(0,i.jsx)(n.code,{children:"true"})]}),"\n",(0,i.jsxs)(n.p,{children:["Allowed values: ",(0,i.jsx)(n.code,{children:"true"}),", ",(0,i.jsx)(n.code,{children:"false"})]}),"\n",(0,i.jsxs)(n.p,{children:["Description: Paid posts will be downloaded if set to ",(0,i.jsx)(n.code,{children:"true"})]}),"\n",(0,i.jsx)(n.h2,{id:"downloadposts",children:"DownloadPosts"}),"\n",(0,i.jsxs)(n.p,{children:["Type: ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n",(0,i.jsxs)(n.p,{children:["Default: ",(0,i.jsx)(n.code,{children:"true"})]}),"\n",(0,i.jsxs)(n.p,{children:["Allowed values: ",(0,i.jsx)(n.code,{children:"true"}),", ",(0,i.jsx)(n.code,{children:"false"})]}),"\n",(0,i.jsxs)(n.p,{children:["Description: Free posts will be downloaded if set to ",(0,i.jsx)(n.code,{children:"true"})]}),"\n",(0,i.jsx)(n.h2,{id:"downloadarchived",children:"DownloadArchived"}),"\n",(0,i.jsxs)(n.p,{children:["Type: ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n",(0,i.jsxs)(n.p,{children:["Default: ",(0,i.jsx)(n.code,{children:"true"})]}),"\n",(0,i.jsxs)(n.p,{children:["Allowed values: ",(0,i.jsx)(n.code,{children:"true"}),", ",(0,i.jsx)(n.code,{children:"false"})]}),"\n",(0,i.jsxs)(n.p,{children:['Description: Posts in the "Archived" tab will be downloaded if set to ',(0,i.jsx)(n.code,{children:"true"})]}),"\n",(0,i.jsx)(n.h2,{id:"downloadstreams",children:"DownloadStreams"}),"\n",(0,i.jsxs)(n.p,{children:["Type: ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n",(0,i.jsxs)(n.p,{children:["Default: ",(0,i.jsx)(n.code,{children:"true"})]}),"\n",(0,i.jsxs)(n.p,{children:["Allowed values: ",(0,i.jsx)(n.code,{children:"true"}),", ",(0,i.jsx)(n.code,{children:"false"})]}),"\n",(0,i.jsxs)(n.p,{children:['Description: Posts in the "Streams" tab will be downloaded if set to ',(0,i.jsx)(n.code,{children:"true"})]}),"\n",(0,i.jsx)(n.h2,{id:"downloadstories",children:"DownloadStories"}),"\n",(0,i.jsxs)(n.p,{children:["Type: ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n",(0,i.jsxs)(n.p,{children:["Default: ",(0,i.jsx)(n.code,{children:"true"})]}),"\n",(0,i.jsxs)(n.p,{children:["Allowed values: ",(0,i.jsx)(n.code,{children:"true"}),", ",(0,i.jsx)(n.code,{children:"false"})]}),"\n",(0,i.jsxs)(n.p,{children:["Description: Stories on a user's profile will be downloaded if set to ",(0,i.jsx)(n.code,{children:"true"})]}),"\n",(0,i.jsx)(n.h2,{id:"downloadhighlights",children:"DownloadHighlights"}),"\n",(0,i.jsxs)(n.p,{children:["Type: ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n",(0,i.jsxs)(n.p,{children:["Default: ",(0,i.jsx)(n.code,{children:"true"})]}),"\n",(0,i.jsxs)(n.p,{children:["Allowed values: ",(0,i.jsx)(n.code,{children:"true"}),", ",(0,i.jsx)(n.code,{children:"false"})]}),"\n",(0,i.jsxs)(n.p,{children:["Description: Highlights on a user's will be downloaded if set to ",(0,i.jsx)(n.code,{children:"true"})]}),"\n",(0,i.jsx)(n.h2,{id:"downloadmessages",children:"DownloadMessages"}),"\n",(0,i.jsxs)(n.p,{children:["Type: ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n",(0,i.jsxs)(n.p,{children:["Default: ",(0,i.jsx)(n.code,{children:"true"})]}),"\n",(0,i.jsxs)(n.p,{children:["Allowed values: ",(0,i.jsx)(n.code,{children:"true"}),", ",(0,i.jsx)(n.code,{children:"false"})]}),"\n",(0,i.jsxs)(n.p,{children:["Description: Free media within messages (including paid message previews) will be downloaded if set to ",(0,i.jsx)(n.code,{children:"true"})]}),"\n",(0,i.jsx)(n.h2,{id:"downloadpaidmessages",children:"DownloadPaidMessages"}),"\n",(0,i.jsxs)(n.p,{children:["Type: ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n",(0,i.jsxs)(n.p,{children:["Default: ",(0,i.jsx)(n.code,{children:"true"})]}),"\n",(0,i.jsxs)(n.p,{children:["Allowed values: ",(0,i.jsx)(n.code,{children:"true"}),", ",(0,i.jsx)(n.code,{children:"false"})]}),"\n",(0,i.jsxs)(n.p,{children:["Description: Paid media within messages (excluding paid message previews) will be downloaded if set to ",(0,i.jsx)(n.code,{children:"true"})]}),"\n",(0,i.jsx)(n.h2,{id:"downloadimages",children:"DownloadImages"}),"\n",(0,i.jsxs)(n.p,{children:["Type: ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n",(0,i.jsxs)(n.p,{children:["Default: ",(0,i.jsx)(n.code,{children:"true"})]}),"\n",(0,i.jsxs)(n.p,{children:["Allowed values: ",(0,i.jsx)(n.code,{children:"true"}),", ",(0,i.jsx)(n.code,{children:"false"})]}),"\n",(0,i.jsxs)(n.p,{children:["Description: Images will be downloaded if set to ",(0,i.jsx)(n.code,{children:"true"})]}),"\n",(0,i.jsx)(n.h2,{id:"downloadvideos",children:"DownloadVideos"}),"\n",(0,i.jsxs)(n.p,{children:["Type: ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n",(0,i.jsxs)(n.p,{children:["Default: ",(0,i.jsx)(n.code,{children:"true"})]}),"\n",(0,i.jsxs)(n.p,{children:["Allowed values: ",(0,i.jsx)(n.code,{children:"true"}),", ",(0,i.jsx)(n.code,{children:"false"})]}),"\n",(0,i.jsxs)(n.p,{children:["Description: Videos will be downloaded if set to ",(0,i.jsx)(n.code,{children:"true"})]}),"\n",(0,i.jsx)(n.h2,{id:"downloadaudios",children:"DownloadAudios"}),"\n",(0,i.jsxs)(n.p,{children:["Type: ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n",(0,i.jsxs)(n.p,{children:["Default: ",(0,i.jsx)(n.code,{children:"true"})]}),"\n",(0,i.jsxs)(n.p,{children:["Allowed values: ",(0,i.jsx)(n.code,{children:"true"}),", ",(0,i.jsx)(n.code,{children:"false"})]}),"\n",(0,i.jsxs)(n.p,{children:["Description: Audios will be downloaded if set to ",(0,i.jsx)(n.code,{children:"true"})]}),"\n",(0,i.jsx)(n.h2,{id:"ignoreownmessages",children:"IgnoreOwnMessages"}),"\n",(0,i.jsxs)(n.p,{children:["Type: ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n",(0,i.jsxs)(n.p,{children:["Default: ",(0,i.jsx)(n.code,{children:"false"})]}),"\n",(0,i.jsxs)(n.p,{children:["Allowed values: ",(0,i.jsx)(n.code,{children:"true"}),", ",(0,i.jsx)(n.code,{children:"false"})]}),"\n",(0,i.jsxs)(n.p,{children:["Description: By default (or when set to ",(0,i.jsx)(n.code,{children:"false"}),"), messages that were sent by yourself will be added to the metadata DB and any media which has been sent by yourself will be downloaded. If set to ",(0,i.jsx)(n.code,{children:"true"}),", the program will not add messages sent by yourself to the metadata DB and will not download any media which has been sent by yourself."]}),"\n",(0,i.jsx)(n.h2,{id:"downloadpostsincrementally",children:"DownloadPostsIncrementally"}),"\n",(0,i.jsxs)(n.p,{children:["Type: ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n",(0,i.jsxs)(n.p,{children:["Default: ",(0,i.jsx)(n.code,{children:"false"})]}),"\n",(0,i.jsxs)(n.p,{children:["Allowed values: ",(0,i.jsx)(n.code,{children:"true"}),", ",(0,i.jsx)(n.code,{children:"false"})]}),"\n",(0,i.jsxs)(n.p,{children:["Description: If set to ",(0,i.jsx)(n.code,{children:"true"}),", only new posts will be downloaded from the date of the last post that was downloaded based off what's in the ",(0,i.jsx)(n.code,{children:"user_data.db"})," file.\nIf set to ",(0,i.jsx)(n.code,{children:"false"}),", the default behaviour will apply, and all posts will be gathered and compared against the database to see if they need to be downloaded or not."]}),"\n",(0,i.jsx)(n.h2,{id:"bypasscontentforcreatorswhonolongerexist",children:"BypassContentForCreatorsWhoNoLongerExist"}),"\n",(0,i.jsxs)(n.p,{children:["Type: ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n",(0,i.jsxs)(n.p,{children:["Default: ",(0,i.jsx)(n.code,{children:"false"})]}),"\n",(0,i.jsxs)(n.p,{children:["Allowed values: ",(0,i.jsx)(n.code,{children:"true"}),", ",(0,i.jsx)(n.code,{children:"false"})]}),"\n",(0,i.jsxs)(n.p,{children:['Description: When a creator no longer exists (their account has been deleted), most of their content will be inaccessible.\nPurchased content, however, will still be accessible by downloading media usisng the "Download Purchased Tab" menu option\nor with the ',(0,i.jsx)(n.a,{href:"#noninteractivemodepurchasedtab",children:"NonInteractiveModePurchasedTab"})," config option when downloading media in non-interactive mode."]}),"\n",(0,i.jsx)(n.h2,{id:"downloadduplicatedmedia",children:"DownloadDuplicatedMedia"}),"\n",(0,i.jsxs)(n.p,{children:["Type: ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n",(0,i.jsxs)(n.p,{children:["Default: ",(0,i.jsx)(n.code,{children:"false"})]}),"\n",(0,i.jsxs)(n.p,{children:["Allowed values: ",(0,i.jsx)(n.code,{children:"true"}),", ",(0,i.jsx)(n.code,{children:"false"})]}),"\n",(0,i.jsxs)(n.p,{children:["Description: By default (or when set to ",(0,i.jsx)(n.code,{children:"false"}),"), the program will not download duplicated media. If set to ",(0,i.jsx)(n.code,{children:"true"}),", duplicated media will be downloaded."]}),"\n",(0,i.jsx)(n.h2,{id:"skipads",children:"SkipAds"}),"\n",(0,i.jsxs)(n.p,{children:["Type: ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n",(0,i.jsxs)(n.p,{children:["Default: ",(0,i.jsx)(n.code,{children:"false"})]}),"\n",(0,i.jsxs)(n.p,{children:["Allowed values: ",(0,i.jsx)(n.code,{children:"true"}),", ",(0,i.jsx)(n.code,{children:"false"})]}),"\n",(0,i.jsxs)(n.p,{children:["Description: Posts and messages that contain #ad or free trial links will be ignored if set to ",(0,i.jsx)(n.code,{children:"true"})]}),"\n",(0,i.jsx)(n.h2,{id:"downloadpath",children:"DownloadPath"}),"\n",(0,i.jsxs)(n.p,{children:["Type: ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsxs)(n.p,{children:["Default: ",(0,i.jsx)(n.code,{children:'""'})]}),"\n",(0,i.jsx)(n.p,{children:"Allowed values: Any valid path"}),"\n",(0,i.jsxs)(n.p,{children:["Description: If left blank then content will be downloaded to ",(0,i.jsx)(n.code,{children:"__user_data__/sites/OnlyFans/{username}"}),".\nIf you set the download path to ",(0,i.jsx)(n.code,{children:'"S:/"'}),", then content will be downloaded to ",(0,i.jsx)(n.code,{children:"S:/{username}"})]}),"\n",(0,i.jsx)(n.admonition,{type:"note",children:(0,i.jsxs)(n.p,{children:["If you are using a Windows path, you will need to escape the backslashes, e.g. ",(0,i.jsx)(n.code,{children:'"C:\\\\Users\\\\user\\\\Downloads\\\\OnlyFans\\\\"'}),"\nPlease make sure your path ends with a ",(0,i.jsx)(n.code,{children:"/"})]})}),"\n",(0,i.jsx)(n.h2,{id:"downloadonlyspecificdates",children:"DownloadOnlySpecificDates"}),"\n",(0,i.jsxs)(n.p,{children:["Type: ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n",(0,i.jsxs)(n.p,{children:["Default: ",(0,i.jsx)(n.code,{children:"false"})]}),"\n",(0,i.jsxs)(n.p,{children:["Allowed values: ",(0,i.jsx)(n.code,{children:"true"}),", ",(0,i.jsx)(n.code,{children:"false"})]}),"\n",(0,i.jsxs)(n.p,{children:["Description: If set to ",(0,i.jsx)(n.code,{children:"true"}),", posts will be downloaded based on the ",(0,i.jsx)(n.a,{href:"#downloaddateselection",children:"DownloadDateSelection"})," and ",(0,i.jsx)(n.a,{href:"#customdate",children:"CustomDate"})," config options.\nIf set to ",(0,i.jsx)(n.code,{children:"false"}),", all posts will be downloaded."]}),"\n",(0,i.jsx)(n.h2,{id:"downloaddateselection",children:"DownloadDateSelection"}),"\n",(0,i.jsxs)(n.p,{children:["Type: ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsxs)(n.p,{children:["Default: ",(0,i.jsx)(n.code,{children:'"before"'})]}),"\n",(0,i.jsxs)(n.p,{children:["Allowed values: ",(0,i.jsx)(n.code,{children:'"before"'}),", ",(0,i.jsx)(n.code,{children:'"after"'})]}),"\n",(0,i.jsxs)(n.p,{children:["Description: ",(0,i.jsx)(n.a,{href:"#downloadonlyspecificdates",children:"DownloadOnlySpecificDates"})," needs to be set to ",(0,i.jsx)(n.code,{children:"true"})," for this to work. This will get all posts from before\nthe date if set to ",(0,i.jsx)(n.code,{children:'"before"'}),", and all posts from the date you specify up until the current date if set to ",(0,i.jsx)(n.code,{children:'"after"'}),".\nThe date you specify will be in the ",(0,i.jsx)(n.a,{href:"#customdate",children:"CustomDate"})," config option."]}),"\n",(0,i.jsx)(n.h2,{id:"customdate",children:"CustomDate"}),"\n",(0,i.jsxs)(n.p,{children:["Type: ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsxs)(n.p,{children:["Default: ",(0,i.jsx)(n.code,{children:"null"})]}),"\n",(0,i.jsxs)(n.p,{children:["Allowed values: Any date in ",(0,i.jsx)(n.code,{children:"yyyy-mm-dd"})," format or ",(0,i.jsx)(n.code,{children:"null"})]}),"\n",(0,i.jsxs)(n.p,{children:["Description: ",(0,i.jsx)(n.a,{href:"#downloadonlyspecificdates",children:"DownloadOnlySpecificDates"})," needs to be set to ",(0,i.jsx)(n.code,{children:"true"})," for this to work.\nThis date will be used when you are trying to download between/after a certain date. See ",(0,i.jsx)(n.a,{href:"#downloadonlyspecificdates",children:"DownloadOnlySpecificDates"})," and\n",(0,i.jsx)(n.a,{href:"#downloaddateselection",children:"DownloadDateSelection"})," for more information."]}),"\n",(0,i.jsx)(n.h1,{id:"configuration---file-settings",children:"Configuration - File Settings"}),"\n",(0,i.jsx)(n.h2,{id:"paidpostfilenameformat",children:"PaidPostFileNameFormat"}),"\n",(0,i.jsxs)(n.p,{children:["Type: ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsxs)(n.p,{children:["Default: ",(0,i.jsx)(n.code,{children:'""'})]}),"\n",(0,i.jsx)(n.p,{children:"Allowed values: Any valid string"}),"\n",(0,i.jsxs)(n.p,{children:["Description: Please refer to ",(0,i.jsx)(n.a,{href:"/docs/config/custom-filename-formats#paidpostfilenameformat",children:"custom filename formats"})," page to see what fields you can use."]}),"\n",(0,i.jsx)(n.h2,{id:"postfilenameformat",children:"PostFileNameFormat"}),"\n",(0,i.jsxs)(n.p,{children:["Type: ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsxs)(n.p,{children:["Default: ",(0,i.jsx)(n.code,{children:'""'})]}),"\n",(0,i.jsx)(n.p,{children:"Allowed values: Any valid string"}),"\n",(0,i.jsxs)(n.p,{children:["Description: Please refer to the ",(0,i.jsx)(n.a,{href:"/docs/config/custom-filename-formats#postfilenameformat",children:"custom filename formats"})," page to see what fields you can use."]}),"\n",(0,i.jsx)(n.h2,{id:"paidmessagefilenameformat",children:"PaidMessageFileNameFormat"}),"\n",(0,i.jsxs)(n.p,{children:["Type: ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsxs)(n.p,{children:["Default: ",(0,i.jsx)(n.code,{children:'""'})]}),"\n",(0,i.jsx)(n.p,{children:"Allowed values: Any valid string"}),"\n",(0,i.jsxs)(n.p,{children:["Description: Please refer to ",(0,i.jsx)(n.a,{href:"/docs/config/custom-filename-formats#paidmessagefilenameformat",children:"custom filename formats"})," page to see what fields you can use."]}),"\n",(0,i.jsx)(n.h2,{id:"messagefilenameformat",children:"MessageFileNameFormat"}),"\n",(0,i.jsxs)(n.p,{children:["Type: ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsxs)(n.p,{children:["Default: ",(0,i.jsx)(n.code,{children:'""'})]}),"\n",(0,i.jsx)(n.p,{children:"Allowed values: Any valid string"}),"\n",(0,i.jsxs)(n.p,{children:["Description: Please refer to ",(0,i.jsx)(n.a,{href:"/docs/config/custom-filename-formats#messagefilenameformat",children:"custom filename formats"})," page to see what fields you can use."]}),"\n",(0,i.jsx)(n.h2,{id:"renameexistingfileswhencustomformatisselected",children:"RenameExistingFilesWhenCustomFormatIsSelected"}),"\n",(0,i.jsxs)(n.p,{children:["Type: ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n",(0,i.jsxs)(n.p,{children:["Default: ",(0,i.jsx)(n.code,{children:"false"})]}),"\n",(0,i.jsxs)(n.p,{children:["Allowed values: ",(0,i.jsx)(n.code,{children:"true"}),", ",(0,i.jsx)(n.code,{children:"false"})]}),"\n",(0,i.jsxs)(n.p,{children:["Description: When ",(0,i.jsx)(n.code,{children:"true"}),", any current files downloaded will have the current format applied to them.\nWhen ",(0,i.jsx)(n.code,{children:"false"}),", only new files will have the current format applied to them."]}),"\n",(0,i.jsx)(n.h1,{id:"configuration---creator-specific-configurations",children:"Configuration - Creator-Specific Configurations"}),"\n",(0,i.jsx)(n.h2,{id:"creatorconfigs",children:"CreatorConfigs"}),"\n",(0,i.jsxs)(n.p,{children:["Type: ",(0,i.jsx)(n.code,{children:"object"})]}),"\n",(0,i.jsxs)(n.p,{children:["Default: ",(0,i.jsx)(n.code,{children:"{}"})]}),"\n",(0,i.jsx)(n.p,{children:"Allowed values: An array of Creator Config objects"}),"\n",(0,i.jsxs)(n.p,{children:["Description: This configuration options allows you to set file name formats for specific creators.\nThis is useful if you want to have different file name formats for different creators. The values set here will override the global values set in the config file\n(see ",(0,i.jsx)(n.a,{href:"#paidpostfilenameformat",children:"PaidPostFileNameFormat"}),", ",(0,i.jsx)(n.a,{href:"#postfilenameformat",children:"PostFileNameFormat"}),",\n",(0,i.jsx)(n.a,{href:"#paidmessagefilenameformat",children:"PaidMessageFileNAmeFormat"}),", and ",(0,i.jsx)(n.a,{href:"#messagefilenameformat",children:"MessageFileNameFormat"}),").\nFor more information on the file name formats, see the ",(0,i.jsx)(n.a,{href:"/docs/config/custom-filename-formats",children:"custom filename formats"})," page."]}),"\n",(0,i.jsx)(n.p,{children:"Example:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'"CreatorConfigs": {\n "creator_one": {\n "PaidPostFileNameFormat": "{id}_{mediaid}_{filename}",\n "PostFileNameFormat": "{username}_{id}_{mediaid}_{mediaCreatedAt}",\n "PaidMessageFileNameFormat": "{id}_{mediaid}_{createdAt}",\n "MessageFileNameFormat": "{id}_{mediaid}_{filename}"\n },\n "creator_two": {\n "PaidPostFileNameFormat": "{id}_{mediaid}",\n "PostFileNameFormat": "{username}_{id}_{mediaid}",\n "PaidMessageFileNameFormat": "{id}_{mediaid}",\n "MessageFileNameFormat": "{id}_{mediaid}"\n }\n}\n'})}),"\n",(0,i.jsx)(n.h1,{id:"configuration---folder-settings",children:"Configuration - Folder Settings"}),"\n",(0,i.jsx)(n.h2,{id:"folderperpaidpost",children:"FolderPerPaidPost"}),"\n",(0,i.jsxs)(n.p,{children:["Type: ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n",(0,i.jsxs)(n.p,{children:["Default: ",(0,i.jsx)(n.code,{children:"false"})]}),"\n",(0,i.jsxs)(n.p,{children:["Allowed values: ",(0,i.jsx)(n.code,{children:"true"}),", ",(0,i.jsx)(n.code,{children:"false"})]}),"\n",(0,i.jsxs)(n.p,{children:["Description: A folder will be created for each paid post (containing all the media for that post) if set to ",(0,i.jsx)(n.code,{children:"true"}),".\nWhen set to ",(0,i.jsx)(n.code,{children:"false"}),", paid post media will be downloaded into the ",(0,i.jsx)(n.code,{children:"Posts/Paid"})," folder."]}),"\n",(0,i.jsx)(n.h2,{id:"folderperpost",children:"FolderPerPost"}),"\n",(0,i.jsxs)(n.p,{children:["Type: ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n",(0,i.jsxs)(n.p,{children:["Default: ",(0,i.jsx)(n.code,{children:"false"})]}),"\n",(0,i.jsxs)(n.p,{children:["Allowed values: ",(0,i.jsx)(n.code,{children:"true"}),", ",(0,i.jsx)(n.code,{children:"false"})]}),"\n",(0,i.jsxs)(n.p,{children:["Description: A folder will be created for each post (containing all the media for that post) if set to ",(0,i.jsx)(n.code,{children:"true"}),".\nWhen set to ",(0,i.jsx)(n.code,{children:"false"}),", post media will be downloaded into the ",(0,i.jsx)(n.code,{children:"Posts/Free"})," folder."]}),"\n",(0,i.jsx)(n.h2,{id:"folderperpaidmessage",children:"FolderPerPaidMessage"}),"\n",(0,i.jsxs)(n.p,{children:["Type: ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n",(0,i.jsxs)(n.p,{children:["Default: ",(0,i.jsx)(n.code,{children:"false"})]}),"\n",(0,i.jsxs)(n.p,{children:["Allowed values: ",(0,i.jsx)(n.code,{children:"true"}),", ",(0,i.jsx)(n.code,{children:"false"})]}),"\n",(0,i.jsxs)(n.p,{children:["Description: A folder will be created for each paid message (containing all the media for that message) if set to ",(0,i.jsx)(n.code,{children:"true"}),".\nWhen set to ",(0,i.jsx)(n.code,{children:"false"}),", paid message media will be downloaded into the ",(0,i.jsx)(n.code,{children:"Messages/Paid"})," folder."]}),"\n",(0,i.jsx)(n.h2,{id:"folderpermessage",children:"FolderPerMessage"}),"\n",(0,i.jsxs)(n.p,{children:["Type: ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n",(0,i.jsxs)(n.p,{children:["Default: ",(0,i.jsx)(n.code,{children:"false"})]}),"\n",(0,i.jsxs)(n.p,{children:["Allowed values: ",(0,i.jsx)(n.code,{children:"true"}),", ",(0,i.jsx)(n.code,{children:"false"})]}),"\n",(0,i.jsxs)(n.p,{children:["Description: A folder will be created for each message (containing all the media for that message) if set to ",(0,i.jsx)(n.code,{children:"true"}),".\nWhen set to ",(0,i.jsx)(n.code,{children:"false"}),", message media will be downloaded into the ",(0,i.jsx)(n.code,{children:"Messages/Free"})," folder."]}),"\n",(0,i.jsx)(n.h1,{id:"configuration---subscription-settings",children:"Configuration - Subscription Settings"}),"\n",(0,i.jsx)(n.h2,{id:"includeexpiredsubscriptions",children:"IncludeExpiredSubscriptions"}),"\n",(0,i.jsxs)(n.p,{children:["Type: ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n",(0,i.jsxs)(n.p,{children:["Default: ",(0,i.jsx)(n.code,{children:"false"})]}),"\n",(0,i.jsxs)(n.p,{children:["Allowed values: ",(0,i.jsx)(n.code,{children:"true"}),", ",(0,i.jsx)(n.code,{children:"false"})]}),"\n",(0,i.jsxs)(n.p,{children:["Description: If set to ",(0,i.jsx)(n.code,{children:"true"}),', expired subscriptions will appear in the user list under the "Custom" menu option.']}),"\n",(0,i.jsx)(n.h2,{id:"includerestrictedsubscriptions",children:"IncludeRestrictedSubscriptions"}),"\n",(0,i.jsxs)(n.p,{children:["Type: ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n",(0,i.jsxs)(n.p,{children:["Default: ",(0,i.jsx)(n.code,{children:"false"})]}),"\n",(0,i.jsxs)(n.p,{children:["Allowed values: ",(0,i.jsx)(n.code,{children:"true"}),", ",(0,i.jsx)(n.code,{children:"false"})]}),"\n",(0,i.jsxs)(n.p,{children:["Description: If set to ",(0,i.jsx)(n.code,{children:"true"}),", media from restricted creators will be downloaded. If set to ",(0,i.jsx)(n.code,{children:"false"}),", restricted creators will be ignored."]}),"\n",(0,i.jsx)(n.h2,{id:"ignoreduserslistname",children:"IgnoredUsersListName"}),"\n",(0,i.jsxs)(n.p,{children:["Type: ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsxs)(n.p,{children:["Default: ",(0,i.jsx)(n.code,{children:'""'})]}),"\n",(0,i.jsxs)(n.p,{children:["Allowed values: The name of a list of users you have created on OnlyFans or ",(0,i.jsx)(n.code,{children:'""'})]}),"\n",(0,i.jsxs)(n.p,{children:["Description: When set to the name of a list, users in the list will be ignored when scraping content.\nIf set to ",(0,i.jsx)(n.code,{children:'""'})," (or an invalid list name), no users will be ignored when scraping content."]}),"\n",(0,i.jsx)(n.h1,{id:"configuration---interaction-settings",children:"Configuration - Interaction Settings"}),"\n",(0,i.jsx)(n.h2,{id:"noninteractivemode",children:"NonInteractiveMode"}),"\n",(0,i.jsxs)(n.p,{children:["Type: ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n",(0,i.jsxs)(n.p,{children:["Default: ",(0,i.jsx)(n.code,{children:"false"})]}),"\n",(0,i.jsxs)(n.p,{children:["Allowed values: ",(0,i.jsx)(n.code,{children:"true"}),", ",(0,i.jsx)(n.code,{children:"false"})]}),"\n",(0,i.jsxs)(n.p,{children:["Description: If set to ",(0,i.jsx)(n.code,{children:"true"}),", the program will run without any input from the user. It will scrape all users automatically\n(unless ",(0,i.jsx)(n.a,{href:"#noninteractivemodelistname",children:"NonInteractiveModeListName"})," or ",(0,i.jsx)(n.a,{href:"#noninteractivemodepurchasedtab",children:"NonInteractiveModePurchasedTab"})," are configured).\nIf set to ",(0,i.jsx)(n.code,{children:"false"}),", the default behaviour will apply, and you will be able to choose an option from the menu."]}),"\n",(0,i.jsxs)(n.admonition,{type:"warning",children:[(0,i.jsx)(n.p,{children:"If NonInteractiveMode is enabled, you will be unable to authenticate OF-DL using the standard authentication method.\nBefore you can run OF-DL in NonInteractiveMode, you must either"}),(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsxs)(n.li,{children:["Generate an auth.json file by running OF-DL with NonInteractiveMode disabled and authenticating OF-DL using the standard method ",(0,i.jsx)(n.strong,{children:"OR"})]}),"\n",(0,i.jsxs)(n.li,{children:["Generate an auth.json file by using a ",(0,i.jsx)(n.a,{href:"/docs/config/auth#legacy-methods",children:"legacy authentication method"})]}),"\n"]})]}),"\n",(0,i.jsx)(n.h2,{id:"noninteractivemodelistname",children:"NonInteractiveModeListName"}),"\n",(0,i.jsxs)(n.p,{children:["Type: ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsxs)(n.p,{children:["Default: ",(0,i.jsx)(n.code,{children:'""'})]}),"\n",(0,i.jsxs)(n.p,{children:["Allowed values: The name of a list of users you have created on OnlyFans or ",(0,i.jsx)(n.code,{children:'""'})]}),"\n",(0,i.jsxs)(n.p,{children:["Description: When set to the name of a list, non-interactive mode will download media from the list of users instead of all\nusers (when ",(0,i.jsx)(n.a,{href:"#noninteractivemode",children:"NonInteractiveMode"})," is set to ",(0,i.jsx)(n.code,{children:"true"}),"). If set to ",(0,i.jsx)(n.code,{children:'""'}),", all users will be scraped\n(unless ",(0,i.jsx)(n.a,{href:"#noninteractivemodepurchasedtab",children:"NonInteractiveModePurchasedTab"})," is configured)."]}),"\n",(0,i.jsx)(n.h2,{id:"noninteractivemodepurchasedtab",children:"NonInteractiveModePurchasedTab"}),"\n",(0,i.jsxs)(n.p,{children:["Type: ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n",(0,i.jsxs)(n.p,{children:["Default: ",(0,i.jsx)(n.code,{children:"false"})]}),"\n",(0,i.jsxs)(n.p,{children:["Allowed values: ",(0,i.jsx)(n.code,{children:"true"}),", ",(0,i.jsx)(n.code,{children:"false"})]}),"\n",(0,i.jsxs)(n.p,{children:["Description: When set to ",(0,i.jsx)(n.code,{children:"true"}),", non-interactive mode will only download content from the Purchased tab\n(when ",(0,i.jsx)(n.a,{href:"#noninteractivemode",children:"NonInteractiveMode"})," is set to ",(0,i.jsx)(n.code,{children:"true"}),"). If set to ",(0,i.jsx)(n.code,{children:"false"}),", all users will be scraped\n(unless ",(0,i.jsx)(n.a,{href:"#noninteractivemodelistname",children:"NonInteractiveModeListName"})," is configured)."]}),"\n",(0,i.jsx)(n.h1,{id:"configuration---performance-settings",children:"Configuration - Performance Settings"}),"\n",(0,i.jsx)(n.h2,{id:"timeout",children:"Timeout"}),"\n",(0,i.jsxs)(n.p,{children:["Type: ",(0,i.jsx)(n.code,{children:"integer"})]}),"\n",(0,i.jsxs)(n.p,{children:["Default: ",(0,i.jsx)(n.code,{children:"-1"})]}),"\n",(0,i.jsxs)(n.p,{children:["Allowed values: Any positive integer or ",(0,i.jsx)(n.code,{children:"-1"})]}),"\n",(0,i.jsx)(n.p,{children:"Description: You won't need to set this, but if you see errors about the configured timeout of 100 seconds elapsing then\nyou could set this to be more than 100. It is recommended that you leave this as the default value."}),"\n",(0,i.jsx)(n.h2,{id:"limitdownloadrate",children:"LimitDownloadRate"}),"\n",(0,i.jsxs)(n.p,{children:["Type: ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n",(0,i.jsxs)(n.p,{children:["Default: ",(0,i.jsx)(n.code,{children:"false"})]}),"\n",(0,i.jsxs)(n.p,{children:["Allowed values: ",(0,i.jsx)(n.code,{children:"true"}),", ",(0,i.jsx)(n.code,{children:"false"})]}),"\n",(0,i.jsxs)(n.p,{children:["Description: If set to ",(0,i.jsx)(n.code,{children:"true"}),", the download rate will be limited to the value set in ",(0,i.jsx)(n.a,{href:"#downloadlimitinmbpersec",children:"DownloadLimitInMbPerSec"}),"."]}),"\n",(0,i.jsx)(n.h2,{id:"downloadlimitinmbpersec",children:"DownloadLimitInMbPerSec"}),"\n",(0,i.jsxs)(n.p,{children:["Type: ",(0,i.jsx)(n.code,{children:"integer"})]}),"\n",(0,i.jsxs)(n.p,{children:["Default: ",(0,i.jsx)(n.code,{children:"4"})]}),"\n",(0,i.jsx)(n.p,{children:"Allowed values: Any positive integer"}),"\n",(0,i.jsxs)(n.p,{children:["Description: The download rate in MB per second. This will only be used if ",(0,i.jsx)(n.a,{href:"#limitdownloadrate",children:"LimitDownloadRate"})," is set to ",(0,i.jsx)(n.code,{children:"true"}),"."]}),"\n",(0,i.jsx)(n.h1,{id:"configuration---loggingdebug-settings",children:"Configuration - Logging/Debug Settings"}),"\n",(0,i.jsx)(n.h2,{id:"logginglevel",children:"LoggingLevel"}),"\n",(0,i.jsxs)(n.p,{children:["Type: ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsxs)(n.p,{children:["Default: ",(0,i.jsx)(n.code,{children:'"Error"'})]}),"\n",(0,i.jsxs)(n.p,{children:["Allowed values: ",(0,i.jsx)(n.code,{children:'"Verbose"'}),", ",(0,i.jsx)(n.code,{children:'"Debug"'}),", ",(0,i.jsx)(n.code,{children:'"Information"'}),", ",(0,i.jsx)(n.code,{children:'"Warning"'}),", ",(0,i.jsx)(n.code,{children:'"Error"'}),", ",(0,i.jsx)(n.code,{children:'"Fatal"'})]}),"\n",(0,i.jsxs)(n.p,{children:["Description: The level of logging that will be saved to the log files in the ",(0,i.jsx)(n.code,{children:"logs"})," folder.\nWhen requesting help with an issue, it is recommended to set this to ",(0,i.jsx)(n.code,{children:'"Verbose"'})," and provide the log file."]})]})}function h(e={}){const{wrapper:n}={...(0,d.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(c,{...e})}):c(e)}},8453:(e,n,s)=>{s.d(n,{R:()=>o,x:()=>r});var i=s(6540);const d={},l=i.createContext(d);function o(e){const n=i.useContext(l);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(d):e.components||d:o(e.components),i.createElement(l.Provider,{value:n},e.children)}}}]); |