{"id":15459048,"url":"https://github.com/arkanosis/arkbot-rs","last_synced_at":"2025-04-22T10:42:40.415Z","repository":{"id":57493677,"uuid":"324678887","full_name":"Arkanosis/arkbot-rs","owner":"Arkanosis","description":"A Rust rewrite (and redesign) of Arkanosis' Wikipedia bot","archived":false,"fork":false,"pushed_at":"2024-09-02T22:21:38.000Z","size":126,"stargazers_count":3,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-15T16:03:00.967Z","etag":null,"topics":["bot","wikimedia","wikipedia"],"latest_commit_sha":null,"homepage":"https://fr.wikipedia.org/wiki/Utilisateur:Arkbot","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"isc","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Arkanosis.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-12-27T03:26:37.000Z","updated_at":"2024-10-26T10:41:20.000Z","dependencies_parsed_at":"2022-08-30T02:12:14.405Z","dependency_job_id":null,"html_url":"https://github.com/Arkanosis/arkbot-rs","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Arkanosis%2Farkbot-rs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Arkanosis%2Farkbot-rs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Arkanosis%2Farkbot-rs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Arkanosis%2Farkbot-rs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Arkanosis","download_url":"https://codeload.github.com/Arkanosis/arkbot-rs/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249259146,"owners_count":21239422,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bot","wikimedia","wikipedia"],"created_at":"2024-10-01T23:04:19.297Z","updated_at":"2025-04-16T16:31:43.249Z","avatar_url":"https://github.com/Arkanosis.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"# arkbot-rs [![](https://img.shields.io/crates/v/arkbot.svg)](https://crates.io/crates/arkbot) [![License](https://img.shields.io/badge/license-ISC-blue.svg)](/LICENSE) [![Build status](https://travis-ci.org/Arkanosis/arkbot-rs.svg?branch=master)](https://travis-ci.org/Arkanosis/arkbot-rs)\n\n**arkbot-rs** is Rust rewrite (and complete redesign) of Arkanosis' Wikipedia bot.\n\nThe original Arkbot is made of a mix of Python, sed, awk and wget, glued together with some zsh, which has done the job for more than ten years now, but has never been really efficient.\n\narkbot-rs is designed from the start to address Arkbot's shortcomings, including:\n - performance,\n - need for manual intervention.\n\nThe goal is to have Arkbot running on a small server or VM (eg. on Toolforge) and performing its tasks on its own without any human intervention.\n\n## Usage\n\n```\nUsage: arkbot\n       arkbot -h | --help\n       arkbot --version\n\nOptions:\n    -h, --help               Show this screen.\n    --version                Show version.\n```\n\n## Compiling\n\nRun `cargo build --release` in your working copy.\n\n## Installing\n\nRun `sudo cp target/release/arkbot /usr/bin/arkbot` in your working copy.\n\n## Configuring\n\nCreate `~/.config/arkbot/config.toml` with the following content:\n\n```toml\nlogin = '$BOT_NAME'\npassword = '$BOT_PASSWORD'\nserver_url = 'https://fr.wikipedia.org'\nscript_path = '/w'\noutput_directory = '/tmp/.arkbot-data'\n```\n\nAnd replace `$BOT_NAME` with your bot account name and `$BOT_PASSWORD` with your bot account password.\nPlease use a [bot password](https://www.mediawiki.org/wiki/Manual:Bot_passwords) created for arkbot-rs, and not the actual account password.\n\nThe `output_directory` will be created, but it's not used anymore and may disapear in a future version.\n\n## Enabling as a systemd service, run hourly\n\n```console\nsystemctl --user link systemd/arkbot.service systemd/arkbot.timer\nsystemctl --user daemon-reload\nsystemctl --user enable --now arkbot.timer\n```\n\nArkbot will then check every hour if there is a new dump available.\nIf there is one, it will download it and update the pages on the target wiki.\n\nWarning: as of now, the target pages are hardcoded, which makes arkbot-rs only suitable for the French Wikpedia.\n\n## Monitoring\n\nYou can check when arkbot-rs history using `systemctl --user --list-timer`.\n\nYou can read arkbot-rs logs using `journalctl --user -u arkbot -f`.\n\n## Contributing and reporting bugs\n\nContributions are welcome through [GitHub pull requests](https://github.com/Arkanosis/arkbot-rs/pulls).\n\nPlease report bugs and feature requests on [GitHub issues](https://github.com/Arkanosis/arkbot-rs/issues).\n\n## License\n\narkbot-rs is copyright (C) 2020-2023 Jérémie Roquet \u003cjroquet@arkanosis.net\u003e and\nlicensed under the ISC license.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Farkanosis%2Farkbot-rs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Farkanosis%2Farkbot-rs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Farkanosis%2Farkbot-rs/lists"}