From 6e5354c280bd9d467098fd69f6c1271d4061a523 Mon Sep 17 00:00:00 2001 From: Nick Sweeting Date: Mon, 31 Dec 2018 20:24:37 -0500 Subject: [PATCH] Updated Configuration (markdown) --- Configuration.md | 33 ++++++++++++++++++++------------- 1 file changed, 20 insertions(+), 13 deletions(-) diff --git a/Configuration.md b/Configuration.md index 539af98..413aef1 100644 --- a/Configuration.md +++ b/Configuration.md @@ -9,18 +9,6 @@ Example configuration using `env` command: env CHROME_BINARY=google-chrome-stable RESOLUTION=1440,900 FETCH_PDF=False ./archive ~/Downloads/bookmarks_export.html ``` -One way to have persistent config is to create a `~/.ArchiveBox.conf` file, and put your options inside it like so: - -```bash -CHROME_BINARY=google-chrome-stable -RESOLUTION=1440,900 -FETCH_PDF=False -``` - -Then source it when you run the archive script: - -```bash -export $(grep -v '^#' ~/.ArchiveBox.conf | xargs); ./archive https://example.com/rss/feed.xml --- ## Environment Variables @@ -55,4 +43,23 @@ export $(grep -v '^#' ~/.ArchiveBox.conf | xargs); ./archive https://example.com To tweak the outputted html index file's look and feel, just edit the HTML files in `archiver/templates/`. -The chrome/chromium dependency is _optional_ and only required for screenshots, PDF, and DOM dump output, it can be safely ignored if those three methods are disabled. \ No newline at end of file +The chrome/chromium dependency is _optional_ and only required for screenshots, PDF, and DOM dump output, it can be safely ignored if those three methods are disabled. + +## Creating a Config File + + +One way to have persistent config is to create a `~/.ArchiveBox.conf` file, and put your options inside it like so: + +```bash +CHROME_BINARY=google-chrome-stable +RESOLUTION=1440,900 +FETCH_PDF=False +``` + +Then source it when you run the archive script: + +```bash +export $(grep -v '^#' ~/.ArchiveBox.conf | xargs); ./archive https://example.com/rss/feed.xml +``` + +Improving this process is on the roadmap, in future versions you'll be able to pass a config file directly to the archive command. \ No newline at end of file