Rooba
/
perkeep
mirror of https://github.com/perkeep/perkeep.git
1
1
Fork 0
Code Issues Packages Projects Releases Wiki Activity
perkeep/doc
History
mpl f8ef262ff9 make.go: clean up, notably remove the tmp source code mirroring 
Fixes #1004

Change-Id: Iea01cfc601b8dd8f2a81fe5da40cdd272b164bb1
 		2018-04-17 19:39:46 +02: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 website: first pass of s/Camlistore/Perkeep/ on contents 2017-12-18 16:46:08 +01:00
release Rename import paths from camlistore.org to perkeep.org. 2018-01-01 16:03:34 -08:00
schema pkg/schema: break static-sets in subsets for large directories 2018-02-09 01:36:38 +01:00
todo all: change github.com/camlistore/camlistore to github.com/perkeep/perkeep 2018-01-05 19:49:59 -08:00
README.md doc: add comparison to other software and services 2018-01-09 11:04:44 -08: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 cmd/camtool: rename from camtool to pk 2018-03-06 16:20:59 +01:00
compare.md doc: cross-link compare and prior-art pages 2018-01-09 11:14:00 -08:00
environment-vars.md make.go: clean up, notably remove the tmp source code mirroring 2018-04-17 19:39:46 +02: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 website: 2017-05-05 release 2017-05-05 20:25:29 +02:00
search-ui.md website: add "ref" predicate in search-ui 2017-09-21 16:37:25 +02:00
server-config.md pkg/serverinit: remove DBNames and provide consistent default instead 2018-01-04 04:01:34 +01:00
sharing.md website: first pass of s/Camlistore/Perkeep/ on contents 2017-12-18 16:46:08 +01:00
status.md all: rename cammount to pk-mount 2018-01-08 09:54:41 -08:00
storage-examples.md website: first pass of s/Camlistore/Perkeep/ on contents 2017-12-18 16:46:08 +01:00
terms.md website: fix links on doc pages 2018-01-01 10:49:09 +00:00
uses.md website: first pass of s/Camlistore/Perkeep/ on contents 2017-12-18 16:46:08 +01: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.

  • 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