1 files changed, 206 insertions, 0 deletions
diff --git a/docs/gallery-dl-example.conf b/docs/gallery-dl-example.conf
new file mode 100644
index 0000000..d84febd
--- /dev/null
+++ b/docs/gallery-dl-example.conf
@@ -0,0 +1,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
+}