Skip to content

diantahoc/chan-archiver

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

47 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

ChanArchiver is a personal archive program for 4chan.

Some features highlights:

Web-Authentication:

By default, ChanArchiver enables HTTP Basic Authentication to prevent un-authorized archive access. The default username/password combination is admin/admin.

If you happen to forget your password, you can find your credentials inside the settings.json file inside ChanArchive save directory, under AuthUsername and AuthPassword fields.

Alternatively, you can type reset-creds in the interactive console to change your credentials to a random value that will be printed.

Wordfilter:

The word filter is used to remove certain words from archived posts. It's applied to the post comment, post subject and file names. They can be added or removed using the Interactive Console.

File browser:

ChanArchiver include a mobile optimized file browser. It can be accessed at http://ip:port/filetree.

The file browser basically list files thumbnails according to the selected file type.

Adding archived (dead) threads

ChanArchiver can load 404'd threads from a FoolFuuka-based archive. This is limited to boards that exist on 4chan, that means you cannot archive a thread from some /meta/ board.

This is useful in various scenarios, for example downloading all the files inside some thread.

Threads can be added using the Watch Jobs web page.

Currently only FoolFukka JSON API is supported. An HTML parser might be added in the future, along with automatic archive resort when a thread/file is not found (404'ed).

Command Line switches

NOTICE: The command line switches provide basic and legacy thread adding / board monitoring and they will be removed in future releases. The preferred way to perform these actions is to the the Web interface.

By default, ChanArchiver start the http server (listen on port 8787). You can modify it's behavior with the following command line switches:

  • --thread:a:133 : Archive thread 133 from the /a/ board. Additional threads can be added via the web user interface. Cannot be used in conjunction with --board.
  • --noserver : To prevent ChanArchiver starting the HTTP server. Useful if you don't want to serve page right now, or another instance of ChanArchiver is running as server.
  • --board:r : Archive the /r/ board. Overrides the board for the --thread switch, so cannot be used with --thread
  • --thumbonly : Only save thumbnails.
  • --verbose : Output logs to the terminal console, instead of only logging them to the web ui. Plus perform additional logging.
  • --port:123: Change the http server port to 123.
  • --savedir <dir> : Change the save directory.
  • --idle : Prevent ChanArchiver from resuming saved jobs.

Integration with 4chan

ChanArchiver can be integrated with 4chan pages by adding an [Archive] [Archive TO] buttons next to the op post and in the catalog, as shown in the picture below:

preview

The [Archive TO] button stand for Archive Thumbnail Only.

User script: https://raw.github.com/diantahoc/chan-archiver/master/chan_archiver.user.js

ChanArchiver must be running in order have this script working properly. Modify the script to match your ipadress:port settings.

Todo list

  • Add the ability to download threads as zip archive.
  • Add support for Fuuka-based archives.
  • Add the ability to use archives when a thread/file 404.
  • Add a WebUI for word filters.

Credits and Legal

ChanArchiver use the following libraries:

ChanArchiver is legally licensed under the GPLv2. Contributing is simple as suggesting features, or reporting issues, or forking and sending pull requests.