Skip to content

Latest commit

 

History

History

config

readme.md

config

The config encapsulates qri configuration options & details. configuration is generally stored as a .yaml file, or provided at CLI runtime via command a line argument.

# to get, for example, your profile information
$ qri config get profile

# to set, for example, your api port to 4444
$ qri config set api.address /ip4/tcp/4444

# to disable rpc connections
$ qri config set rpc.enabled false

Objects and arrays can be indexed into using dot notation, eg as shown above to get or set the api port use api.port To get the first element (which is at index 0) in the p2p.qribootstrapaddrs array: qri config get p2p.qribootstrapaddrs.0

Here is a quick reference of all configurable fields:

Profile

Your profile contains some hairy stuff you shouldn't change once it is set initially.

We strongly recommend you don't change your privkey, ID, and peername.

Created and updated are the timestamps that your profile was created and updated. These will be set automatically, we suggest you don't change these either.

Type, email, name, description, homeurl, color, twitter, and profile and poster photo we strongly encourage you to update!

ID

Profile ID Your id is your identity on Qri and it is set when you first run qri setup or qri connect --setup. Your datasets, your qri nodes, your profile, your identity to your peers are all tied to this profile id. Changing this is bad news bears and will break everything.

DO NOT CHANGE

privkey

private key Your private key is generated when you first run qri setup or qri connect --setup.

DO NOT PUBLISH THIS ANYWHERE.

Your private key is a form of security. If anyone else has your private key, they can pretend to be you. Also bad news bears to change this.

peername

Your moniker on qri. The name that is associated with your profile and datasets.

Let's say your peername is lunalovegood7 (for some reason), and a dataset of yours called best_harry_potter_quotes_ranked.

# a peer would get your profile info by:
$ qri peers lunalovegood74

# and get info on your super important dataset using
$ qri info lunalovegood7/best_harry_potter_quotes_ranked

Your peername is set when you first run qri setup (or qri setup --peername lunalovegood7).

The peername will be mutable in the future, but for now changing your peername is as bad as changing your profile id.

Do not change your peername after setup

created

Date and time timestamp when the qri profile was created on setup. We recommend you do not change this field.

updated

Date and time timestamp when the qri profile was last updated. We recommend you do not change this field as it should auto update on any profile change. (this auto update feature might not be set yet)

type

peer or organization Qri profiles can be associated with a single person or an organization.

Input options (string): peer, organization

Commands:

$ qri config get profile.type

$ qri config set profile.type peer

email

An email address to reach you. If other qri folks can reach you, it will greatly strengthen their trust in yoru datasets.

Input options (string): valid email address

Commands:

$ qri config get profile.email

$ qri config set profile.email [email protected]

name

Your name or organizations name.

Input options (string): max 255 character length

Commands:

$ qri config get profile.name

$ qri config set profile.name Jane Doe

description

A little bio about you or your organization. Can help other users understand the types of data you are interested in.

Input options (string): max 255 character length

Commands:

$ qri config get profile.description 

$ qri config set profile.description "Hi my name is Jane Doe and I am a researcher in the field of loving Harry Potter. I am interested data surrounding the behavior of those who love Harry Potter as much as I do"

homeurl

You or your organization's website.

Input options (string): valid url

Commands:

$ qri config get profile.homeurl

$ qri config set profile.homeurl https://harrypotterlover.com

color

The theme color your prefer when viewing Qri using the webapp. This will expand, but for now the only option is 'default'

Input options (string): default

Commands:

$ qri config get profile.color

$ qri config set profile.color default

thumb

thumbnail photo Your thumbnail photo is auto generated using the profile photo uploaded. We recommend not setting this yourself.

profile photo

Upload a profile photo using a filepath, url, or ipfs hash. This photo is used on the Qri webapp.

Input options (string): valid url, valid filepath, or valid ipfs hash

Commands:

$ qri config get profile.profile

$ qri config set profile.profile ~/Documents/pictures/headshot.jpeg

poster photo

Upload a poster photo (the backdrop to your profile). This photo is used on the Qri webapp.

Input options (string): valid url, valid filepath, or valid ipfs hash

Commands:

$ qri config get profile.poster

$ qri config set profile.poster http://www.imgur.com/pic_of_sunset_i_took_one_time.jpeg

twitter

twitter handle You or your organization's twitter handle. No need to include the @ symbol.

Input options (string): valid twitter handle (max length 15)

Commands:

$ qri config get profile.twitter

$ qri config set profile.twitter lunalovegood7

.

repo

The repo config controls how references to your datasets are stored and (in the future) what additional middleware you want to use when you store it. We don't recommend messing with these, as improper changes can break Qri.

middleware

Middleware is a list of packages that can be used to supliment the process of saving data to Qri. Currently not implemented, but in the future could potentially add encryption middleware, or back up middleware.

Input options (array of strings): not currently implemented

repo type

The type of filestore used to store the references to your data and profile.

Input options (string): fs (currently, any string other string will not work)

Commands:

$ qri config get repo.type

$ qri config set repo.type fs

.

Store

Where and how the datasets are stored.

store type

Where your datasets are stored.

Input options (string): ipfs (currently, any string other string will not work)

Commands:

$ qri config get store.type

$ qri config set store.type ipfs

.

p2p

The p2p config should go unchanged. This config section gives you options to change the way your qri node communicates with other qri nodes.

We strongly recommend you don't change any of these fields but especially not your privkey, pubkey, and peerid.

p2p enabled

Is p2p communication enabled? Probs keep this on if you want any of the benefits of being on the distributed web.

Input options (boolean): true or false

Commands:

$ qri config get p2p.enabled

$ qri config set p2p.enabled true

p2p peerid

The id of this specific node on the network. This will eventually be different from your profile.ID, which is meant to be the identity of all the nodes associated with your profile on the network (eg, if you have qri on two different computers, or on your phone, or tablet)

This is set when you run qri setup

It is associated with your private key and public key, so changes any of them will mess up your p2p communication.

DO NOT CHANGE

p2p privkey

private key Your private key is generated when you first run qri setup or qri connect --setup.

DO NOT PUBLISH THIS ANYWHERE.

Your private key is a form of security. If anyone else has your private key, they can pretend to be you.

It is associated with your public key and peerid, so changes any of them will mess up your p2p communication.

DO NOT CHANGE

pubkey

public key Your public key is what you exchange with peers in order to encrypt your messages and prove your identity.

It is associated with your private key and peerid, so changes any of them will mess up your p2p communication.

DO NOT CHANGE

p2p port

The port to bind a tcp listener. Ignored if Addrs is supplied

Input options (integer): integer

Commands:

$ qri config get p2p.port

$ qri config set p2p.port 0

addrs

List of multiaddresses to listen on

Input options (list of addresses): list of multiadders

Commands:

$ qri config get p2p.addrs

$ qri config set p2p.addrs /ip4/130.211.198.23/tcp/4001/ipfs/QmNX9nSos8sRFvqGTwdEme6LQ8R1eJ8EuFgW32F9jjp2Pb

qribootstrapaddrs

QriBootstrapAddrs lists the addresses to bootstrap you Qri node from. If you change this list, it will take your node a longer time to connect to the Qri network.

Input options (list of addresses): list of multiaddrs

Commands:

$ qri config get p2p.qribootstrapaddrs

$ qri config set p2p.qribootstrapaddrs /ip4/130.211.198.23/tcp/4001/ipfs/QmNX9nSos8sRFvqGTwdEme6LQ8R1eJ8EuFgW32F9jjp2Pb

profilereplication

Profilereplication determines waht to do when this peer sees messages broadcast by it's own profile (from another peer instance). Setting profilereplication to full will cause this peer to automatically pin any data that is verifyably posted the same peer

Input options (string): full

Commands:

$ qri config get p2p.profilereplication

$ qri config set p2p.profilereplication full

bootstrapaddrs

List of addresses to bootstrap qri peers on.

Input options (list of addresses): list of multiaddrs

Commands:

$ qri config get p2p.bootstrapaddrs

$ qri config set p2p.bootstrapaddrs /ip4/130.211.198.23/tcp/4001/ipfs/QmNX9nSos8sRFvqGTwdEme6LQ8R1eJ8EuFgW32F9jjp2Pb

.

cli

cli is the config for the command line interface

colorizeoutput

When true, the output to your terminal will be colorized.

Input options (boolean): true or false

Commands:

$ qri config get cli.colorizeoutput

$ qri config set p2p.colorizeoutput true

.

api

Config for the API server.

api enabled

When true, the api server is enabled when you run qri connect

The api must be enabled and set to port 2503 in order to work locally with the frontend webapp

Input options (boolean): true or false

Commands:

$ qri config get api.enabled

$ qri config set api.enabled true

api address

The api will listen for calls at this address.

The api must be enabled and set to the address /ip4/tcp/2503 in order to work locally with the frontend webapp.

Input options (string):

Commands:

$ qri config get api.address

$ qri config set api.address /ip4/tcp/2503

api websocketaddress

The api will listen for websocket calls at this address.

The api must be enabled and set to the address /ip4/tcp/2506 in order to work locally with the frontend webapp.

Input options (string):

Commands:

$ qri config get api.websocketaddress

$ qri config set api.websocketaddress /ip4/tcp/2506

readonly

When true, the api will only respond to certain GET requests. Doesn't allow any calls that will amend, save, add, or delete datasets or profile information.

Input options (boolean): true and false

Commands:

$ qri config get api.readonly

$ qri config set api.readonly false

.

webapp

Config for the API server.

webapp enabled

When true, if your node is connected (qri connect) you can go to localhost:2505 in your browser to view the webapp.

The api must be enabled and set to port 2503 in order to work locally with the frontend webapp

Input options (boolean): true or false

Commands:

$ qri config get api.enabled

$ qri config set api.enabled true

webapp port

The api will listen for calls at this port.

The api must be enabled and set to port 2503 in order to work locally with the frontend webapp.

Input options (integer):

Commands:

$ qri config get api.port

$ qri config set api.port 2503

.

rpc

Config for the RPC listener.

rpc enabled

When true, rpc connections are enabled.

Input options (boolean): true or false

Commands:

$ qri config get rpc.enabled

$ qri config set rpc.enabled true

rpc address

The rpc will listen for calls at this address. Qri standard is 2504.

Input options (string):

Commands:

$ qri config get rpc.address

$ qri config set rpc.address /ip4/tcp/2504

.

logging

Config for the logger.

levels

The different log levels can be set in this object

- qriapi

Log levels for the api

Input options (string): info, error, debug, warn

Commands:

$ qri config get logging.levels.qriapi.info

$ qri config set logging.levels {"qriapi":"info"}