Skip to content

capjamesg/indieweb-etherpad-archiver

main
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 

IndieWeb Etherpad Archiver (Cali)

A tool that accepts an IndieWeb Events page and archives the associated Etherpad page to the IndieWeb wiki.

IRC Usage

This tool provides an interface over IRC through which an Etherpad page linked to an IndieWeb events page can be archived.

To archive a document using the bot, you can use the following command in the IRC channel to which the archiver is connected:

!archive <events_page_url> <example/page> - Archive an events.indieweb.org page, save to example/page
!archive <etherpad_url> <example/page> - Archive an etherpad.indieweb.org page, save to example/page
!archive help - Show help

Getting Started

To use this project, first install the required dependencies:

- Mojo::DOM
- Bot::BasicBot
- LWP::UserAgent

Next, register a bot account on the MediaWiki to which you want to save archives. This will give you the credentials you need for the next step. Take note of the bot username and password MediaWiki provides.

Once you have your bot account credentials, create a .env file and add the following values:

LGNAME=MEDIAWIKI_LOGIN_NAME
LGPASS=MEDIAWIKI_LOGIN_PASSWORD
WIKI_URL=LINK_TO_MEDIAWIKI_API
IRC_CHANNEL=IRC_CHANNEL_NAME
IRC_SERVER=IRC_SERVER_NAME
IRC_PORT=IRC_SERVER_PORT
IRC_NICK=IRC_NICK_NAME

All of these values are required.

Next, run the archiver script:

chmod +x archiver.pl
./archiver.pl

The archiver script will connect to the provided IRC channel and expose the !archive command for use in the chat.

Technology

This project was built using Perl.

License

This project is licensed under an MIT license.

Contributing

Have an idea on how to improve the archiver? Feel free to open an issue or pull request in this repository.

Contributors

  • capjamesg

About

Perl tool for archiving Etherpad links to the IndieWeb wiki.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages