Skip to content
master
Switch branches/tags
Go to file
Code

Latest commit

* Update contributing doc for info on how to use the dev server
* add confirmation modal before deleting item/folder

Co-authored-by: Dennis Zhang <dennis.zhang.nrg@gmail.com>
430f364

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

README.md

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

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, including Docker.

Run the archivy init command to setup you installation.

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.

Topics

Resources

License

Packages

No packages published