isle/docs/user/creating-a-daemonyml-file.md
Brian Picciano b35a3d6574 First public commit
There has been over 1 year of commit history leading up to this point,
but almost all of that has had some kind network configuration or
secrets built into the code. As of today all of that has been removed,
and the codebase can finally be published!

I am keeping a private copy of the previous commit history, though it's
unclear if it will ever be able to be published.
2022-07-04 15:18:55 -06:00

1.1 KiB

Creating a daemon.yml File

The cryptic-net daemon process has generally sane defaults and does not need to be configured for most users. However, in some cases it does, so this document describes how to use the daemon.yml file to handle those cases.

Create daemon.yml

First, create a daemon.yml file. You can create a new daemon.yml with default values filled in by doing:

cryptic-net daemon --dump-config > /path/to/daemon.yml

If you open that file in a text editor you can view all default values that cryptic-net daemon ships with, as well as documentation for all configurable parameters. Feel free to edit this file as needed.

Using daemon.yml

With the daemon.yml created and configured, you can configure your daemon process to use it by passing it as the -c argument:

sudo cryptic-net daemon -c /path/to/daemon.yml

If you are an operator then your host should be running its cryptic-net daemon process in systemd (see Getting Started if not), and you will need to modify the cryptic-net.service accordingly.