aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/gallery-dl-example.conf206
-rw-r--r--docs/gallery-dl.conf218
2 files changed, 424 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
+}
diff --git a/docs/gallery-dl.conf b/docs/gallery-dl.conf
new file mode 100644
index 0000000..c120d25
--- /dev/null
+++ b/docs/gallery-dl.conf
@@ -0,0 +1,218 @@
+{
+ "extractor":
+ {
+ "base-directory": "./gallery-dl/",
+ "postprocessors": null,
+ "archive": null,
+ "cookies": null,
+ "cookies-update": false,
+ "proxy": null,
+ "skip": true,
+ "sleep": 0,
+ "path-restrict": "auto",
+ "path-replace": "_",
+ "path-remove": "\\u0000-\\u001f\\u007f",
+ "user-agent": "Mozilla/5.0 (X11; Linux x86_64; rv:68.0) Gecko/20100101 Firefox/68.0",
+
+ "artstation":
+ {
+ "external": false
+ },
+ "blogger":
+ {
+ "videos": true
+ },
+ "danbooru":
+ {
+ "username": null,
+ "password": null,
+ "ugoira": false
+ },
+ "deviantart":
+ {
+ "extra": false,
+ "flat": true,
+ "folders": false,
+ "journals": "html",
+ "mature": true,
+ "metadata": false,
+ "original": true,
+ "quality": 100,
+ "wait-min": 0
+ },
+ "exhentai":
+ {
+ "username": null,
+ "password": null,
+ "original": true,
+ "wait-min": 3.0,
+ "wait-max": 6.0
+ },
+ "flickr":
+ {
+ "videos": true,
+ "size-max": null
+ },
+ "gelbooru":
+ {
+ "api": true
+ },
+ "gfycat":
+ {
+ "format": "mp4"
+ },
+ "hitomi":
+ {
+ "metadata": true
+ },
+ "idolcomplex":
+ {
+ "username": null,
+ "password": null,
+ "wait-min": 3.0,
+ "wait-max": 6.0
+ },
+ "imgur":
+ {
+ "mp4": true
+ },
+ "instagram":
+ {
+ "highlights": false,
+ "videos": true
+ },
+ "kissmanga":
+ {
+ "captcha": "stop"
+ },
+ "nijie":
+ {
+ "username": null,
+ "password": null
+ },
+ "oauth":
+ {
+ "browser": true,
+ "cache": true,
+ "port": 6414
+ },
+ "pixiv":
+ {
+ "username": null,
+ "password": null,
+ "avatar": false,
+ "ugoira": true
+ },
+ "reactor":
+ {
+ "wait-min": 3.0,
+ "wait-max": 6.0
+ },
+ "readcomiconline":
+ {
+ "captcha": "stop"
+ },
+ "recursive":
+ {
+ "blacklist": ["directlink", "oauth", "recursive", "test"]
+ },
+ "reddit":
+ {
+ "comments": 0,
+ "morecomments": false,
+ "date-min": 0,
+ "date-max": 253402210800,
+ "date-format": "%Y-%m-%dT%H:%M:%S",
+ "id-min": "0",
+ "id-max": "zik0zj",
+ "recursion": 0,
+ "videos": true,
+ "user-agent": "Python:gallery-dl:0.8.4 (by /u/mikf1)"
+ },
+ "sankaku":
+ {
+ "username": null,
+ "password": null,
+ "wait-min": 3.0,
+ "wait-max": 6.0
+ },
+ "seiga":
+ {
+ "username": null,
+ "password": null
+ },
+ "tumblr":
+ {
+ "avatar": false,
+ "external": false,
+ "inline": true,
+ "posts": "all",
+ "reblogs": true
+ },
+ "twitter":
+ {
+ "content": false,
+ "replies": true,
+ "retweets": true,
+ "twitpic": false,
+ "videos": true
+ },
+ "vsco":
+ {
+ "videos": true
+ },
+ "wallhaven":
+ {
+ "api-key": null
+ },
+ "weibo":
+ {
+ "retweets": true,
+ "videos": true
+ },
+ "booru":
+ {
+ "tags": false
+ }
+ },
+
+ "downloader":
+ {
+ "part": true,
+ "part-directory": null,
+
+ "http":
+ {
+ "adjust-extensions": true,
+ "mtime": true,
+ "rate": null,
+ "retries": 4,
+ "timeout": 30.0,
+ "verify": true
+ },
+
+ "ytdl":
+ {
+ "format": null,
+ "forward-cookies": false,
+ "mtime": true,
+ "outtmpl": null,
+ "rate": null,
+ "retries": 4,
+ "timeout": 30.0,
+ "verify": true
+ }
+ },
+
+ "output":
+ {
+ "mode": "auto",
+ "progress": true,
+ "shorten": true,
+ "log": "[{name}][{levelname}] {message}",
+ "logfile": null,
+ "unsupportedfile": null
+ },
+
+ "netrc": false
+}