More docs

Change-Id: Iac190f16a2b48464e465b69e266bff649fe387d4
This commit is contained in:
Brad Fitzpatrick 2013-06-11 15:36:25 +02:00
parent 3b294e640c
commit 6946ffe7ae
3 changed files with 46 additions and 11 deletions

20
README
View File

@ -1,11 +1,21 @@
Camlistore is a way to store, sync, share, model and back up content.
Camlistore is your personal storage system for life.
It's a way to store, sync, share, model and back up content.
It stands for "Content-Addressable Multi-Layer Indexed Storage", for
lack of a better name.
See:
lack of a better name. For more, see:
http://camlistore.org/
... for actual documentation.
Other useful files:
BUILDING how to compile it ("go run make.go")
HACKING how to do development and contribute
Mailing lists:
http://camlistore.org/lists
Bugs:
https://code.google.com/p/camlistore/issues/list

View File

@ -16,6 +16,8 @@ Or browse at Github: <a href="https://github.com/bradfitz/camlistore/tree/0.1">g
it's at least ready for people to start using and playing with. We've
been using it ourselves for a year.</p>
<p>We plan to do subsequent releases in a more timely fashion.</p>
<h1>What works</h1>
<ul>
@ -27,12 +29,18 @@ been using it ourselves for a year.</p>
<li><b><code>camtool</code></b>: additional swiss-army knife tools, and manual sync tool ("camtool sync").
</ul>
</li>
<li>Web UI. Not great, but lets you browse your Camlistore resources.
<li><b><code>camlistored</code></b>: the server.</li>
<li>Web UI (optional part of the server, on by default). Not great, but lets you browse your Camlistore resources.</li>
<li>Android client: upload photos ("Share to Camlistore")</li>
<li>Blob storage options: local disk, Amazon S3, Google Cloud Storage, ...</li>
<li>Search index storage options: in-memory, SQLite, MySQL, Postgres, Mongo, ...</li>
<li>Synchronous and asynchronous replication support between any storage types or Camlistore instances.</li>
<li>Sharding, mirroring, ...</li>
<li>All sorts of replication:
<ul>
<li><b><code>camlistored</code></b>: The server supports both asynchronous and synchronous replication from incoming blobs to any storage backend, which includes other remote Camlistore servers</li>
<li><b><code>camtool sync</code></b>: The camtool command supports syncing from servers (or local disk blob directories) to other servers (or other local disk blob directories), as well as a "third-leg" mode, where you can sync from <b>A</b> to <b>B></b> by using the network to communicate differences, but instead copying missing blobs to destination <b>C</b> (e.g. a local portable harddisk to be manually transported to <b>B</b>)</li>
</ul>
</li>
<li>Sharding, mirroring, unioning, ...</li>
</ul>
@ -54,6 +62,7 @@ been using it ourselves for a year.</p>
Much is planned:
<ul>
<li>Much more documentation</li>
<li>Photo gallery & blog serving</li>
<li>More sharing support</li>
<li>Encryption</li>
@ -70,5 +79,10 @@ Much is planned:
contributions. See <a href="/docs/contributing">the Contributing
page</a>.</p>
<p>While most the codebase (the server and command-line tools) are
written in <a href="http://golang.org">Go</a>, there's also a lot of
JavaScript which needs love, as well as Java (for Android) and
Objective C (for iOS). Or anything useful you'd like to contribute.</p>
<p>File <a href="https://code.google.com/p/camlistore/issues/list">bugs</a> at: <a
href="https://code.google.com/p/camlistore/issues/entry">https://code.google.com/p/camlistore/issues/entry</a>.</p>

View File

@ -1,6 +1,15 @@
<h1 class='bustTitleRegexp'>What is Camlistore?</h1>
<p>Camlistore is your personal storage system for life. It is:</p>
<p>Camlistore is your <b>personal storage system for life</b>.</p>
<p>Note that it's a "storage system", not just a "file system". It
can store and be accessed like a traditional filesystem, but it
specializes in representing higher-level objects which don't need to
exist in purely one place in a tree. (e.g. a photo, a comment, a
"like", a blog post) Or a tree of 5TB videos with Unix mode bits that
you can access via a FUSE filesystem. Whatever.</p>
<p>It is:</p>
<ul>
<li>a way to store, sync, share, model and back up content</li>
<li>everything private by default</li>
@ -8,7 +17,7 @@
<li>Open Source (Apache licensed)</li>
<li>an acronym for <i>"Content-Addressable Multi-Layer Indexed Storage"</i>, saying that Camlistore is about:
<ul>
<li>content-addressable storage (at the lowest layer)</li>
<li>content-addressable storage, at the lowest layer ("Like git for all content in your life")</li>
<li>separate interoperable parts (<a href="/docs/arch">storage</a>, <a href="/docs/terms#graphsync">sync</a>, <a href="/docs/sharing">sharing</a>,
<a href="/docs/schema">modeling</a>), with well-defined protocols and roles</li>
<li>indexing and searching your content</li>
@ -21,7 +30,9 @@
<li>simple!</li>
<li>programming language-agnostic (parts and different implementations in <a href="http://golang.org/">Go</a>, Python, Java, Perl, Bash, ... the language doesn't matter.) What matters is well-defined, simple HTTP interfaces.</li>
<li>neither "Cloud" nor "Local". happily both. Run it on your own machine (any OS, any architecture), your phone, EC2, App Engine, Heroku, whatever.</li>
<li>a "20% project" from a few Google employees, but not Google-centric nor endorsed by Google (other than them letting us open source our side project)</li>
<li>a "20% project" from a few Google employees (and non-Googlers),
but not Google-centric nor endorsed by Google (other than them
letting us open source our side project)</li>
</ul>
<h2>Latest Release</h2>