Skip to content
Snippets Groups Projects
Select Git revision
0 results

user-discovery-bot

  • Clone with SSH
  • Clone with HTTPS
  • user avatar
    Richard T. Carback III authored
    Release
    
    See merge request elixxir/user-discovery-bot!90
    1b96bbf2
    History

    elixxir/user-discovery-bot

    pipeline status coverage report

    The user discovery bot helps users make first contact with other users. Users can search for other users using a string key (i.e. email address or phone number) and, if the user discovery bot finds a match for that user with the hash of the string, it will return a key ID. The user and the bot can then do a key exchange with the public key that the bot returns after the user queries that key ID to facilitate transfer of information that they need to talk to the user.

    ##Command-line options

    Long flag Short flag Effect Example
    --config Specify a different configuration file --config udb2.yaml
    --help -h Shows a help message -h
    --logLevel -l Sets the log message level to print. (0 = info, 1 = debug, >1 = trace) -v 2
    --version -V Prints generated version information for the UDB and its dependencies. To regenerate log messages, run $ go generate cmd/version.go. -V
    --ndf -n Path to the network definition file -V

    Example configuration

    Note: Yaml prohibits the use of tabs. If you put tabs in your config file, the UDB will fail to parse it.

    # Path where UDB will store its logs
    logPath: "udb.log"
    # Path where UDB will store session file
    sessionfile: "udb.session"
    #List of names in file that are blacklisted userNames
    blacklistedNamesFilePath: ""
    
    # Database connection information
    dbUsername: "cmix"
    dbPassword: ""
    dbName: "cmix_server"
    dbAddress: ""
    

    Running

    Installing dependencies

    $ glide up should automatically download or update all dependencies and place them in the vendor/ folder. If it's not working correctly, try removing ~/.glide/ and ./glide.lock and trying again to clear the cache. If it still doesn't work, make sure you're pointing to the right versions and that you have access to all the repositories that are getting downloaded.

    Running tests

    Simply run $ go test ./...