github.com/SmartMeshFoundation/Spectrum@v0.0.0-20220621030607-452a266fee1e/dashboard/config.go (about)

     1  // Copyright 2017 The Spectrum Authors
     2  // This file is part of the Spectrum library.
     3  //
     4  // The Spectrum library is free software: you can redistribute it and/or modify
     5  // it under the terms of the GNU Lesser General Public License as published by
     6  // the Free Software Foundation, either version 3 of the License, or
     7  // (at your option) any later version.
     8  //
     9  // The Spectrum library is distributed in the hope that it will be useful,
    10  // but WITHOUT ANY WARRANTY; without even the implied warranty of
    11  // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
    12  // GNU Lesser General Public License for more details.
    13  //
    14  // You should have received a copy of the GNU Lesser General Public License
    15  // along with the Spectrum library. If not, see <http://www.gnu.org/licenses/>.
    16  
    17  package dashboard
    18  
    19  import "time"
    20  
    21  // DefaultConfig contains default settings for the dashboard.
    22  var DefaultConfig = Config{
    23  	Host:    "localhost",
    24  	Port:    8080,
    25  	Refresh: 3 * time.Second,
    26  }
    27  
    28  // Config contains the configuration parameters of the dashboard.
    29  type Config struct {
    30  	// Host is the host interface on which to start the dashboard server. If this
    31  	// field is empty, no dashboard will be started.
    32  	Host string `toml:",omitempty"`
    33  
    34  	// Port is the TCP port number on which to start the dashboard server. The
    35  	// default zero value is/ valid and will pick a port number randomly (useful
    36  	// for ephemeral nodes).
    37  	Port int `toml:",omitempty"`
    38  
    39  	// Refresh is the refresh rate of the data updates, the chartEntry will be collected this often.
    40  	Refresh time.Duration `toml:",omitempty"`
    41  
    42  	// Assets offers a possibility to manually set the dashboard website's location on the server side.
    43  	// It is useful for debugging, avoids the repeated generation of the binary.
    44  	Assets string `toml:",omitempty"`
    45  }