mirror of https://github.com/perkeep/perkeep.git
3.8 KiB
3.8 KiB
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
- Configuring Geocoding: how to enable geocoding (the
loc:search operator) - Files or Permanodes: explains the basic difference between a file and a permanode
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
- Principles: our base principles, goals, assumptions
- Terminology: let's agree on terms to stay sane
- Use Cases: what one might do with all this (or at least our aspirations)
- Prior Art: other projects with similar goals or strategies
- Contributing: how to help
- Style guide for the Web UI
Technical Docs
- Packages: internal API documentation
- Architecture: the pieces, layers, and how they interact
- Schema: how we model data in Perkeep
- Protocol: HTTP APIs (discovery, blob storage, JSON signing, ...)
- JSON Signing
- Sharing
Presentations
- 2018-04, LinuxFest Northwest: [slides] [video]
- 2016-04, GDG Seattle: [slides] [video]
- 2016-04, LinuxFest Northwest: [slides] [video]
- 2015-02, FOSDEM: [slides] [video]
- 2014-02, FOSDEM: [slides] [video] [WebM]
- 2013-06, Google Developers Live: [video]
- 2011-05, São Paolo Perl Conference: [slides]
- 2011-02, First Introduction: [slides]