Skip to content
This repository has been archived by the owner on Sep 28, 2024. It is now read-only.

Commit

Permalink
updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
imp1sh committed Nov 11, 2022
1 parent f8019b5 commit c59dfbf
Showing 1 changed file with 18 additions and 20 deletions.
38 changes: 18 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,30 +5,28 @@ Install via
ansible-galaxy collection install imp1sh.ansible_openwrt
```

This is an Ansible collection for OpenWrt devices. It will only work if you have enough flash space available to install python which is required. Details can be found in the [documentation](https://wiki.junicast.de/de/junicast/docs/AnsibleOpenWrtCollection).
This is an Ansible collection for OpenWrt devices. It will only work if you have enough flash space available to install python which is required. Details can be found in the [documentation](https://wiki.junicast.de/en/junicast/docs/AnsibleOpenWrtCollection).
It has been tested on virtualized x86 (kvm), PC Engines APU4, Edgerouter X and Deciso DEC740.
## Who is this for?
OpenWrt typically is being used in small environments but this collection is a game changer. You could run virtualized firewalls with this in cloud environments or as a hosting provider. This role is an alternative solution to what OpenWisp does. You can manage hundreds or thousands of devices centrally with Ansible.

Click the link for the [documentation.](https://wiki.junicast.de/de/junicast/docs/AnsibleOpenWrtCollection)
Click the link for the [documentation.](https://wiki.junicast.de/en/junicast/docs/AnsibleOpenWrtCollection)
Here is a [Youtube video](https://youtu.be/f1qrP3AagLM) I made in order to introduce it.
Currently the documentation is German only but when the basics in Ansible are done and the documentation approaches a finshed state, I will translate it into English.
The old german documentation is not being updated any more, instead the english docs are now reference.

Sections:
- [Ansible OpenWrt general usage](https://wiki.junicast.de/de/junicast/docs/AnsibleOpenWrtCollection)
- [Ansible OpenWrt ACME](https://wiki.junicast.de/de/junicast/docs/AnsibleOpenWrtCollection/RolleAcme)
- [Ansible OpenWrt Batman-adv](https://wiki.junicast.de/de/junicast/docs/AnsibleOpenWrtCollection/RolleBatmanadv)
- [Ansible OpenWrt DHCP](https://wiki.junicast.de/de/junicast/docs/AnsibleOpenWrtCollection/RolleDHCP)
- [Ansible OpenWrt Dropbear SSH](https://wiki.junicast.de/de/junicast/docs/AnsibleOpenWrtCollection/RolleDropbear)
- [Ansible OpenWrt Firewall](https://wiki.junicast.de/de/junicast/docs/AnsibleOpenWrtCollection/RolleFirewall)
- [Ansible OpenWrt Network](https://wiki.junicast.de/de/junicast/docs/AnsibleOpenWrtCollection/RolleNetwork)
- [Ansible OpenWrt Packages](https://wiki.junicast.de/de/junicast/docs/AnsibleOpenWrtCollection/RollePackages)
- [Ansible OpenWrt Restic Backup](https://wiki.junicast.de/de/junicast/docs/AnsibleOpenWrtCollection/RolleRestic)
- [Ansible OpenWrt SQM QoS](https://wiki.junicast.de/de/junicast/docs/AnsibleOpenWrtCollection/RolleSqm)
- [Ansible OpenWrt Service](https://wiki.junicast.de/de/junicast/docs/AnsibleOpenWrtCollection/RolleServices)
- [Ansible OpenWrt System](https://wiki.junicast.de/de/junicast/docs/AnsibleOpenWrtCollection/RolleSystem)
- [Ansible OpenWrt Wireguard](https://wiki.junicast.de/de/junicast/docs/AnsibleOpenWrtCollection/RolleWireguard)
- [Ansible OpenWrt Wireless](https://wiki.junicast.de/de/junicast/docs/AnsibleOpenWrtCollection/RolleWireless)
- [Ansible OpenWrt bmx7](https://wiki.junicast.de/de/junicast/docs/AnsibleOpenWrtCollection/RolleBmx7)
- [Ansible OpenWrt babeld](https://wiki.junicast.de/de/junicast/docs/AnsibleOpenWrtCollection/RolleBabeld)
- [Ansible OpenWrt Imagebuilder](https://wiki.junicast.de/de/junicast/docs/AnsibleOpenWrtCollection/RolleImagebuilder)
- [Ansible OpenWrt general usage](https://wiki.junicast.de/en/junicast/docs/AnsibleOpenWrtCollection)
- [Ansible OpenWrt ACME](https://wiki.junicast.de/en/junicast/docs/AnsibleOpenWrtCollection/roleAcme)
- [Ansible OpenWrt DHCP](https://wiki.junicast.de/en/junicast/docs/AnsibleOpenWrtCollection/roleDHCP)
- [Ansible OpenWrt Dropbear SSH](https://wiki.junicast.de/en/junicast/docs/AnsibleOpenWrtCollection/roleDropbear)
- [Ansible OpenWrt Firewall](https://wiki.junicast.de/en/junicast/docs/AnsibleOpenWrtCollection/roleFirewall)
- [Ansible OpenWrt Network](https://wiki.junicast.de/en/junicast/docs/AnsibleOpenWrtCollection/roleNetwork)
- [Ansible OpenWrt Packages](https://wiki.junicast.de/en/junicast/docs/AnsibleOpenWrtCollection/rolePackages)
- [Ansible OpenWrt Restic Backup](https://wiki.junicast.de/en/junicast/docs/AnsibleOpenWrtCollection/roleRestic)
- [Ansible OpenWrt SQM QoS](https://wiki.junicast.de/en/junicast/docs/AnsibleOpenWrtCollection/roleSQM)
- [Ansible OpenWrt Service](https://wiki.junicast.de/en/junicast/docs/AnsibleOpenWrtCollection/roleServices)
- [Ansible OpenWrt System](https://wiki.junicast.de/en/junicast/docs/AnsibleOpenWrtCollection/roleSystem)
- [Ansible OpenWrt Tinyproxy](https://wiki.junicast.de/en/junicast/docs/AnsibleOpenWrtCollection/roleTinyproxy)
- [Ansible OpenWrt Wireguard](https://wiki.junicast.de/en/junicast/docs/AnsibleOpenWrtCollection/roleWireguard)
- [Ansible OpenWrt Wireless](https://wiki.junicast.de/en/junicast/docs/AnsibleOpenWrtCollection/roleWireless)
- [Ansible OpenWrt Imagebuilder](https://wiki.junicast.de/en/junicast/docs/AnsibleOpenWrtCollection/roleImagebuilder)

0 comments on commit c59dfbf

Please sign in to comment.