Difference between revisions of "Dev/Source Code"

From Archiveteam
< Dev
Jump to navigation Jump to search
(→‎URLTeam code: add links to new tracker code)
(→‎Projects: describe items and index)
Line 17: Line 17:


Projects are in separate repositories typically with the name <code>-grab</code> as a suffix.
Projects are in separate repositories typically with the name <code>-grab</code> as a suffix.
Item lists that are loaded into the tracker are sometimes saved into a repo with <code>-items</code> as a suffix. Scripts to build searchable index HTML pages are usually suffixed with <code>-index</code>.


== Server code ==
== Server code ==

Revision as of 06:12, 2 November 2014

Fork me on GitHub! File issues, fix bugs, refactor code, submit pull requests… all welcome!

The warrior uses the following repos:

Client code

Client code includes code that the Warrior executes.

warrior-preseed - shell

For constructing the warrior virtual appliance image

warrior-code2 - shell

Bootstrap code that is pulled from GitHub by the appliance

seesaw-kit - Python

Library that helps build grab scripts, the web interface, and pipeline engine for the warrior. The name "seesaw" comes from its original behavior: download, upload, and repeat.

Projects

Projects are in separate repositories typically with the name -grab as a suffix.

Item lists that are loaded into the tracker are sometimes saved into a repo with -items as a suffix. Scripts to build searchable index HTML pages are usually suffixed with -index.

Server code

Server code includes code that the Tracker executes.

universal-tracker - Ruby

The server of which the Seesaw contacts

warrior-hq - Ruby

The server of which the warrior appliances contact for project metadata

archiveteam-megawarc-factory - shell

The scripts that bundles the WARC files.

URLTeam code

URLTeam code is independent from the tracker and warrior.

Old:

tinyback

The client code that scrapes the shortlinks. It includes a pipeline shim to run the code.

tinyarchive

The server code for the tracker.

New:

terroroftinytown-client-grab

A pipeline shim to run the code.

terroroftinytown

The code for both the client library and tracker.

Misc

warrior-dockerfile

Dockerfile that runs the warrior inside a Docker container.

ArchiveBot - Ruby, Python, Lua

An IRC bot for archiving websites.

wget-lua - C, Lua

A patched version of Wget for web crawling.

standalone-readme-template - Markdown

A template for readme files included in grab repositories.

archiveteam-dev-env - Shell

Ubuntu preseed for a developer environment for ArchiveTeam projects.


Developer Documentation