Archivy Roadmap

[Uzay-G]

These are features we're exploring for the release of Archivy 1.0:

• Frontend UI for editing
• Expand data store so users can highlight / annotate content with a nice experience even on mobile
• Login modules so users can access and edit from a remote server
• pdf import + epub

What do you think are important focuses for Archivy that could be interesting to develop? Please share!

[HarshaVardhanJ]

Login could be handled by either Apache or Nginx as a frontend proxy for authentication. I think it is better to delegate authentication to a web server which will act as a proxy. In any case, when Archivy is deployed as a container, there's generally a proxy deployed for authentication. Thoughts?

EDIT:

Just realised that the authentication feature is linked to #19 and #65. The aforementioned suggestion is now moot.

[HarshaVardhanJ]

@Uzay-G @srevinsaju @clemux Regarding Docker images, how many versions of Archivy do you think should be maintained? Right now, I'm maintaining only the most recent version. I'm guessing once the application reaches a certain level of stability and maturity in terms of feature set, we could provide images of the last 3 or 4 stable versions. Thoughts?

[srevinsaju]

I would like to have this, and considering other open source docker images, they maintain:

• archivy:latest : latest stable release
• archivy:beta: latest pre release
• archivy:continuous: upto date with master (can use Continuous Integration to automatically create docker images and publish them)
• archivy:*.* Fixed tag. Once released, no more changes should be made to the existing tag

[HarshaVardhanJ]

That looks good. We could tag the images based on semantic versioning. How many major releases do we maintain?

[nandantumu]

Sometimes webpage formatting can have an impact on the way the content looks. Maybe a more robust webpage capture could be on the roadmap? Something like this: HTTrack

[Uzay-G]

Hmm definitely something to look into. I'd like to find a tradeoff between simplicity and speed and the quality of the formatting.

[Uzay-G]

Roadmap for future versions

This is only a draft, and ideas or suggestions are welcome.

v2.0

• Image Upload
• More lightweight and simple search alternative Look for full-text search engine that is easier to setup than Elasticsearch #13
• Security Improvements:
  • Rate limiting
  • Think about password validation
  • Email recovery
• More full-featured distribution methods (mobile, desktop, etc...)
• Develop archival process Brainstorm webpage archival #169 possibility to add scraper plugins #198
• Possible improvements on customization, for example related to the UI
• Polish web interface for CLI
• Add to tag functionality Improve tag functionality #168
• Highlighting / annotations Annotations  #97
• More customization of settings, for example whether or not non-logged in users can access content.

v3.0

• Federation
• Provide standalone binary releases (no python needed) to make server deployment easy
• Encrypted share link (expires within n days, password-protected, link only shares)
• Multi-User
• SMTP / IMAP support, verify users by email address, invite users by email address, invite by link.

[dstar4138]

Minor suggestion for the v3.0 milestones; you may be able to leverage something like Authelia?

[Uzay-G]

It looks nice, but would probably be too big of a dependency / setup for self-hosting archivy.

[mrmaxguns]

Image uploads would be an awesome feature 👍 Editing tags would be awesome; so would the ability to internally link between the files.

[mrmaxguns]

I bodged together a short shell script to deal with images and to run archivy locally, while image uploads aren't implemented:

set -m
echo Starting Elasticsearch
sudo service elasticsearch start
# sudo service elasticsearch status
echo Running archivy and python image server
archivy run & python3 -m http.server --directory /home/maxim/ArchivyImageContent 5050 && fg
echo Exit

(Assuming all images are at ArchivyImageContent)

[Uzay-G]

Ok internal links and a search engine alternative are implemented in the last release :).

Image upload would definitely be nice 🤔

[Uzay-G]

@mrmaxguns I wrote some code to get image upload working, could you maybe test it out 😄. You can clone the branch from this PR -> #224.

That'd be really awesome, and if everything works I'll go ahead and merge it + make a new release :)

[mrmaxguns]

@Uzay-G Yes, I am willing to test it out. I'll comment on the PR after testing it out.

[Uzay-G]

Perfect! Thanks :)

[Uzay-G]

Image upload, links between notes, and embedded tags inside notes, of the form: "I love #archivy#", are now all in Archivy core.

[andrewchenshx]

1)Section Editing: allows editing of small parts of a page
2)Automatic table of contents generation
thanks 👍

[Uzay-G]

What do you mean by automatic table of contents generation? doesn't archivy also do that?

How would you want the section editing to work?

[andrewchenshx]

What do you mean by automatic table of contents generation? doesn't archivy also do that?

better make the toc box float at the top right corner of the content(even when the user scroll down the lengthy page). This allows users to have a quick look at the page structure and quickly jump to the part of the page they want.

How would you want the section editing to work?

Each headline (usually only the first 3 levels) starts a new section. When a page is writable a small Edit button appears at the end of the section. Using this button loads only this section into the editor.
cheers :)

[Uzay-G]

Big goals:

• improve ease of use (mobile? desktop app? hosted service?)
• improve ripgrep search
• implement automatic mechanisms for discovery (cf Espial)
• federation?
• UI plugins

[Uzay-G]

@andrewchenshx I haven't forgotten you! My specialty just isn't UI stuff but I need to get to it.