ANYTUN-CONTROLD(8)

anytun-controld ๐Ÿ’– the anycast tunneling control daemon

okay bestie, sit down, hydrate, because this is the anytun-controld(8) manual page and it's lowkey iconic. this is the daemon that keeps all your Anytun servers on the same page. she's the group chat admin of the tunneling world. periodt. ๐Ÿ‘‘


โœจ SYNOPSIS โœจ

anytun-controld
  [ -h|--help ]
  [ -D|--nodaemonize ]
  [ -u|--username <username> ]
  [ -g|--groupname <groupname> ]
  [ -C|--chroot <path> ]
  [ -P|--write-pid <filename> ]
  [ -L|--log <target>:<level>[,<param1>[,<param2>[..]]] ]
  [ -U|--debug ]
  [ -f|--file <path> ]
  [ -X|--control-host < <host>[:port>] | :<port> > ]

๐ŸŒธ DESCRIPTION ๐ŸŒธ

so anytun-controld is the one that sets up the multi-connection support for Anytun. that's her whole job, that's her whole personality. ๐Ÿ’…

here's the vibe: she reads a connection/routing table and then outputs it via a tcp socket to all the connected Anytun servers. all of them. she's broadcasting, she's the main character. ๐Ÿ“ฃ

and the cute part? when the control daemon gets restarted with a new connection/routing table, all the Anytun servers automatically load the new configuration. no manual labor. she just handles it. slay. โœจ

๐Ÿšจ bestie, REAL TALK: please make sure to protect that information, because it contains the connection keys. protect it like you protect your phone password. no cap. ๐Ÿ”

๐Ÿ’… OPTIONS ๐Ÿ’…

  • -D, --nodaemonize โ€” this tells anytun-controld to run in the foreground instead of becoming a daemon. and becoming a daemon is the default, so this is you saying "no bestie, stay here with me, don't ghost." ๐Ÿซถ
  • -u, --username <username> โ€” run as this user. if no group is specified (-g), the default group of the user gets used. the default is to not drop privileges at all. so by default she keeps her power. ๐Ÿ‘‘
  • -g, --groupname <groupname> โ€” run as this group. but heads up: if no username is specified (-u), this gets ignored. literally just ignored. the default is to not drop privileges.
  • -C, --chroot <path> โ€” instruct anytun-controld to run in a chroot jail. the default is to not run in chroot. so she's free-range by default, this option is the enclosure. ๐Ÿ 
  • -P, --write-pid <filename> โ€” instruct anytun-controld to write its pid to this file. the default is to not create a pid file. no receipts by default, iykyk.
  • -L, --log <target>:<level>[,<param1>[,<param2>[..]]] โ€” add a log target to the logging system. you can invoke this several times to log to different targets at the same time, because she's multitalented. ๐Ÿ’– every target has its own log level, which is a number between 0 and 5. where 0 means disabling log and 5 means debug messages are enabled. so 0 is "girl, silence" and 5 is "tell me EVERYTHING." ๐Ÿ˜ญ

the file target can be used more than once with different levels. if no target is provided at the command line, a single target with the config syslog:3,anytun-controld,daemon is added. so that's your default bestie right there.

the following targets are supported:

  • syslog โ€” log to syslog daemon, parameters <level>[,<logname>[,<facility>]]
  • file โ€” log to file, parameters <level>[,<path>]
  • stdout โ€” log to standard output, parameters <level>
  • stderr โ€” log to standard error, parameters <level>
  • -U, --debug โ€” this option instructs Anytun to run in debug mode. it implicits -D (don't daemonize) and adds a log target with the configuration stdout:5 (logging with maximum level). in future releases there might be additional output when this option is supplied. so like, currently she's giving what she's giving, but there's more coming. ๐Ÿ”ฎ
  • -f, --file <path> โ€” the path to the file which holds the sync information. that's it, that's the tea. ๐Ÿ“
  • -X, --control-host <hostname|ip>[:<port>] โ€” fetch the config from this host. the default is not to use a control host and therefore this is empty. mind that the port can be omitted, in which case port 2323 is used. ๐ŸŽ€

and listen, if you want to specify an ipv6 address and a port, you have to use [ and ] to separate the address from the port, eg.: [::1]:1234. if you want to use the default port, [ and ] can be omitted. don't skip this part, the brackets are load-bearing fr fr. ๐Ÿฆ‹


๐Ÿ˜ญ BUGS ๐Ÿ˜ญ

most likely there are some bugs in Anytun. she's not perfect, nobody is. if you find a bug, please let the developers know at satp@anytun.org. and of course, patches are preferred. so if you can fix it yourself, you're literally the moment. ๐Ÿ‘‘


๐Ÿฆ‹ SEE ALSO ๐Ÿฆ‹

anytun(8), anytun-config(8), anytun-showtables(8)

go read those too, they're her friends. โœจ


๐Ÿซถ AUTHORS ๐Ÿซถ

Othmar Gsenger <otti@anytun.org> Erwin Nindl <nine@anytun.org> Christian Pointner <equinox@anytun.org>


๐ŸŒˆ RESOURCES ๐ŸŒˆ

Main web site: http://www.anytun.org/


๐Ÿ’œ COPYING ๐Ÿ’œ

Copyright (C) 2007-2014 Markus Grรผneis, Othmar Gsenger, Erwin Nindl and Christian Pointner. This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or any later version.


okay that's the whole page, you ate that. ๐Ÿ’… this version of the page is dated 01/06/2020, and it lives in the ANYTUN-CONTROLD(8) section of the manual. go configure something, bestie. mwah. ๐ŸŽ€โœจ๐Ÿ’–

๐Ÿ“ฆ where this page comes from