mirror of https://github.com/perkeep/perkeep.git
7eda9fd502
DBNames is supposed to provide configuration for the various databases names. However, 1) I contend that nobody needs or wants to configure them as long as we provide sane defaults. 2) it seems the only obvious user we have for this is to set up some of the names on GCE. 3) having another external source for names complicates the code further, especially when we already have the distinction between database names for DBMS and file names for file-based databases. 4) writing a correct documentation for it is awkward. Therefore, in this CL, I propose that we remove DBNames. Instead, genconfig.go now sets some consistent default names for the various queues and indexes set up on a DBMS (MySQL, PostGres, Mongo). To that end, we introduce the new, but optional, DBUnique configuration parameter, that is used as a part of all the database names, in order to be able to run several Perkeep instances on the same DBMS, without name conflicts. In addition, the queue for the bs->index synchandler is now set up on the same DBMS that is already in use for the index itself, instead of using a file-base database. And i think we could proceed likewise for the other queues. Fixes #951 Change-Id: Ib6a638f088a563d881e3957e4042e932382b44f4 |
||
|---|---|---|
| .. | ||
| 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 | ||
| server-config.md | ||
| sharing.md | ||
| status.md | ||
| storage-examples.md | ||
| terms.md | ||
| uses.md | ||
| web-ui-styleguide.md | ||
README.md
Documentation
- Overview: The original motivation and background for why Perkeep exists and what one might use it for.
For Users
If you're just looking to set up a Perkeep 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 Perkeep servers or backup to cloud storage providers
- Client config: Clients need this configuration file to securely connect to your Perkeep server(s)
- Search Commands: Covers the available search operators
For Developers
If you want to help the development of Perkeep or just want to know more about the how and why behind Perkeep, these docs are 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 Perkeep
- Protocol: HTTP APIs (discovery, blob storage, JSON signing, ...)
- JSON Signing
- Sharing
Presentations
- 2016-04, GDG Seattle: [slides] [video]
- 2016-04, LinuxFest Northwest: [slides] [video]
- 2015-02, FOSDEM: [slides] [video]
- 2014-02, FOSDEM: [slides] [video] [WebM]
- 2013-06, Google Developers Live: [video]
- 2011-05, São Paolo Perl Conference: [slides]
- 2011-02, First Introduction: [slides]