mirror of
				https://github.com/yggdrasil-network/yggdrasil-go.git
				synced 2025-11-04 11:15:07 +03:00 
			
		
		
		
	Merge branch 'descriptive' into metadata
This commit is contained in:
		
						commit
						6200136fce
					
				
					 11 changed files with 219 additions and 50 deletions
				
			
		| 
						 | 
				
			
			@ -2,6 +2,7 @@ package config
 | 
			
		|||
 | 
			
		||||
// NodeConfig defines all configuration values needed to run a signle yggdrasil node
 | 
			
		||||
type NodeConfig struct {
 | 
			
		||||
	Metadata                    Metadata            `comment:"Optional node metadata. Entirely optional but visible to all\npeers and nodes with open sessions."`
 | 
			
		||||
	Listen                      string              `comment:"Listen address for peer connections. Default is to listen for all\nTCP connections over IPv4 and IPv6 with a random port."`
 | 
			
		||||
	AdminListen                 string              `comment:"Listen address for admin connections. Default is to listen for local\nconnections either on TCP/9001 or a UNIX socket depending on your\nplatform. Use this value for yggdrasilctl -endpoint=X. To disable\nthe admin socket, use the value \"none\" instead."`
 | 
			
		||||
	Peers                       []string            `comment:"List of connection strings for static peers in URI format, e.g.\ntcp://a.b.c.d:e or socks://a.b.c.d:e/f.g.h.i:j."`
 | 
			
		||||
| 
						 | 
				
			
			@ -51,3 +52,10 @@ type TunnelRouting struct {
 | 
			
		|||
type SwitchOptions struct {
 | 
			
		||||
	MaxTotalQueueSize uint64 `comment:"Maximum size of all switch queues combined (in bytes)."`
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// Optional metadata - format subject to change
 | 
			
		||||
type Metadata struct {
 | 
			
		||||
	Name     string
 | 
			
		||||
	Location string
 | 
			
		||||
	Contact  string
 | 
			
		||||
}
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
		Loading…
	
	Add table
		Add a link
		
	
		Reference in a new issue