diff --git a/README.md b/README.md index 4e45fd1..d68f567 100644 --- a/README.md +++ b/README.md @@ -17,9 +17,15 @@ These directories should be volumes to persistent storage These Secrets should be set up on first start for the init to work properly -- tl-weechat-ztnetaddr -- tl-weechat-pass -- tl-weechat-authorizedkeys +- `tl-weechat-ztnetaddr`: ZeroTier network address that the container should be connected to + - type: string + - format: [ZeroTier Network Address](https://docs.zerotier.com/zerotier/manual/#221networkidentifiersandcontrollersaname2_2_1a) + - notes: This address is used during container runtime startup to check that it's joined to the specified network, and to automatically join the specified network if it isn't already. +- `tl-weechat-pass`: [Weechat Secured Data](https://weechat.org/files/doc/stable/weechat_user.en.html#secured_data) passphrase + - type: string +- `tl-weechat-authorizedkeys`: Content of the container user's `~/.ssh/authorized_keys` + - type: text file + - format: [OpenSSH authorized_keys](https://www.ssh.com/academy/ssh/authorized_keys/openssh#format-of-the-authorized-keys-file) # Notes