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 5087c6efd9 Merge "doc: add libchop and upspin to related projects" 2018-01-02 15:02:09 +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 website: first pass of s/Camlistore/Perkeep/ on contents 2017-12-18 16:46:08 +01: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 website: first pass of s/Camlistore/Perkeep/ on contents 2017-12-18 16:46:08 +01:00
todo website: first pass of s/Camlistore/Perkeep/ on contents 2017-12-18 16:46:08 +01:00
README.md website: link blobserver protocol on /doc/ page 2017-12-21 17:37:50 +01: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 website: first pass of s/Camlistore/Perkeep/ on contents 2017-12-18 16:46:08 +01:00
environment-vars.md website: first pass of s/Camlistore/Perkeep/ on contents 2017-12-18 16:46:08 +01:00
overview.md website: first pass of s/Camlistore/Perkeep/ on contents 2017-12-18 16:46:08 +01:00
overview.txt website: first pass of s/Camlistore/Perkeep/ on contents 2017-12-18 16:46:08 +01:00
principles.md website: serve /doc/ URLs from top-level doc dir 2016-04-25 22:13:09 -07:00
prior-art.md doc: add libchop and upspin to related projects 2018-01-02 06:32:29 +00: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 Merge "website: added note about MySQL permissions in server-config" 2017-12-29 15:54:10 +00:00
sharing.md website: first pass of s/Camlistore/Perkeep/ on contents 2017-12-18 16:46:08 +01:00
status.md website: fix links on doc pages 2018-01-01 10:49:09 +00: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.

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)

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