Skip to content

Documentation: incorrect info and inconsistent info #1786

@nahdoubtit

Description

@nahdoubtit

What is the URL of the page you'd like to see improved?

https://github.com/ArchiveBox/ArchiveBox/blob/dev/README.md and https://github.com/ArchiveBox/ArchiveBox/wiki/Configuration

What is the title of the relevant section?

readme.md "Install ArchiveBox using your preferred method:" , comments on top of docker-compose.yml, and https://github.com/ArchiveBox/ArchiveBox/wiki/Configuration#archivedotorg_enabled

What is the suggested edit?

In configuration page it says to use: ARCHIVEDOTORG_ENABLED=[True/False], however that does not work with "docker compose run archivebox config --set" it gives the error [X] These options failed to set (check for typos): ARCHIVEDOTORG_ENABLED=False and manually editing ArchiveBox.conf it still submits the archive to archive dot org. I used archivebox awhile ago and swore that used to be SAVE_ARCHIVE_DOT_ORG, and sure enough, that works.

On the main readme.md for the repo for docker compose and the docker-compose.yml file itself, it says to setup use docker compose run archivebox init --install but then when you run it, usage: archivebox init [-h] [--force] [--quick] [--setup] archivebox init: error: unrecognized arguments: --install it fails and shows it's --setup, which is shown for the regular docker non compose instructions.

There might be more elsewhere but I've noticed that trying to debug my installation.

Metadata

Metadata

Assignees

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions