diff --git a/Configuration.md b/Configuration.md index 28c1471..18fca9e 100644 --- a/Configuration.md +++ b/Configuration.md @@ -2,12 +2,14 @@ Configuration is done through environment variables. You can pass in settings using all the usual environment variable methods: e.g. by using the `env` command, settings variables in your shell profile, or sourcing a `.env` file before running the command. +You can also modify the defaults in `archivebox/config.py` directly, but that's not recommended as your custom settings will be erased whenever you update ArchiveBox. + Example configuration using `env` command: ```bash env CHROME_BINARY=google-chrome-stable RESOLUTION=1440,900 FETCH_PDF=False ./archive ~/Downloads/bookmarks_export.html ``` -All the available config options are defined in this document below, but can also be found along with examples in [`etc/ArchiveBox.conf.default`](https://github.com/pirate/ArchiveBox/blob/master/etc/ArchiveBox.conf.default). The code that load the config is in [`archivebox/config.py`](https://github.com/pirate/ArchiveBox/blob/master/archivebox/config.py), but don't modify the defaults in `config.py` directly, as your changes there will be erased whenever you update ArchiveBox. +All the available environment variables are defined in [`archivebox/config.py`](https://github.com/pirate/ArchiveBox/blob/master/archivebox/config.py) and [`etc/ArchiveBox.conf.default`](https://github.com/pirate/ArchiveBox/blob/master/etc/ArchiveBox.conf.default). To create a persistent config file, see the [Creating a Config File](#creating-a-config-file) section. @@ -23,7 +25,7 @@ Configuration: ## General Settings -General options around the archiving process, output format, and timing. +*General options around the archiving process, output format, and timing.* --- #### `OUTPUT_DIR` @@ -79,12 +81,12 @@ Some text to display in the footer of the archive index. Useful for providing s ## Archive Method Toggles -High-level on/off switches for all the various methods used to archive URLs. +*High-level on/off switches for all the various methods used to archive URLs.* --- #### `FETCH_TITLE` **Possible Values:** [`True`]/`False` -Fetch the page HTML and attempt to parse the link's title from any `