Mark Sinclair
3096a2307f
* Change mixnode, gateway, network and nym-api binary licenses to GPLv3 * Add license to cargo files * Revert model license to match crate * Add license to nym-node * Revert model license to match crate * Fix formatting --------- Co-authored-by: Mark Sinclair <mmsinclair@users.noreply.github.com>
84 lines
2.6 KiB
Rust
84 lines
2.6 KiB
Rust
// Copyright 2020 - Nym Technologies SA <contact@nymtech.net>
|
|
// SPDX-License-Identifier: GPL-3.0-only
|
|
|
|
// While using normal toml marshalling would have been way simpler with less overhead,
|
|
// I think it's useful to have comments attached to the saved config file to explain behaviour of
|
|
// particular fields.
|
|
// Note: any changes to the template must be reflected in the appropriate structs.
|
|
pub(crate) const CONFIG_TEMPLATE: &str = r#"
|
|
# This is a TOML config file.
|
|
# For more information, see https://github.com/toml-lang/toml
|
|
|
|
##### main base mixnode config options #####
|
|
|
|
[host]
|
|
# Ip address(es) of this host, such as 1.1.1.1 that external clients will use for connections.
|
|
# currently not in active use for mixnodes
|
|
public_ips = [
|
|
{{#each host.public_ips }}
|
|
'{{this}}',
|
|
{{/each}}
|
|
]
|
|
|
|
# (temporary) Optional hostname of this node, for example nymtech.net.
|
|
# currently not in active use for mixnodes
|
|
hostname = '{{ host.hostname }}'
|
|
|
|
[mixnode]
|
|
# Version of the mixnode for which this configuration was created.
|
|
version = '{{ mixnode.version }}'
|
|
|
|
# Human readable ID of this particular mixnode.
|
|
id = '{{ mixnode.id }}'
|
|
|
|
# Socket address to which this mixnode will bind to and will be listening for packets.
|
|
listening_address = '{{ mixnode.listening_address }}'
|
|
|
|
# Port used for listening for all mixnet traffic.
|
|
# (default: 1789)
|
|
mix_port = {{ mixnode.mix_port }}
|
|
|
|
# Port used for listening for verloc traffic.
|
|
# (default: 1790)
|
|
verloc_port = {{ mixnode.verloc_port }}
|
|
|
|
# Addresses to APIs running on validator from which the node gets the view of the network.
|
|
nym_api_urls = [
|
|
{{#each mixnode.nym_api_urls }}
|
|
'{{this}}',
|
|
{{/each}}
|
|
]
|
|
|
|
[http]
|
|
# Socket address this node will use for binding its http API.
|
|
# default: `0.0.0.0:8000`
|
|
bind_address = '{{ http.bind_address }}'
|
|
|
|
# Path to assets directory of custom landing page of this node
|
|
landing_page_assets_path = '{{ http.landing_page_assets_path }}'
|
|
|
|
[storage_paths]
|
|
|
|
# Path to file containing private identity key.
|
|
keys.private_identity_key_file = '{{ storage_paths.keys.private_identity_key_file }}'
|
|
|
|
# Path to file containing public identity key.
|
|
keys.public_identity_key_file = '{{ storage_paths.keys.public_identity_key_file }}'
|
|
|
|
# Path to file containing private identity key.
|
|
keys.private_sphinx_key_file = '{{ storage_paths.keys.private_sphinx_key_file }}'
|
|
|
|
# Path to file containing public sphinx key.
|
|
keys.public_sphinx_key_file = '{{ storage_paths.keys.public_sphinx_key_file }}'
|
|
|
|
# Path to file containing description of this node.
|
|
node_description = '{{ storage_paths.node_description }}'
|
|
|
|
##### logging configuration options #####
|
|
|
|
[logging]
|
|
|
|
# TODO
|
|
|
|
"#;
|