iv-org/smart-ipv6-rotator
1
0
Fork 0
mirror of https://github.com/iv-org/smart-ipv6-rotator.git synced 2024-11-27 00:00:30 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

adapt doc

Browse Source
This commit is contained in:
Emilien Devos 2023-10-15 11:12:54 +02:00
parent 21f0f3ffe1
commit dfc5ef06ab
1 changed files with 10 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@ -4,12 +4,17 @@
- Install these two python packages:
- pyroute2
- requests
- Your provider need to allow you to assign any arbitrary IPv6 address, your IPv6 space must be fully routed.
Usually the case but some do not support it like the popular cloud providers: AWS, Google Cloud, Oracle Cloud, Azure and more.
# How to setup (very simple tutorial)
Full detailed documentation: https://docs.invidious.io/ipv6-rotator/
# How to setup (very simple tutorial for the moment)
1. Git clone the repository somewhere.
2. Change the `ipv6_subnet` to your IPv6 subnet. If you do not know it, you can use a tool like http://www.gestioip.net/cgi-bin/subnet_calculator.cgi
2. Find your IPv6 subnet. If you do not know it, you can use a tool like http://www.gestioip.net/cgi-bin/subnet_calculator.cgi
3. Run once the script using `sudo python smart-ipv6-rotator.py run --ipv6range=YOURIPV6SUBNET/64`
4. If everything went well then configure a cron for periodically rotate your IPv6 range.
4. If everything went well then configure a cron to periodically rotate your IPv6 range.
Twice a day (noon and midnight) is enough for YouTube servers. Also at the reboot of the server!
# How to clean the configuration done by the script
@ -33,11 +38,13 @@ The attack surface of this script is very limited as it is not running in the ba
# TODO (priority)
## High
- [ ] Docker image for easier use.
- [ ] Allow to configure your IPv6 subnets yourself. (Could be used for other projects)
- [x] Better handle in case of errors in configuring IPv6 routes. Rollback the changes automatically
- [ ] Allow to specify a specific network interface + ipv6 gateway instead of automatically discovering it.
## Medium
- [ ] Arg for spit out the IPv6 subnet of the current default ipv6 address instead of saying to use gestioip.net tool.
- [ ] In most time, adding the new random IPv6 will take precedence over the existing IPv6. This may not be the expected behavior.
## Low
- [ ] Argument for testing if the setup will work without permanently do any modification.
- [ ] Allow to remove debug info