zxhycxq / archivy

Archivy is a self-hosted knowledge repository that allows you to safely preserve useful content that contributes to your own personal, searchable and extendable wiki.

Home Page:https://archivy.github.io

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

logo

Archivy

Archivy is a self-hosted knowledge repository that allows you to safely preserve useful content that contributes to your own personal, searchable and extensible wiki.

Features:

  • If you add bookmarks, their web-pages contents' will be saved to ensure that you will always have access to it, following the idea of digital preservation.
  • Login module that allows you to host the service on a server
  • Plugin system to allow people to publish and write extensions to archivy
  • Notes are stored in an extended markdown format with footnotes, LaTeX math rendering, syntax highlighting and more.
  • CLI that provides a nice backend interface to the app
  • Git integration
  • Backend API for flexibility and user enhancements
  • Everything is a file! For ease of access and editing, all the content is stored in markdown files with yaml front matter.
  • Extensible search with Elasticsearch and its Query DSL
  • Dark Theme

demo video

Roadmap

Upcoming:

  • Links / tagging between different knowledge base items
  • Image Upload
  • Annotations
  • Multi User System with permission setup.

Quickstart

Install archivy with pip install archivy. Other installations methods are listed here

Then run this and enter a password to create a new user:

$ archivy create-admin <username>

Finally, execute archivy run to serve the app. You can open it at https://localhost:5000 and login with the credentials you entered before.

You can then use archivy to create notes, bookmarks and then organize and store information.

See the official docs for information on other installation methods.

Community

Archivy is dedicated at building open and quality knowledge base software through collaboration and community discussion.

You can interact with us through the issue board and the more casual discord server.

About

Archivy is a self-hosted knowledge repository that allows you to safely preserve useful content that contributes to your own personal, searchable and extendable wiki.

https://archivy.github.io

License:MIT License


Languages

Language:Python 72.0%Language:HTML 14.8%Language:CSS 13.2%