supersunho/adguardvpn-cli repository overview

⁠About The Project

This project allows you to use AdguardVPN-CLI within a Docker container. It provides a simple and efficient way to manage AdguardVPN through the command line in a containerized environment.

⁠Getting Started

Before proceeding, please review the following content and create your .env file accordingly. You can refer to the .env.sample file provided in this repository for guidance.

⁠Authentication Setup

1. First-time Setup:

   • Start the main container: docker-compose up -d
   • Check the logs to find the authentication link: docker logs adguard-vpn-cli
   • When running adguardvpn-cli for the first time, check the docker logs for the authentication link. Once you access the link and complete the authentication, you won't need to authenticate again for subsequent runs. The link format looks like https://auth.adguard.io/device_code?user_code=xxxx.
   • Note: If you have authenticated via the web browser, please wait a moment for the process to continue automatically. It is not frozen.
   • Warning: If Two-Factor Authentication (2FA) is enabled on your account, you may experience issues with this login process.

2. Volume Mount: The container now mounts ./data directory to persist authentication credentials across container restarts.

⁠How to use

AdguardVPN-CLI + qBittorrent

version: "3"
services:
    adguard-vpn-cli:
        image: supersunho/adguardvpn-cli:latest
        restart: unless-stopped
        container_name: adguard-vpn-cli
        env_file: .env
        volumes:
            - ./data:/root/.local/share/adguardvpn-cli
        healthcheck:
            test: ping -c 1 www.google.com || exit 1
            interval: 1m
            timeout: 10s
            retries: 1
        cap_add:
            - NET_ADMIN
        devices:
            - /dev/net/tun
        ports:
            - 6089:6089
            - 6881:6881
            - 6881:6881/udp
    qbittorrent:
        image: linuxserver/qbittorrent:latest
        container_name: qbittorrent
        environment:
            - PUID=0
            - PGID=0
            - TZ=Asia/Seoul
        volumes:
            - ./config:/config
            - ./downloads:/downloads
        devices:
            - /dev/fuse:/dev/fuse:rwm
        cap_add:
            - SYS_ADMIN
        depends_on:
            - adguard-vpn-cli
        network_mode: service:adguard-vpn-cli

(back to top⁠)

⁠Prerequisites

(back to top⁠)

⁠Location

Please check the location and add the city, country or ISO code to ADGUARD_CONNECTION_LOCATION

(back to top⁠)

⁠References

• AdguardTeam/AdGuardVPNCLI⁠

(back to top⁠)