Rooba
/
perkeep
mirror of https://github.com/perkeep/perkeep.git
1
1
Fork 0
Code Issues Packages Projects Releases Wiki Activity
perkeep/doc
History
Mathieu Lonjaret 1008e11420 Merge "doc/synology: update latest tarballs" 2018-12-24 10:45:48 +00:00
..
example-blobs Some example blobs 2011-02-02 13:30:01 -08:00
json-signing website: first pass of s/Camlistore/Perkeep/ on contents 2017-12-18 16:46:08 +01:00
protocol doc: add missing jsondoc.go from e093206a2a 2018-01-02 19:29:44 -08:00
publishing all: rename some references to .config/camlistore to .config/perkeep 2018-05-02 21:36:29 -07:00
release website: add date to 0.10.1 release 2018-05-15 16:40:49 +02:00
schema pkg/schema: break static-sets in subsets for large directories 2018-02-09 01:36:38 +01:00
todo website: Gerrit instance update 2018-05-24 21:32:18 +02:00
README.md doc: add files vs permanodes explanation 2018-07-17 01:35:06 +02:00
app-environment.md website: first pass of s/Camlistore/Perkeep/ on contents 2017-12-18 16:46:08 +01:00
arch.md website: serve /doc/ URLs from top-level doc dir 2016-04-25 22:13:09 -07:00
client-config.md all: rename some references to .config/camlistore to .config/perkeep 2018-05-02 21:36:29 -07:00
compare.md doc: cross-link compare and prior-art pages 2018-01-09 11:14:00 -08:00
environment-vars.md doc: update build instructions 2018-04-30 16:38:29 -07:00
files-and-permanodes.md doc: add files vs permanodes explanation 2018-07-17 01:35:06 +02:00
geocoding.md geocode: support the now-required Google API key and document how to configure 2018-04-25 11:20:47 -07:00
overview.md website: first pass of s/Camlistore/Perkeep/ on contents 2017-12-18 16:46:08 +01:00
overview.txt all: more renaming of Camlistore to Perkeep 2018-01-30 03:02:56 -08:00
principles.md website: serve /doc/ URLs from top-level doc dir 2016-04-25 22:13:09 -07:00
prior-art.md doc: cross-link compare and prior-art pages 2018-01-09 11:14:00 -08:00
release.txt misc/release: update release tools 2018-05-11 02:51:55 +02:00
search-ui.md website: document raw search operator 2018-08-28 19:49:35 +02:00
server-config.md pkg/importer: add "instapaper" importer for Instapaper service 2018-11-26 07:57:08 -05:00
sharing.md cmd: rename camget to pk-get, and make it a mode of pk 2018-04-22 20:50:54 -07:00
status.md cmd: rename camget to pk-get, and make it a mode of pk 2018-04-22 20:50:54 -07:00
storage-examples.md website: first pass of s/Camlistore/Perkeep/ on contents 2017-12-18 16:46:08 +01:00
synology.md doc/synology: update latest tarballs 2018-07-26 03:28:50 +02:00
terms.md cmd: rename camput to pk-put, and make "pk put" call it 2018-04-21 10:26:55 -07:00
uses.md cmd: rename camput to pk-put, and make "pk put" call it 2018-04-21 10:26:55 -07:00
web-ui-styleguide.md website: first pass of s/Camlistore/Perkeep/ on contents 2017-12-18 16:46:08 +01:00

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