Skip to content

Commit

Permalink
Moved all defaults and examples to new line in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Andrew Nguyen committed Feb 19, 2019
1 parent bfb1638 commit 49d09b6
Showing 1 changed file with 28 additions and 14 deletions.
42 changes: 28 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,41 +56,55 @@ The Pocket Core application will allow anyone to spin up a Pocket Network full n
To run the Pocket Core binary you can use the following flags alongside the `pocket-core` executable:
````
-cfile string
specifies the filepath for chains.json (default "[datadir]/chains.json")
specifies the filepath for chains.json
(default "[datadir]/chains.json")
-clientrpc
whether or not to start the rpc server (default true)
whether or not to start the rpc server
(default true)
-clientrpcport string
specified port to run client rpc (default "8080")
specified port to run client rpc
(default "8080")
-datadirectory string
setup a custom location for the datadirectory
(default: `%APPDATA%\Pocket` for Windows, `~/.pocket` for Linux, `~/Library/Pocket` for Mac)
-dbend string
specifies the database endpoint for the centralized dispatcher
(default "dynamodb.us-east-2.amazonaws.com")
-dbtable string
specifies the database tablename for the centralized dispatcher (default "dispatchPeers")
specifies the database tablename for the centralized dispatcher
(default "dispatchPeers")
-dfile string
specifies the filepath for developer_whitelist.json (default "[datadir]/developer_whitelist.json")
specifies the filepath for developer_whitelist.json
(default "[datadir]/developer_whitelist.json")
-discport string
specifies the client port of the centralized dispatcher (default "8080")
specifies the client port of the centralized dispatcher
(default "8080")
-disip string
specifies the address of the centralized dispatcher (default "localhost")
specifies the address of the centralized dispatcher
(default "localhost")
-dismode int
specifies the mode by which the dispatcher is operating (0) Normal, (1) Migrate, (2) Deprecated
specifies the mode by which the dispatcher is operating
(0) Normal, (1) Migrate, (2) Deprecated
-dispatch
specifies if this node is operating as a dispatcher
-disrport string
specifies the relay port of the centralized dispatcher (default "8081")
specifies the relay port of the centralized dispatcher
(default "8081")
-gid string
set the selfNode.GID for pocket core mvp (default "GID1")
set the selfNode.GID for pocket core mvp
(default "GID1")
-pfile string
specifies the filepath for peers.json (default "[datadir]/peers.json")
specifies the filepath for peers.json
(default "[datadir]/peers.json")
-relayrpc
whether or not to start the rpc server (default true)
whether or not to start the rpc server
(default true)
-relayrpcport string
specified port to run relay rpc (default "8081")
specified port to run relay rpc
(default "8081")
-sfile string
specifies the filepath for service_whitelist.json (default "[datadir]/service_whitelist.json")
specifies the filepath for service_whitelist.json
(default "[datadir]/service_whitelist.json")
````
<h1 align="center">How to test</h1>

Expand Down

0 comments on commit 49d09b6

Please sign in to comment.