aboutsummaryrefslogtreecommitdiffstats
path: root/docs/gallery-dl-example.conf
blob: d84febdec7f80594ee050509be94c21a4d70b1ba (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
{
    "extractor":
    {
        "base-directory": "~/gallery-dl/",
        "archive": "~/gallery-dl/archive.sqlite3",
        "proxy": "http://10.10.1.10:3128",

        "postprocessors": [
            {
                "name": "ugoira",
                "whitelist": ["pixiv", "danbooru"],
                "ffmpeg-twopass": true,
                "ffmpeg-args": ["-c:v", "libvpx", "-crf", "4", "-b:v", "5000k", "-an"]
            },
            {
                "name": "metadata",
                "whitelist": ["danbooru", "yandere", "sankaku"],
                "mode": "tags"
            }
        ],

        "pixiv":
        {
            "archive": "~/gallery-dl/archive-pixiv.sqlite3",

            "filename": "{id}{num}.{extension}",
            "directory": ["Pixiv", "Works", "{user[id]}"],

            "username": "foo",
            "password": "bar",

            "favorite":
            {
                "directory": ["Pixiv", "Favorites", "{user[id]}"]
            },

            "bookmark":
            {
                "directory": ["Pixiv", "My Bookmarks"],

                "username": "foo123",
                "password": "bar123"
            }
        },

        "exhentai":
        {
            "cookies":
            {
                "ipb_member_id": "12345",
                "ipb_pass_hash": "1234567890abcdef",
                "igneous"      : "123456789",
                "hath_perks"   : "m1.m2.m3.a-123456789a"
            },

            "proxy":
            {
                "http": "http://10.10.1.10:8080",
                "https": "https://10.10.1.10:443"
            },

            "filename": "{num:>04}_{name}.{extension}",
            "directory": ["{category!c}", "{title}"],

            "wait-min": 1.0,
            "wait-max": 5.0
        },

        "mangadex":
        {
            "chapter-filter": "lang == 'en'",
            "postprocessors": [{
                "name": "zip",
                "keep-files": false,
                "compression": "zip"
            }]
        },

        "deviantart":
        {
            "include": "gallery,scraps",
            "metadata": true,
            "postprocessors": [{
                "name": "metadata",
                "mode": "custom",
                "directory"       : "Descriptions",
                "content-format"  : "{description}\n",
                "extension-format": "descr.txt"
            }]
        },

        "flickr":
        {
            "access-token": "1234567890-abcdef",
            "access-token-secret": "1234567890abcdef",
            "size-max": 1920
        },

        "reddit":
        {
            "morecomments": true,
            "date-min": "2017-01",
            "date-format": "%Y-%m",
            "recursion": 1
        },

        "sankaku":
        {
            "sleep": 2,
            "wait-min": 5.0,
            "wait-max": 5.0,
            "cookies": "~/gallery-dl/cookies-sankaku.txt"
        },

        "tumblr":
        {
            "posts": "all",
            "external": false,
            "reblogs": false,
            "inline": true,

            "likes":
            {
                "posts": "video,photo,link",
                "external": true,
                "reblogs": true
            }
        },

        "mastodon":
        {
            "mastodon.xyz":
            {
                "access-token": "cab65529..."
            },
            "tabletop.social": {
                "access-token": "513a36c6..."
            },

            "directory": ["mastodon", "{instance}", "{account[username]!l}"],
            "filename": "{id}_{media[id]}.{extension}"
        },

        "foolslide": {
            "otscans":   {"root": "https://otscans.com/foolslide"},
            "helvetica": {"root": "https://helveticascans.com/r" }
        },

        "foolfuuka": {
            "fireden-onion": {"root": "http://ydt6jy2ng3s3xg2e.onion"},
            "scalearchive":  {"root": "https://archive.scaled.team"  }
        },

        "replace invalid path characters with unicode alternatives": null,
        "path-restrict": {
            "\\": "⧹",
            "/" : "⧸",
            "|" : "│",
            ":" : "꞉",
            "*" : "∗",
            "?" : "?",
            "\"": "″",
            "<" : "﹤",
            ">" : "﹥"
        }
    },

    "downloader":
    {
        "part-directory": "/tmp/.download/",
        "rate": "1M",
        "retries": 3,
        "timeout": 8.5
    },

    "output":
    {
        "mode": "terminal",
        "log": {
            "level": "info",
            "format": {
                "debug"  : "\u001b[0;37m{name}: {message}\u001b[0m",
                "info"   : "\u001b[1;37m{name}: {message}\u001b[0m",
                "warning": "\u001b[1;33m{name}: {message}\u001b[0m",
                "error"  : "\u001b[1;31m{name}: {message}\u001b[0m"
            }
        },
        "logfile": {
            "path": "~/gallery-dl/log.txt",
            "mode": "w",
            "level": "debug"
        },
        "unsupportedfile": {
            "path": "~/gallery-dl/unsupported.txt",
            "mode": "a",
            "format": "{asctime} {message}",
            "format-date": "%Y-%m-%d-%H-%M-%S"
        }
    },

    "cache": {
        "file": "~/gallery-dl/cache.sqlite3"
    },

    "netrc": true
}