Home Download Docs Code Community

Download Perkeep

The latest release is 0.10 (“Bellingham”), released 2018-05-02.

Or, using the latest code from git:

$ cd $GOPATH/src
$ git clone https://perkeep.googlesource.com/perkeep perkeep.org

Build

If you have downloaded one of the binary archives (for Darwin, Linux, or Windows), skip this section.

Download and install Go if you don’t have that installed already. As of revision 2e46fca5cc, Perkeep requires Go 1.10 or newer.

Build Perkeep by making sure you git cloned it to a directory named “perkeep.org” and that directory is in the right place in your $GOPATH. If you haven’t set $GOPATH explicitly, then Go uses $HOME/go by default, which means your perkeep.org directory should be at $HOME/go/src/perkeep.org. Then from that perkeep.org directory, run:

$ go run make.go

Getting started

Once you’ve successfully built the Perkeep components, you can run the server with:

$ ./bin/perkeepd

This will create configuration and public/private key information in $HOME/.config/perkeep/ (or where pk env configdir points). You can start and stop perkeepd as you see fit.

You’re done setting up! Running perkeepd should open a new browser window pointed at your keep where you can start uploading and interacting with data.

Developers typically use the ./bin/devcam wrapper to isolate their test environment from their production instance and to simplify common development tasks. If you have questions, you can ask the mailing list.

Mobile

The project also has an Android app to upload your files (mainly photos) to a Perkeep instance. The official build is on Google Play. A debug version is regularly built and uploaded.

Release Notes

Previous release notes:

Website layout inspired by memcached.
Content by the authors.