Difference between revisions of "Dev/Source Code"
(reorganize dockerfile, add archivebot and wget-lua) |
(Add wpull and -dev IRC channel) |
||
(18 intermediate revisions by 7 users not shown) | |||
Line 1: | Line 1: | ||
[https://github.com/ArchiveTeam/ Fork me on GitHub!] File and triage issues, fix bugs, refactor code, submit pull requests… all welcome! Discussion in {{IRC|archiveteam-dev}}. | |||
'''[https://github.com/search?l=&q=user%3AArchiveTeam+state%3Aopen&type=Issues See this link for all issues]'''. | |||
The warrior uses the following repos: | |||
== Client code == | == Client code == | ||
Line 5: | Line 9: | ||
Client code includes code that the [[Warrior]] executes. | Client code includes code that the [[Warrior]] executes. | ||
[https://github.com/ArchiveTeam/warrior- | ;[https://github.com/ArchiveTeam/Ubuntu-Warrior warrior3]''' - bootstrap and tools to build the image | ||
: | :Bootstrap code that is pulled from GitHub by the appliance and starts a docker container | ||
[https://github.com/ArchiveTeam/warrior-code2 warrior | ;[https://github.com/ArchiveTeam/warrior-dockerfile archiveteam/warrior-dockerfile] - the container | ||
: | :Instructions to boostrap the docker container | ||
[https://github.com/ArchiveTeam/seesaw-kit seesaw-kit] | ;[https://github.com/ArchiveTeam/warrior-code2 warrior2]''' - warrior runner code | ||
:Main code that runs inside of the docker container | |||
;[https://github.com/ArchiveTeam/seesaw-kit seesaw-kit]''' | |||
: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. | :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. | ||
Line 15: | Line 21: | ||
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 == | ||
Line 20: | Line 28: | ||
Server code includes code that the [[Tracker]] executes. | Server code includes code that the [[Tracker]] executes. | ||
[https://github.com/ArchiveTeam/universal-tracker universal-tracker] | '''[https://github.com/ArchiveTeam/universal-tracker universal-tracker]''' - Ruby | ||
:The server of which the Seesaw contacts | :The server of which the Seesaw contacts | ||
[https://github.com/ArchiveTeam/warrior-hq warrior-hq] | '''[https://github.com/ArchiveTeam/warrior-hq warrior-hq]''' - Ruby | ||
:The server of which the warrior appliances contact for project metadata | :The server of which the warrior appliances contact for project metadata | ||
[https://github.com/ArchiveTeam/archiveteam-megawarc-factory archiveteam-megawarc-factory] | '''[https://github.com/ArchiveTeam/archiveteam-megawarc-factory archiveteam-megawarc-factory]''' - shell | ||
:The scripts that bundles the [[The WARC Ecosystem|WARC files]]. | :The scripts that bundles the [[The WARC Ecosystem|WARC files]]. | ||
Line 31: | Line 39: | ||
URLTeam code is independent from the tracker and warrior. | URLTeam code is independent from the tracker and warrior. | ||
[https://github.com/ArchiveTeam/tinyback tinyback] | Old: | ||
'''[https://github.com/ArchiveTeam/tinyback tinyback]''' | |||
: The client code that scrapes the shortlinks. It includes a pipeline shim to run the code. | : The client code that scrapes the shortlinks. It includes a pipeline shim to run the code. | ||
[https://github.com/ArchiveTeam/tinyarchive tinyarchive] | '''[https://github.com/ArchiveTeam/tinyarchive tinyarchive]''' | ||
: The server code for the tracker. | : The server code for the tracker. | ||
New: | |||
'''[https://github.com/ArchiveTeam/terroroftinytown-client-grab terroroftinytown-client-grab]''' | |||
: A pipeline shim to run the code. | |||
'''[https://github.com/ArchiveTeam/terroroftinytown terroroftinytown]''' | |||
: The code for both the client library and tracker. | |||
== Misc == | == Misc == | ||
[https://github.com/ArchiveTeam/warrior-dockerfile warrior-dockerfile] | '''[https://github.com/ArchiveTeam/warrior-dockerfile warrior-dockerfile]''' | ||
:Dockerfile that runs the warrior inside a Docker container. | :Dockerfile that runs the warrior inside a Docker container. | ||
[https://github.com/ArchiveTeam/ArchiveBot ArchiveBot] | '''[https://github.com/ArchiveTeam/ArchiveBot ArchiveBot]''' - Ruby, Python, Lua | ||
:An IRC bot for archiving websites. | :An IRC bot for archiving websites. | ||
[https://github.com/ArchiveTeam/wget-lua wget-lua] | '''[https://github.com/ArchiveTeam/wget-lua wget-lua]''' - C, Lua | ||
:A patched version of Wget for web crawling. | :A patched version of Wget for web crawling. | ||
'''[https://github.com/ArchiveTeam/standalone-readme-template standalone-readme-template]''' - Markdown | |||
:A template for readme files included in grab repositories. | |||
'''[https://github.com/ArchiveTeam/archiveteam-dev-env archiveteam-dev-env]''' - Shell | |||
:Ubuntu preseed for a developer environment for ArchiveTeam projects. | |||
'''[https://github.com/ArchiveTeam/wpull wpull]''' - Python | |||
:A Wget-compatible web downloader/crawler. | |||
{{devnav}} | {{devnav}} | ||
{{Navigation box}} |
Latest revision as of 23:02, 2 May 2019
Fork me on GitHub! File and triage issues, fix bugs, refactor code, submit pull requests… all welcome! Discussion in #archiveteam-dev (on hackint).
The warrior uses the following repos:
Client code
Client code includes code that the Warrior executes.
- warrior3 - bootstrap and tools to build the image
- Bootstrap code that is pulled from GitHub by the appliance and starts a docker container
- archiveteam/warrior-dockerfile - the container
- Instructions to boostrap the docker container
- warrior2 - warrior runner code
- Main code that runs inside of the docker container
- seesaw-kit
- 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:
- The client code that scrapes the shortlinks. It includes a pipeline shim to run the code.
- The server code for the tracker.
New:
- A pipeline shim to run the code.
- The code for both the client library and tracker.
Misc
- 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.
wpull - Python
- A Wget-compatible web downloader/crawler.