openct

Configuration backup and analysis* tools for devices running pfSense* and RouterOS.

* aspirational

Installation

pipx

pipx install openct

pip

mkdir /opt/openct
cd /opt/openct
apt update
apt install python3.11 python3.11-venv
python3.11 -m venv .venv
. .venv/bin/activate
pip install pip --upgrade
python -m pip install openct

From sources

git clone https://github.com/weehooey/openct
cd openct
poetry install

Setup

Creating a configuration file:

Installed with pipx

openct-setup

From sources or installed with pip

python -m openct.setup

Edit the configuration file:

nano config.yml

SSH Keys

Create a key pair in the project root folder
Copy the public key to the target routers
Add the private key to the config.yml file

Datastore

mkdir -p datastore
touch datastore/datastore.yml

Add the target routers to the datastore in the following format:

- "0.0.0.0"
- "10.10.10.10"
- "192.168.0.1

Logs

mkdir -p logs

Usage

openct

Arguments:

--root root directory for the program (default ".")
--config path to the config file (default "./config.yml")

Contributing

Submit bugs and feature requests, and help us verify as they are checked in
Review source code changes

Feedback

File an issue

License

Licensed under the GNU GPL v3.0 license.

Weehooey/openct