perkeep/doc/status.md

3.1 KiB

Status

Perkeep has many pieces and many potential use cases. Here are some of the pieces and use cases, and where they're at.

Last updated: 2013-02-02 (updated rarely. Ask the mailing list or see the git commit logs)

Roadmap

See the 2012-10-20 Camlistore Roadmap document.

See the home page for the latest release's release notes.

Specification

ItemStatusNotes
Blob Server95%See doc/protocol/
Sharing50%See mailing list thread "Example of sharing"
Search API0%initial hand waving only

Servers

ItemStatusNotes
Server95%See server/camlistored. Written in Go, runs on Linux, OS X, Windows (sometimes regresses), and App Engine (some optimizations / and ease-of-setup remain). Does the blobserver, UI, search, sharing, etc.
Search / indexer server95%Good framework now, and usable. Runs on either memory, SQLite, MySQL, Postgres, MongoDB, or App Engine. More things need to be indexed always, but we keep adding more, and it's easy. It's a library used by the server above.
Blob Server test suite80%See server/tester/bs-test.pl. Unmaintained. Mostly use Go's unit tests against the Go server.

Tools

ItemStatusNotes
pk put99%the kitchen sink tool to inject content into a blobserver. Quite good now. Also used by the Android client, as a child process.
pk-get10%tool to retrieve content from a blobserver.
pk-mountread-onlyFUSE mounting. Works on Linux and OS X.
Android Uploader90%UI is kinda ugly in spots but it works and optionally backs up your SD card (photos, etc) to your blob server. Uses pk put. Can also work in "Share with Perkeep" mode, one resource at a time.
Clip It Good80% Perkeep port of Clip It Good. Chrome extension allows right-click on images and save them to your blobserver. (currently still forked)

High-Level Use Cases

... TODO: table for the various use cases.