tree: f6f66bc5474b0a19430b91f6ee5a2be78284cccc [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. json-signing/
  9. overview.md
  10. overview.txt
  11. principles.md
  12. prior-art.md
  13. protocol/
  14. publishing/
  15. release.txt
  16. release/
  17. schema/
  18. search-ui.md
  19. server-config.md
  20. sharing.md
  21. status.md
  22. storage-examples.md
  23. terms.md
  24. todo/
  25. uses.md
  26. 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.

  • Command-line tools
  • Server Config: Details for configuring server storage and access, including synchronization to other Perkeep servers or backup to cloud storage providers
  • Client config: Clients need this configuration file to securely connect to your Perkeep server(s)
  • Search Commands: Covers the available search operators

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