routeros-config-export/README.md

31 lines
1.5 KiB
Markdown

# oxidized-selfmade aka routeros-config-export
[![status-badge](https://ci.mgrote.net/api/badges/6/status.svg)](https://ci.mgrote.net/repos/6)
This is a small script that pulls the config of one or multiple routeros-devices and pushes them into git-repository.
## Usage
```yaml
version: "3"
services:
routeros-config-export:
container_name: routeros-config-export
restart: always
image: registry.mgrote.net/oxidized-selfmade:master
volumes:
- /home/mg/key_git:/key_git:ro # passwordless ssh-key for pushing to the git-repository
- /home/mg/key_rb5009:/key_rb5009:ro # passwordless ssh-key for a specific device, if you have mutltiple devices with different keys, mount them all here
environment:
# Format <FQDN>,<SSH_KEY_PATH to ssh-private-key(passwordless)> #siehe volunmes # |- damit keine newline am ende erstellt wird
DEVICES: |-
# <fqdn of the device>,<user>,<path to ssh-key>
rb5009.grote.lan,admin,/neu
GIT_REPO_BRANCH: "master" # on which branch should the commits be created
GIT_REPO_URL: "ssh://gitea@gitea.grote.lan:2222/mg/testrepo.git" # repo-url in ssh format
GIT_REPO_DEPLOY_KEY: "/neu" # path to deploy-key for the git-repository
GIT_USERNAME: oxidized-selfmade # username for the commit
GIT_USER_MAIL: michael.grote@posteo.de # mail for the commit
GIT_REPO_REMOTE_NAME: origin # git-name of the remote
INTERVAL: 30 # interval, how often should the config be pulled
```