github.com/annchain/OG@v0.0.9/README.md (about)

     1  # OG
     2  
     3  OG is a dag based decentralized ledger and Dapp platform.
     4  
     5  ## Insatallation
     6  Get code from github:
     7  
     8  ```
     9  go get github.com/annchain/OG
    10  ```
    11  
    12  Build the project:
    13  
    14  ```
    15  cd $GOPATH/src/github.com/annchain/OG
    16  
    17  make og
    18  ```
    19  
    20  The node will be built in `build` directory
    21  
    22  ## Running
    23  
    24  ```
    25  # running og by loading config file from local filesystem :
    26  ./og -c config.toml  run
    27  
    28  # running og by loading config file from remote http server :
    29  ./og -c http://127.0.0.1:8532/og_config run
    30  
    31  # running og by assigning log output path:
    32  ./og -c config.toml -l log_path/ run
    33  ```
    34  
    35  Other og commands:
    36  ```
    37  -c, --config string         Path for configuration file or url of config server (default "config.toml")
    38  -d, --datadir string        Runtime directory for storage and configurations (default "data")
    39  -h, --help                  help for OG
    40  -l, --log_dir string        Path for configuration file. Not enabled by default
    41  -v, --log_level string      Logging verbosity, possible values:[panic, fatal, error, warn, info, debug] (default "debug")
    42  -n, --log_line_number       write log with line number
    43  -s, --log_stdout            Whether the log will be printed to stdout
    44  -m, --multifile_by_level    split log into multiple files by level
    45  -M, --multifile_by_module   split log into multiple files by module
    46  ```
    47  
    48  ## Usage
    49  
    50  ### RPC
    51  
    52  Users can call the node's functions through RPC interface. The default URL address for RPC is `localhost:8000`, which is set in the default config file. You can switch the port by changing the value of key `[rpc].port` in config file.
    53  
    54  For more details of each RPC API, you can check document: [https://github.com/annchain/OG/blob/dev/rpc/doc.md](https://github.com/annchain/OG/blob/dev/rpc/doc.md)
    55  
    56  ## Development
    57  
    58  ## License
    59  
    60  
    61  <!-- 
    62  This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details -->