starred/ArchiveBox

Fork 0

mirror of https://github.com/ArchiveBox/ArchiveBox.git synced 2026-04-25 17:16:00 +03:00

[GH-ISSUE #1634] Feature Request: Add description field to metadata #2486

New issue

Closed

opened 2026-03-01 17:59:23 +03:00 by kerem · 2 comments

kerem commented

2026-03-01 17:59:23 +03:00

Owner

Originally created by @NSBum on GitHub (Jan 15, 2025).
Original GitHub issue: https://github.com/ArchiveBox/ArchiveBox/issues/1634

Originally assigned to: @pirate on GitHub.

What type of suggestion are you making?

Proposing a new feature

What is the problem that your feature request solves?

When hundreds or thousands of snapshots have been accumulated, it may difficult to find the precise content that you are looking for in language that you would uniquely use to describe it.

What is your proposed solution?

I would recommend the simple addition of a description field in the metadata so that users could add their own searchable description.

What hacks or alternative solutions have you tried to solve the problem?

Right now I use tagging which helps but is not exactly the same as describing an object in memorable language.

Share the entire output of the `archivebox version` command for the current verison you are using.

0.7.2
ArchiveBox v0.7.2 BUILD_TIME=2025-01-15 04:21:16 1736932876
IN_DOCKER=False IN_QEMU=False ARCH=x86_64 OS=Linux PLATFORM=Linux-6.1.0-28-amd64-x86_64-with-glibc2.36 PYTHON=Cpython
FS_ATOMIC=True FS_REMOTE=False FS_USER=1000:1000 FS_PERMS=644
DEBUG=False IS_TTY=True TZ=UTC SEARCH_BACKEND=ripgrep LDAP=False

[i] Dependency versions:
 √  PYTHON_BINARY         v3.11.2         valid     /home/alan/.pyenv/versions/3.11.2/bin/python3.11
 √  SQLITE_BINARY         v2.6.0          valid     /home/alan/.pyenv/versions/3.11.2/lib/python3.11/sqlite3/dbapi2.py
 √  DJANGO_BINARY         v3.1.14         valid     /home/alan/.pyenv/versions/3.11.2/envs/archivebox-3.11.2/lib/python3.11/site-packages/django/__init__.py
 √  ARCHIVEBOX_BINARY     v0.7.2          valid     /home/alan/.pyenv/versions/3.11.2/envs/archivebox-3.11.2/bin/archivebox

 √  CURL_BINARY           v7.88.1         valid     /usr/bin/curl
 √  WGET_BINARY           v1.21.3         valid     /usr/bin/wget
 √  NODE_BINARY           v18.20.5        valid     /usr/bin/node
 √  SINGLEFILE_BINARY     v1.1.54         valid     /usr/lib/node_modules/single-file-cli/single-file
 √  READABILITY_BINARY    v0.0.6          valid     /usr/lib/node_modules/readability-extractor/readability-extractor
 √  MERCURY_BINARY        v1.0.0          valid     /usr/lib/node_modules/@postlight/parser/cli.js
 √  GIT_BINARY            v2.39.5         valid     /usr/bin/git
 √  YOUTUBEDL_BINARY      v2025.01.12     valid     /home/alan/.pyenv/versions/archivebox-3.11.2/bin/yt-dlp
 √  CHROME_BINARY         v131.0.6778.264  valid     /usr/bin/chromium
 √  RIPGREP_BINARY        v13.0.0         valid     /usr/bin/rg

[i] Source-code locations:
 √  PACKAGE_DIR           23 files        valid     /home/alan/.pyenv/versions/3.11.2/envs/archivebox-3.11.2/lib/python3.11/site-packages/archivebox
 √  TEMPLATES_DIR         3 files         valid     /home/alan/.pyenv/versions/3.11.2/envs/archivebox-3.11.2/lib/python3.11/site-packages/archivebox/templates
 -  CUSTOM_TEMPLATES_DIR  -               disabled  None

[i] Secrets locations:
 -  CHROME_USER_DATA_DIR  -               disabled  None
 -  COOKIES_FILE          -               disabled  None

[i] Data locations:
 √  OUTPUT_DIR            6 files         valid     /home/alan/archivebox/data
 √  SOURCES_DIR           49 files        valid     ./sources
 √  LOGS_DIR              1 files         valid     ./logs
 √  ARCHIVE_DIR           43 files        valid     ./archive
 √  CONFIG_FILE           429.0 Bytes     valid     ./ArchiveBox.conf
 √  SQL_INDEX             628.0 KB        valid     ./index.sqlite3

How badly do you want this new feature?

It's an urgent deal-breaker, I can't live without it
It's important to add it in the near-mid term future
It would be nice to have eventually
I'm willing to start a PR to develop this myself
I have donated money to go towards fixing this issue

Mini Survey

I like ArchiveBox so far / would recommend it to a friend
I've had a lot of difficulty getting ArchiveBox set up
I would pay $10/mo for a hosted version of ArchiveBox if it had this feature

Originally created by @NSBum on GitHub (Jan 15, 2025). Original GitHub issue: https://github.com/ArchiveBox/ArchiveBox/issues/1634 Originally assigned to: @pirate on GitHub. ### What type of suggestion are you making? Proposing a new feature ### What is the problem that your feature request solves? When hundreds or thousands of snapshots have been accumulated, it may difficult to find the precise content that you are looking for in language that you would uniquely use to describe it. ### What is your proposed solution? I would recommend the simple addition of a `description` field in the metadata so that users could add their own searchable description. ### What hacks or alternative solutions have you tried to solve the problem? Right now I use tagging which _helps_ but is not exactly the same as describing an object in memorable language. ### Share the entire output of the `archivebox version` command for the current verison you are using. ```shell 0.7.2 ArchiveBox v0.7.2 BUILD_TIME=2025-01-15 04:21:16 1736932876 IN_DOCKER=False IN_QEMU=False ARCH=x86_64 OS=Linux PLATFORM=Linux-6.1.0-28-amd64-x86_64-with-glibc2.36 PYTHON=Cpython FS_ATOMIC=True FS_REMOTE=False FS_USER=1000:1000 FS_PERMS=644 DEBUG=False IS_TTY=True TZ=UTC SEARCH_BACKEND=ripgrep LDAP=False [i] Dependency versions: √ PYTHON_BINARY v3.11.2 valid /home/alan/.pyenv/versions/3.11.2/bin/python3.11 √ SQLITE_BINARY v2.6.0 valid /home/alan/.pyenv/versions/3.11.2/lib/python3.11/sqlite3/dbapi2.py √ DJANGO_BINARY v3.1.14 valid /home/alan/.pyenv/versions/3.11.2/envs/archivebox-3.11.2/lib/python3.11/site-packages/django/__init__.py √ ARCHIVEBOX_BINARY v0.7.2 valid /home/alan/.pyenv/versions/3.11.2/envs/archivebox-3.11.2/bin/archivebox √ CURL_BINARY v7.88.1 valid /usr/bin/curl √ WGET_BINARY v1.21.3 valid /usr/bin/wget √ NODE_BINARY v18.20.5 valid /usr/bin/node √ SINGLEFILE_BINARY v1.1.54 valid /usr/lib/node_modules/single-file-cli/single-file √ READABILITY_BINARY v0.0.6 valid /usr/lib/node_modules/readability-extractor/readability-extractor √ MERCURY_BINARY v1.0.0 valid /usr/lib/node_modules/@postlight/parser/cli.js √ GIT_BINARY v2.39.5 valid /usr/bin/git √ YOUTUBEDL_BINARY v2025.01.12 valid /home/alan/.pyenv/versions/archivebox-3.11.2/bin/yt-dlp √ CHROME_BINARY v131.0.6778.264 valid /usr/bin/chromium √ RIPGREP_BINARY v13.0.0 valid /usr/bin/rg [i] Source-code locations: √ PACKAGE_DIR 23 files valid /home/alan/.pyenv/versions/3.11.2/envs/archivebox-3.11.2/lib/python3.11/site-packages/archivebox √ TEMPLATES_DIR 3 files valid /home/alan/.pyenv/versions/3.11.2/envs/archivebox-3.11.2/lib/python3.11/site-packages/archivebox/templates - CUSTOM_TEMPLATES_DIR - disabled None [i] Secrets locations: - CHROME_USER_DATA_DIR - disabled None - COOKIES_FILE - disabled None [i] Data locations: √ OUTPUT_DIR 6 files valid /home/alan/archivebox/data √ SOURCES_DIR 49 files valid ./sources √ LOGS_DIR 1 files valid ./logs √ ARCHIVE_DIR 43 files valid ./archive √ CONFIG_FILE 429.0 Bytes valid ./ArchiveBox.conf √ SQL_INDEX 628.0 KB valid ./index.sqlite3 ``` ### How badly do you want this new feature? - [ ] It's an urgent deal-breaker, I can't live without it - [ ] It's important to add it in the near-mid term future - [x] It would be nice to have eventually - [x] I'm willing to [start a PR](https://github.com/ArchiveBox/ArchiveBox#archivebox-development) to develop this myself - [ ] I have [donated money](https://github.com/ArchiveBox/ArchiveBox/wiki/Donations) to go towards fixing this issue ### Mini Survey - [x] I like ArchiveBox so far / would recommend it to a friend - [ ] I've had a lot of difficulty getting ArchiveBox set up - [ ] I would pay $10/mo for a hosted version of ArchiveBox if it had this feature

kerem closed this issue

2026-03-01 17:59:23 +03:00

kerem commented

2026-03-01 17:59:23 +03:00

Author

Owner

@pirate commented on GitHub (Jan 15, 2025):

This is already done in >= v0.8.5 :) I have added an editable notes text field to most models.

@pirate commented on GitHub (Jan 15, 2025): This is already done in >= v0.8.5 :) I have added an editable `notes` text field to most models.

kerem commented

2026-03-01 17:59:23 +03:00

Author

Owner

@NSBum commented on GitHub (Jan 16, 2025):

This is brilliant - thanks. I'll close then - with appreciation.

@NSBum commented on GitHub (Jan 16, 2025): This is brilliant - thanks. I'll close then - with appreciation.

No milestone

No project

No assignees

1 participant

Notifications

Due date

The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference

starred/ArchiveBox#2486

No description provided.

Rows
Columns

[GH-ISSUE #1634] Feature Request: Add description field to metadata #2486

What type of suggestion are you making?

What is the problem that your feature request solves?

What is your proposed solution?

What hacks or alternative solutions have you tried to solve the problem?

Share the entire output of the archivebox version command for the current verison you are using.

How badly do you want this new feature?

Mini Survey

Share the entire output of the `archivebox version` command for the current verison you are using.