tree: 0c2373dbeba0edcd3f1ba2760d9fd6e649f10f22 [path history] [tgz]
  1. README.md
  2. app-environment.md
  3. arch.md
  4. client-config.md
  5. compare.md
  6. environment-vars.md
  7. example-blobs/
  8. geocoding.md
  9. json-signing/
  10. overview.md
  11. overview.txt
  12. principles.md
  13. prior-art.md
  14. protocol/
  15. publishing/
  16. release.txt
  17. release/
  18. schema/
  19. search-ui.md
  20. server-config.md
  21. sharing.md
  22. status.md
  23. storage-examples.md
  24. terms.md
  25. todo/
  26. uses.md
  27. web-ui-styleguide.md
doc/README.md

Documentation

  • Overview: The original motivation and background for why Perkeep exists and what one might use it for.
  • Compare: how Perkeep compares to similar services and software

For Users

If you're just looking to set up a Perkeep server and use it yourself, check out our getting started guide. The documents below go into more detail on customizing the high level configuration for use such as alternative blob storage or synchronization to cloud storage.

For Developers

If you want to help the development of Perkeep or just want to know more about the how and why behind Perkeep, these docs are going to help you get started. Something we didn‘t cover here that you’re interested in? Ask on the mailing list.

Concepts

Technical Docs

Presentations

Video tutorials