{"id":13653816,"url":"https://github.com/dbeley/archiveboxmatic","last_synced_at":"2025-04-29T13:31:45.233Z","repository":{"id":98541924,"uuid":"289513546","full_name":"dbeley/archiveboxmatic","owner":"dbeley","description":"ArchiveBoxMatic: configure ArchiveBox with the simplicity of a yaml file.","archived":false,"fork":false,"pushed_at":"2021-03-10T14:49:53.000Z","size":59,"stargazers_count":13,"open_issues_count":0,"forks_count":3,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-08-03T02:10:26.472Z","etag":null,"topics":["archivebox","archiving","web-archiving"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/dbeley.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2020-08-22T15:21:39.000Z","updated_at":"2024-07-30T16:14:27.000Z","dependencies_parsed_at":"2023-05-29T11:00:12.948Z","dependency_job_id":null,"html_url":"https://github.com/dbeley/archiveboxmatic","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dbeley%2Farchiveboxmatic","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dbeley%2Farchiveboxmatic/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dbeley%2Farchiveboxmatic/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dbeley%2Farchiveboxmatic/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dbeley","download_url":"https://codeload.github.com/dbeley/archiveboxmatic/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223913441,"owners_count":17224186,"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":["archivebox","archiving","web-archiving"],"created_at":"2024-08-02T02:01:18.354Z","updated_at":"2024-11-10T04:31:13.849Z","avatar_url":"https://github.com/dbeley.png","language":"Python","funding_links":[],"categories":["Python"],"sub_categories":[],"readme":"# ArchiveBoxMatic\n\n**Work in progress. Don't expect every features to work.**\n\nArchiveBoxMatic lets you configure ArchiveBox archives in a yaml file.\n\n## Installation\n\n```\ngit clone https://github.com/dbeley/archiveboxmatic\ncd archiveboxmatic\npython install setup.py\n```\n\nYou can also use pipenv to install your virtual environment\n\n```\ngit clone https://github.com/dbeley/archiveboxmatic\ncd archiveboxmatic\npipenv install '-e .'\n```\n\n### ArchiveBox installation\n\n#### Docker install (recommended)\n\nFor an archivebox data folder named data and placed in the repo folder, create a file named `.env` containing this content\n```\nDATA_FOLDER=~/data_folder\n```\n\nYou can then initiate an archivebox archive with the following commands\n\n```\ndocker-compose pull archivebox\ndocker-compose run archivebox init\ndocker-compose run archivebox manage createsuperuser\ndocker-compose up -d\n```\n\nUse `docker-compose` method in your config file.\n\n#### Python install\n\n```\npip install archivebox\nmkdir data\ncd data\narchivebox init\narchivebox manage createsuperuser\ncd ..\n```\n\nUse `python` method in your config file.\n\n## Configuration\n\nSee [`config.example.yaml`](https://github.com/dbeley/archiveboxmatic/blob/master/config.example.yaml) for a default config file. By default, archiveboxmatic will search for a config.yaml file in the directory from where it has been launched.\n\n## Usage\n\n```\nusage: archiveboxmatic [-h] [--debug] [-c CONFIG_FILE] [-s SCHEDULE]\n                       [--dry-run]\n\nArchiveBoxMatic: configure ArchiveBox with the simplicity of a yaml file.\n\noptional arguments:\n  -h, --help            show this help message and exit\n  --debug               Display debugging information.\n  -c CONFIG_FILE, --config_file CONFIG_FILE\n                        Config file (default: ./config.yaml).\n  -s SCHEDULE, --schedule SCHEDULE\n                        Only run scheduled tasks for a specific timeframe\n                        (Choices: daily, weekly, monthly, yearly, all.\n                        Default: all).\n  --dry-run             Run the script without starting the archive process.\n                        Can be used to validate the config file.\n```\n\n## Schedule\n\nYou can automatically run archiveboxmatic with the provided systemd service file.\n\nYou will have to change the WorkingDirectory option in the systemd file to the directory containing archiveboxmatic.\n\n```\ncp systemd-service/* ~/.config/systemd/user\nsystemctl --user daemon-reload\nsystemctl --user enable --now archiveboxmatic\nsystemctl --user status archiveboxmatic\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdbeley%2Farchiveboxmatic","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdbeley%2Farchiveboxmatic","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdbeley%2Farchiveboxmatic/lists"}