id.420129/companion-setup
Archived
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update README for new changes

Browse source
This commit is contained in:
Minecon724 2025-04-12 09:45:06 +02:00
commit c7135d0c25
Signed by untrusted user who does not match committer: m724
GPG key ID: A02E6E67AB961189
1 changed files with 6 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

17
README.md
View file

@ -1,30 +1,25 @@
1. `git clone --recursive` 1. `git clone --recursive`
2. Replace IP addresses in `docker-compose.yml`: 2. Fill in `.env`
- Search and replace `203.0.113.1` with the IPv4 address you want nginx to listen on
- Search and replace `2001:db8::1` with the IPv6 address you want nginx to listen on
- You can remove lines with either if you don't want to listen on IPv4 or IPv6
3. How do you want to connect to YouTube? 3. How do you want to connect to YouTube?
- If you want to rotate IPv6, replace the subnet in `reset.sh` - If you want to rotate IPv6, consult `.env`
- This rotates your ipv6 to bypass ratelimits. It's only effective with subnets larger than /64, the larger the better. - This rotates your ipv6 to bypass ratelimits. It's only effective with subnets larger than /64, the larger the better.
- Replace `2001:db8::/32` with your subnet.
- Uncomment the two lines of course
- You must also install `pyroute2`. It's on pypi or `apt install python3-pyroute2` on debian - You must also install `pyroute2`. It's on pypi or `apt install python3-pyroute2` on debian
- If you want to use gluetun, uncomment everything below `gluetun:` and the two lines `network_mode` and `depends_on` - If you want to use gluetun, uncomment everything below `gluetun:` and the two lines `network_mode` and `depends_on`
- By default uses WireGuard config in `wg0.conf` in base directory - Put `wg0.conf` in the root directory
- If something else, you should know what you're doing - If something else, you should know what you're doing
4. Set the companion secret key in `config.toml` 4. Set the companion secret key in `config.toml`
5. cd to `nginx/` and: 5. cd to `nginx/` and:
- `openssl dhparam -out dhparam.pem 3072` (takes up to a few minutes, you can do other steps in the meantime) - `openssl dhparam -out dhparam.pem 3072` (takes up to a few minutes, you can do other steps in the meantime)
- `openssl req -new -x509 -days 365 -noenc -out snakeoil.pem -keyout snakeoil.key` (keep pressing Enter) - `openssl req -new -x509 -days 365 -noenc -out snakeoil.pem -keyout snakeoil.key` (keep pressing Enter)
- If opted in to gluetun, search and replace `companion` with `gluetun` in `conf.d/companion.conf` - Edit `conf.d/companion.conf`
6. cd back and `./reset.sh` 6. cd back and `./reset.sh`
7. [Issue a certificate, steps here](/Minecon724/dream-setup/src/branch/master/CERTIFICATE.md) 7. [Issue a certificate, steps here](/Minecon724/dream-setup/src/branch/master/CERTIFICATE.md)
8. **Schedule `reset.sh`**. This rotates your IP, updates containers, and it's generally a good practice to auto restart. \ 8. **Schedule `reset.sh`**. This rotates your IP, updates containers, and it's generally a good practice to auto restart. \
This restarts every hour:00. You can change it, if you want to. / This restarts every hour:00. You can change it, if you want to. /
If you have multiple companions, you should make them restart at different times. If you have multiple companions, you should make them restart at different times.
``` ```
@reboot sleep 30s && cd /opt/invidious-companion && ./reset.sh @reboot sleep 30s && cd /opt/invidious-companion/reset.sh
0 * * * * cd /opt/invidious-companion && ./reset.sh 0 * * * * cd /opt/invidious-companion/reset.sh
``` ```
**TODOs**: **TODOs**: