https://github.com/capjamesg/indieweb-etherpad-archiver
Perl tool for archiving Etherpad links to the IndieWeb wiki.
https://github.com/capjamesg/indieweb-etherpad-archiver
archiving bot etherpad irc
Last synced: 8 months ago
JSON representation
Perl tool for archiving Etherpad links to the IndieWeb wiki.
- Host: GitHub
- URL: https://github.com/capjamesg/indieweb-etherpad-archiver
- Owner: capjamesg
- License: mit-0
- Created: 2022-08-05T11:04:37.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2025-10-03T19:16:37.000Z (8 months ago)
- Last Synced: 2025-10-03T21:19:26.717Z (8 months ago)
- Topics: archiving, bot, etherpad, irc
- Language: Perl
- Homepage:
- Size: 43 KB
- Stars: 2
- Watchers: 3
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# IndieWeb Etherpad Archiver (Cali)
A tool that accepts an [IndieWeb Events](https://events.indieweb.org) page and archives the associated Etherpad page to the [IndieWeb wiki](https://indieweb.org).
## 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 - Archive an events.indieweb.org page, save to example/page
!archive - 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 0 license](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