mirror of https://github.com/perkeep/perkeep.git
63 lines
2.5 KiB
HTML
63 lines
2.5 KiB
HTML
# Documentation
|
|
|
|
* [Overview](/docs/overview): The original motivation and background for why
|
|
Camlistore exists and what one might use it for.
|
|
|
|
|
|
## For Users
|
|
|
|
**If you're just looking to set up a Camlistore server and use it yourself,
|
|
check out our [getting started guide](/download).** 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](/cmd/)
|
|
* [Server Config](/docs/server-config): Details for configuring server storage
|
|
and access, including synchronization to other Camlistore servers or backup
|
|
to cloud storage providers
|
|
* [Client config](/docs/client-config): Clients need this configuration file to
|
|
securely connect to your Camlistore server(s)
|
|
|
|
|
|
## For Developers
|
|
|
|
If you want to help the development of Camlistore or just want to know more
|
|
about the how and why behind Camlistore, these docs are the going to help you
|
|
get started. **Something we didn't cover here that you're interested in?** Ask
|
|
on the [mailing list](https://groups.google.com/group/camlistore).
|
|
|
|
|
|
### Concepts
|
|
|
|
* [Principles](/docs/principles): our base principles, goals, assumptions
|
|
* [Terminology](/docs/terms): let's agree on terms to stay sane
|
|
* [Use Cases](/docs/uses): what one might do with all this (or at least our aspirations)
|
|
* [Prior Art](/docs/prior-art): other projects with similar goals or strategies
|
|
* [Contributing](/docs/contributing): how to help
|
|
* [Style guide](/docs/web-ui-styleguide) for the Web UI
|
|
|
|
|
|
### Technical Docs
|
|
|
|
* [Packages](/pkg/): internal API documentation
|
|
* [Architecture](/docs/arch): the pieces, layers, and how they interact
|
|
* [Schema](/docs/schema): how we model data in Camlistore
|
|
* [JSON Signing](/docs/json-signing)
|
|
* [Sharing](/docs/sharing)
|
|
|
|
|
|
## Presentations {#presentations}
|
|
|
|
* [February 2015 FOSDEM Slides](https://go-talks.appspot.com/github.com/mpl/talks/fosdem-2015/fosdem-20150201.slide)
|
|
* [February 2014 FOSDEM Presentation](https://www.youtube.com/watch?v=kBCQq5hfsug)
|
|
([WebM version](http://video.fosdem.org/2014/K4601/Sunday/Camlistore.webm))
|
|
* [June 2013 Intro Video](https://www.youtube.com/watch?v=yxSzQIwXM1k)
|
|
* [May 2011 São Paolo Presentation](/talks/2011-05-07-Camlistore-Sao-Paolo/)
|
|
* [February 2011 Presentation](https://docs.google.com/present/view?id=dgks53wm_2j86hwnhs)
|
|
|
|
|
|
## Video tutorials {#tutorials}
|
|
|
|
* [Getting started with Camlistore](https://www.youtube.com/watch?v=RUv-8PhnNp8)
|
|
* [Getting started with camput and the Camlistore client tools](https://www.youtube.com/watch?v=DdccwBFc5ZI)
|