Skip to content

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.
  • Bidirectional links between notes.
  • Login module that allows you to host the service on a server
  • Plugin system to allow people to publish and write extensions to archivy
  • Git integration
  • Everything is a file! For ease of access and editing, all the content is stored in extended markdown files with yaml front matter. This format supports footnotes, LaTeX math rendering, syntax highlighting and more.
  • Powerful and advanced search.
  • Backend API for flexibility and user enhancements.
  • Image upload

Roadmap

Upcoming:

  • 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 docs for information on other installation methods.

Community

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

To get news and updates on Archivy and its development, you can watch the archivy repository or follow @uzpg_ on Twitter.

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

If you'd like to support the project and its development, you can also sponsor the Archivy maintainer.

License

This project is licensed under the MIT License. See LICENSE for more information. The Archivy Logo is designed by Roy Quilor, licensed under CC BY-NC 4.0

Changelog