mirror/archivebox
1
0
Fork 0
mirror of https://github.com/pirate/ArchiveBox.git synced 2025-08-17 03:54:08 +02:00
Code Issues Releases Wiki Activity

Updated Configuration (markdown)

Nick Sweeting
2024-02-18 05:51:32 -08:00
parent cd29a40521
commit c495898948
1 changed files with 15 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
Configuration.md

@@ -143,11 +143,25 @@ https://github.com/ArchiveBox/ArchiveBox#-web-ui-usage
---
#### `CUSTOM_TEMPLATES_DIR`
**Possible Values:** [`None`]/`./path/to/custom_templates`/...
**Possible Values:** [`None`]/`/path/to/custom_templates`/...
Path to a directory containing custom html/css/images for overriding the default UI styling. Files found in the folder at the specified path can override any of the defaults in the [`TEMPLATES_DIR`](https://github.com/ArchiveBox/ArchiveBox/tree/dev/archivebox/templates) directory (copy files from that default dir into your custom dir to get started making a custom theme).
If you've used `django` before, this works exactly the same way that `django` template overrides work (because it uses `django` under the hood).
```bash
$ pip show -f archivebox | grep Location: | awk '{print $2}'
/opt/homebrew/lib/python3.11/site-packages
$ pip show -f archivebox | grep archivebox/templates
archivebox/templates/admin/app_index.html
archivebox/templates/admin/base.html
archivebox/templates/admin/login.html
...
# copy default templates into a directory somewhere, edit as needed, then point archivebox to it
$ cp -r /opt/homebrew/lib/python3.11/site-packages/archivebox/templates ~/archivebox/custom_templates
$ archivebox config --set CUSTOM_TEMPLATES_DIR=~/archivebox/custom_templates
```
*Related options:*
[`FOOTER_INFO`](#footer_info)