Metadata-Version: 2.1
Name: socatlord
Version: 1.3
Summary: A utility to manage all socats of yours
Home-page: https://github.com/Cervi-Robotics/socatlord
Author: Piotr Maślanka
Author-email: piotr.maslanka@dronehub.ai
License: UNKNOWN
Project-URL: Code, https://github.com/Cervi-Robotics/socatlord
Project-URL: Issue tracker, https://github.com/Cervi-Robotics/socatlord/issues
Keywords: socat,systemd,utility
Platform: UNKNOWN
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Operating System :: POSIX
Classifier: Operating System :: OS Independent
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved :: MIT License
Description-Content-Type: text/markdown; charset=UTF-8
Requires-Dist: satella

# socatlord

socatlord is a tool to manage multiple socats

You feed it with a config file placed at
`/etc/socatlord` that has the syntax like:

```
# this is a comment

9.9.9.9:80 -> 123.23.4.3.:81
80 -> 192.168.224.20:80
udp 0.0.0.0:23 -> 192.168.224.20:23
```

TCP is the default protocol.
Socatlord will spawn as many socats as necessary.

# Usage

After you put this file, call `socatlord install`. This will install and enable socatlord to start
during your startups (only if you're using Systemd).
`/etc/socatlord` will be created about then, if it does not already exists. If you haven't done so,
now it would be a good time to fill it up.

Note that installation itself will not start socatlord! After installation put your configuration in
`/etc/socatlord`.

Later call either `socatlord run` 
or `systemctl start socatlord.service` to terminate currently running socats and launch your own.
This may terminate your SSH connection, if you're using a socat to proxy it though, however it will destroy them
and restart in one go.

You can also call `socatlord stop` to stop all socats.


You can provide an optional argument of `-v` to see what commands are launched.
You can provide an optional explicit path to config file, if `/etc/socatlord` is meant not to be used.
socatlord must be run as root. A check will be made for this.

# Changelog

## v1.3

* socatlord will check if socats are alive after started

## v1.2

* socatlord uses argparse
* socatlord will check if it's ran as root

## v1.1

* socat's will be silenced if the mode is not verbose
* better default `/etc/socatlord`

## v1.0

First formal release


