Back to godoc.org
perkeep.org / pkg

Directory perkeep.org/pkg

v0.0.0-...-f2e7add
Latest Go to latest

The latest major version is .

Published: Sep 17, 2020 | License: Apache-2.0 | Module: perkeep.org
Path Synopsis
app Package app provides helpers for server applications interacting with Perkeep.
auth Package auth implements Camlistore authentication.
blob Package blob defines types to refer to and retrieve low-level Perkeep blobs.
blobserver Package blobserver defines how raw blobs are stored and accessed.
blobserver/archiver Package archiver zips lots of little blobs into bigger zip files and stores them somewhere.
blobserver/azure Package azure registers the "azure" blobserver storage type, storing blobs in a Microsoft Azure Blob Storage container.
blobserver/b2
blobserver/blobpacked Package blobpacked registers the "blobpacked" blobserver storage type, storing blobs initially as one physical blob per logical blob, but then rearranging little physical blobs into large contiguous blobs organized by how they'll likely be accessed.
blobserver/cond Package cond registers the "cond" conditional blobserver storage type to select routing of get/put operations on blobs to other storage targets as a function of their content.
blobserver/dir Package dir implements the blobserver Storage interface for a directory, detecting whether the directory is file-per-blob (localdisk) or diskpacked.
blobserver/diskpacked Package diskpacked registers the "diskpacked" blobserver storage type, storing blobs packed together into monolithic data files with an index listing the sizes and offsets of the little blobs within the large files.
blobserver/encrypt Package encrypt registers the "encrypt" blobserver storage type which stores all blobs and metadata with NaCl encryption into other wrapped storage targets (e.g.
blobserver/files Package files implements the blobserver interface by storing each blob in its own file in nested directories.
blobserver/gethandler Package gethandler implements the HTTP handler for fetching blobs.
blobserver/google/cloudstorage Package cloudstorage registers the "googlecloudstorage" blob storage type, storing blobs on Google Cloud Storage (not Google Drive).
blobserver/google/drive Package drive registers the "googledrive" blobserver storage type, storing blobs in a Google Drive folder.
blobserver/google/drive/service Package service translates blobserver.Storage methods into Google Drive API methods.
blobserver/handlers Package handlers implements the HTTP interface to the Perkeep blob server.
blobserver/local Package local implements functionality common to both the "localdisk" and "diskpacked" storage mechanisms.
blobserver/localdisk Package localdisk registers the "filesystem" blobserver storage type, storing blobs in a forest of sharded directories at the specified root.
blobserver/memory Package memory registers the "memory" blobserver storage type, storing blobs in an in-memory map.
blobserver/mongo Package mongo registers the "mongo" blobserver storage type, storing blobs using MongoDB.
blobserver/namespace Package namespace implements the "namespace" blobserver storage type.
blobserver/overlay Package overlay registers the "overlay" blobserver storage type that presents storage that is the result of overlaying a storage ("upper") on top of another storage ("lower").
blobserver/protocol Package protocol contains types for Perkeep protocol types.
blobserver/proxycache Package proxycache registers the "proxycache" blobserver storage type, which uses a provided blobserver as a cache for a second origin blobserver.
blobserver/remote Package remote registers the "remote" blobserver storage type, storing and fetching blobs from a remote Perkeep server over HTTPS.
blobserver/replica Package replica registers the "replica" blobserver storage type, providing synchronous replication to one more backends.
blobserver/s3 Package s3 registers the "s3" blobserver storage type, storing blobs in an Amazon Web Services' S3 storage bucket.
blobserver/sftp Package sftp registers the "sftp" blobserver storage type, storing blobs one-per-file in a forest of sharded directories to a remote SFTP server over an SSH connection.
blobserver/shard Package shard registers the "shard" blobserver storage type, predictably spraying out blobs out over the provided backends based on their blobref.
blobserver/stats Package stats contains an in-memory StatReceiver that only stores sizes of received blobs but not their contents.
blobserver/storagetest Package storagetest tests blobserver.Storage implementations
blobserver/union Package union registers the "union" read-only blobserver storage type to read from the given subsets, serving the first responding.
buildinfo Package buildinfo provides information about the current build.
cacher Package cacher provides various blobref fetching caching mechanisms.
camerrors Package camerrors define specific errors that are used to decide on how to deal with some failure cases.
camlegal Package camlegal registers the Perkeep License
client Package client implements a Perkeep client.
client/android Package android contains code specific to running the Perkeep client code as a child process on Android.
cmdmain Package cmdmain contains the shared implementation for pk-get, pk-put, pk, and other Perkeep command-line tools.
constants Package constants contains Perkeep constants.
conv Package conv contains utilities for parsing values delimited by spaces.
deploy/gce Package gce provides tools to deploy Perkeep on Google Compute Engine.
env Package env detects what sort of environment Perkeep is running in.
fileembed Package fileembed provides access to static data resources (images, HTML, css, etc) embedded into the binary with genfileembed.
fileembed/genfileembed The genfileembed command embeds resources into Go files, to eliminate run-time dependencies on files on the filesystem.
fs Package fs implements a FUSE filesystem for Perkeep and is used by the pk-mount binary.
gc Package gc defines a generic garbage collector.
gpgchallenge Package gpgchallenge provides a Client and a Server so that a Client can prove ownership of an IP address by solving a GPG challenge sent by the Server at the claimed IP.
gpgchallenge/client The client command is an example client of the gpgchallenge package.
gpgchallenge/server The server command is an example server of the gpgchallenge package.
importer Package importer imports content from third-party websites.
importer/allimporters Package allimporters registers all the importer implementations.
importer/dummy Package dummy is an example importer for development purposes.
importer/feed Package feed implements an importer for RSS, Atom, and RDF feeds.
importer/feed/atom Package atom defines XML data structures for an Atom feed.
importer/feed/rdf Package rdf defines XML data structures for an RDF feed.
importer/feed/rss Package rss defines XML data structures for an RSS feed.
importer/flickr Package flickr implements an importer for flickr.com accounts.
importer/gphotos Package gphotos implements a Google Photos importer, using the Google Drive API to access the Google Photos folder.
importer/instapaper Package instapaper implements a instapaper.com importer.
importer/mastodon Package mastodon provides an importer for servers using the Mastodon API.
importer/picasa Package picasa implements an importer for picasa.com accounts.
importer/pinboard Package pinboard imports pinboard.in posts.
importer/plaid Package plaid implements an importer for financial transactions from plaid.com
importer/swarm Package swarm implements an importer for Foursquare Swarm check-ins.
importer/test Package test provides common functionality for importer tests.
importer/twitter Package twitter implements a twitter.com importer.
index Package index provides a generic indexing system on top of the abstract Storage interface.
index/indextest Package indextest contains the unit tests for the indexer so they can be re-used for each specific implementation of the index Storage interface.
index/sqlindex Package sqlindex implements the sorted.KeyValue interface using an *sql.DB.
index/sqlite
jsonsign Package jsonsign implements Perkeep's cryptographic signing and verification of JSON blobs.
jsonsign/signhandler Package signhandler implements the HTTP interface to signing and verifying Perkeep JSON blobs.
kvutil Package kvutil contains helpers related to github.com/cznic/kv.
publish Package publish exposes the types and functions that can be used from a Go template, for publishing.
schema Package schema manipulates Camlistore schema blobs.
schema/nodeattr Package nodeattr contains constants for permanode attribute names.
search Package search describes and answers Perkeep search queries.
server Package server implements the server HTTP interface for the UI, publishing, setup, status, sync, thubnailing, etc.
server/app Package app helps with configuring and starting server applications from Perkeep.
serverinit Package serverinit is responsible for mapping from a Perkeep configuration file and instantiating HTTP Handlers for all the necessary endpoints.
sorted Package sorted provides a KeyValue interface and constructor registry.
sorted/buffer Package buffer provides a sorted.KeyValue implementation that buffers one KeyValue implementation in front of an another.
sorted/kvfile Package kvfile provides an implementation of sorted.KeyValue on top of a single mutable database file on disk using github.com/cznic/kv.
sorted/kvtest Package kvtest tests sorted.KeyValue implementations.
sorted/leveldb Package leveldb provides an implementation of sorted.KeyValue on top of a single mutable database file on disk using github.com/syndtr/goleveldb.
sorted/mongo Package mongo provides an implementation of sorted.KeyValue using MongoDB.
sorted/mysql Package mysql provides an implementation of sorted.KeyValue on top of MySQL.
sorted/postgres Package postgres provides an implementation of sorted.KeyValue on top of PostgreSQL.
sorted/sqlite Package sqlite provides an implementation of sorted.KeyValue using an SQLite database file.
sorted/sqlkv Package sqlkv implements the sorted.KeyValue interface using an *sql.DB.
test Package test provides common Perkeep test objects.
test/asserts Package asserts provides a bad implementation of test predicate helpers.
test/dockertest Package dockertest contains helper functions for setting up and tearing down docker containers to aid in testing.
test/integration
types/camtypes Package camtypes is like the types package, but higher-level and contains Perkeep-specific types.
types/clientconfig Package clientconfig provides types related to the client configuration file.
types/serverconfig Package serverconfig provides types related to the server configuration file.
webserver Package webserver implements a superset wrapper of http.Server.
webserver/listen