Kepler is self-sovereign storage. It is architected as a decentralized storage system that uses DIDs and Authorization Capabilities to define Orbits, where your data lives and who has access. Any DID controller (e.g. people, applications, DAOs) can administer their own Kepler Orbit.
To run Kepler locally you will need the latest version of rust.
You will need to create a directory for Kepler to store data in:
mkdir keplerWithin this directory, create two more directories blocks and indexes:
mkdir kepler/blocks
mkdir kepler/indexesYou will then need to set the environment variables to point to those directories:
export KEPLER_STORAGE_BLOCKS_PATH="kepler/blocks"
export KEPLER_STORAGE_INDEXES_PATH="kepler/indexes"Finally you can run Kepler using cargo:
cargo build
cargo runKepler instances are configured by the kepler.toml configuration file, or via environment variables. You can either modify them in this file, or specify them through environment variable using the prefix KEPLER_.
The following common options are available:
| Option | env var | description |
|---|---|---|
| log_level | KEPLER_LOG_LEVEL | Set the level of logging output, options are "normal", "debug" |
| address | KEPLER_ADDRESS | Set the listening address of the kepler instance |
| port | KEPLER_PORT | Set the listening TCP port for the kepler instance |
| storage.blocks.type | KEPLER_STORAGE_BLOCKS_TYPE | Set the mode of block stoage, options are "Local" and "S3" |
| storage.indexes.type | KEPLER_STORAGE_INDEXES_TYPE | Set the type of the index store, options are "Local" and "DynamoDB" |
| orbits.allowlist | KEPLER_ORBITS_ALLOWLIST | Set the URL of an allowlist service for gating the creation of Orbit Peers |
Storage can be configured for both Blocks and Indexes, depending on the type for each.
When storage.blocks.type and storage.indexes.type are Local, the local filesystem will be used for application stoage. The following config options will become available:
| Option | env var | description |
|---|---|---|
| storage.blocks.path | KEPLER_STORAGE_BLOCKS_PATH | Set the path of the block storage |
| storage.indexes.path | KEPLER_STORAGE_INDEXES_PATH | Set the path of the index store |
When storage.blocks.type is S3 and storage.indexes.type is DynamoDB, the instance will use the S3 and DynamoDB AWS services for application storage. The following config options will become available:
| Option | env var | description |
|---|---|---|
| storage.blocks.type | KEPLER_STORAGE_BLOCKS_TYPE | Set the mode of block stoage, options are "Local" and "S3" |
| storage.blocks.bucket | KEPLER_STORAGE_BLOCKS_BUCKET | Set the name of the S3 bucket |
| storage.blocks.endpoint | KEPLER_STORAGE_BLOCKS_ENDPOINT | Set the URL of the S3 store |
| storage.blocks.dynamodb_table | KEPLER_STORAGE_BLOCKS_DYNAMODB_TABLE | Set the name of the dynamodb table |
| storage.blocks.dynamodb_endpoint | KEPLER_STORAGE_BLOCKS_DYNAMODB_ENDPOINT | Set the URL of the dynamodb service |
| storage.indexes.path | KEPLER_STORAGE_INDEXES_PATH | Set the path of the index store |
Additionally, the following environment variables must be present: AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY and AWS_DEFAULT_REGION.
Kepler instances can be started via command line, e.g.:
KEPLER_PORT=8001 keplerIf the Kepler instance is not able to find or establish a connection to the configured storage, the instance will terminate.
Kepler is most easily used via the Kepler SDK. See the example DApps and tutorials for detailed information.