Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature Request: Add/upload attachments and notes to snapshot #1096

Open
3 of 7 tasks
Jwink3101 opened this issue Feb 10, 2023 · 2 comments
Open
3 of 7 tasks

Feature Request: Add/upload attachments and notes to snapshot #1096

Jwink3101 opened this issue Feb 10, 2023 · 2 comments
Labels
expected: maybe someday help wanted size: easy touches: API/CLI/user interface touches: js Pull requests that update Javascript code type: enhancement why: functionality Intended to improve ArchiveBox functionality or features

Comments

@Jwink3101
Copy link

Type

  • General question or discussion
  • Propose a brand new feature
  • Request modification of existing behavior or design

What is the problem that your feature request solves

Sometimes there is additional media that I capture manually or I want to add some note to remember why I saved it.

For example, I archived a NYTimes Podcast page but it didn't pick up the transcript. So I saved it manually. I would like to be able to attach that.

Describe the ideal specific solution you'd want, and whether it fits into any broader scope of changes

Ideally, I would be able to have an editable note box and the ability to add attachments. Maybe have it be markdown and a way to link or reference it too

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

I can upload anything into the archive/ but it requires figuring out which one it is and then future discoverability is majorly impacted

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

(probably somewhere between the bottom two

  • [(probably)] I'm willing to contribute dev time / money to fix this issue
  • I like ArchiveBox so far / would recommend it to a friend
  • [(some)] I've had a lot of difficulty getting ArchiveBox set up

I am pretty proficient in Python but short on time. I will poke around a bit and see what it may take.

@pirate
Copy link
Member

pirate commented Feb 10, 2023

You can technically already do most of this, if you go to the Log page in the UI you can manually add a new ArchiveResult with [Add Archive Result +] and attach it to a Snapshot to track arbitrary attachments/notes.

The ArchiveResult.output field can point to any file you want within the snapshot directory, it can be a custom attachment or text file with notes.

So you can upload any files you want into the snapshot data dir (you can figure out which dir by seeing the timestamp for the snapshot in the URL/admin UI), and as long as there in an ArchiveResult pointed to the files they will remain tracked by ArchiveBox.

It's not an ideal UX / not as easy as just adding notes in a UI, but it's more resilient long-term as the db doesn't become a single point of failure where your notes can get lost.

Screenshot 2023-02-10 at 2 03 56 PM

image

@Jwink3101
Copy link
Author

That makes sense though I think it is very much along the lines of "What hacks or alternative solutions have you tried to solve the problem?".

I do like the idea of not relying on the database. Even if I could, through the web, upload an immutable note, that would go a long way.

@pirate pirate added why: functionality Intended to improve ArchiveBox functionality or features size: easy help wanted touches: API/CLI/user interface type: enhancement touches: js Pull requests that update Javascript code expected: maybe someday labels Feb 11, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
expected: maybe someday help wanted size: easy touches: API/CLI/user interface touches: js Pull requests that update Javascript code type: enhancement why: functionality Intended to improve ArchiveBox functionality or features
Projects
None yet
Development

No branches or pull requests

2 participants