mirror of https://github.com/perkeep/perkeep.git
a1ec9bf60e
GitHub treats the CONTRIBUTING file special, in that it is referenced any time someone files a new issue or starts to create a pull request. Also make minor updates to file to use markdown and current hacking instructions. Change-Id: I68f0d7a69397851ee6c65671ae692cbfb2b93946 |
||
|---|---|---|
| .. | ||
| example-blobs | ||
| json-signing | ||
| protocol | ||
| publishing | ||
| release | ||
| schema | ||
| todo | ||
| README.md | ||
| app-environment.md | ||
| arch.md | ||
| client-config.md | ||
| environment-vars.md | ||
| overview.md | ||
| overview.txt | ||
| principles.md | ||
| prior-art.md | ||
| release.txt | ||
| search-ui.md | ||
| search-ui.txt | ||
| server-config.md | ||
| sharing.md | ||
| status.md | ||
| terms.md | ||
| uses.md | ||
| web-ui-styleguide.md | ||
README.md
Documentation
- 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. 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
- Server Config: Details for configuring server storage and access, including synchronization to other Camlistore servers or backup to cloud storage providers
- 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.
Concepts
- Principles: our base principles, goals, assumptions
- Terminology: let's agree on terms to stay sane
- Use Cases: what one might do with all this (or at least our aspirations)
- Prior Art: other projects with similar goals or strategies
- Contributing: how to help
- Style guide for the Web UI
Technical Docs
- Packages: internal API documentation
- Architecture: the pieces, layers, and how they interact
- Schema: how we model data in Camlistore
- JSON Signing
- Sharing
Presentations
- February 2015 FOSDEM Slides
- February 2014 FOSDEM Presentation (WebM version)
- June 2013 Intro Video
- May 2011 São Paolo Presentation
- February 2011 Presentation