wg easy - wg easy

wg easy

Kode sumber lainnya

v14.0.0

Unduh

WireGuard Mudah

Bangun & Publikasikan Gambar Docker ke Docker Hub serat

Anda telah menemukan cara termudah untuk menginstal & mengelola WireGuard di host Linux mana pun!

Fitur

Lengkap: WireGuard + UI Web.
Instalasi mudah, mudah digunakan.
Daftar, buat, edit, hapus, aktifkan & nonaktifkan klien.
Tampilkan kode QR klien.
Unduh file konfigurasi klien.
Statistik klien mana yang terhubung.
Grafik Tx/Rx untuk setiap klien yang terhubung.
Dukungan Gravatar.
Mode Terang / Gelap Otomatis
Dukungan Multibahasa
Statistik Lalu Lintas (default nonaktif)
Tautan Satu Kali (default nonaktif)
Kedaluwarsa Klien (default nonaktif)
Dukungan metrik Prometheus

Persyaratan

Host dengan kernel yang mendukung WireGuard (semua kernel modern).
Host dengan Docker terinstal.

Versi

Untuk versi stabil silakan baca instruksi di cabang produksi !

Kami menyediakan lebih dari 1 tag gambar buruh pelabuhan, berikut ini akan membantu Anda memutuskan mana yang paling cocok untuk Anda.

menandai	Cabang	Contoh	Keterangan
`latest`	`production`	`ghcr.io/wg-easy/wg-easy:latest` atau `ghcr.io/wg-easy/wg-easy`	stabil jika memungkinkan, dapatkan perbaikan bug dengan cepat bila diperlukan, diterapkan pada `production` .
`14`	`production`	`ghcr.io/wg-easy/wg-easy:14`	sama seperti yang terbaru, tetap berpegang pada tag versi.
`nightly`	`master`	`ghcr.io/wg-easy/wg-easy:nightly`	sebagian besar tidak stabil sering menerima pembaruan paket dan kode, diterapkan terhadap `master` .
`development`	permintaan tarik	`ghcr.io/wg-easy/wg-easy:development`	digunakan untuk pengembangan, menguji kode dari PR sebelum masuk ke `master` .

Instalasi

1. Instal Docker

Jika Anda belum menginstal Docker, instal dengan menjalankan:

curl -sSL https://get.docker.com | sh
sudo usermod -aG docker $( whoami )
exit

Dan masuk lagi.

2. Jalankan WireGuard dengan Mudah

Untuk menginstal & menjalankan wg-easy secara otomatis, cukup jalankan:

docker run --detach 
  --name wg-easy 
  --env LANG=de 
  --env WG_HOST= < YOUR_SERVER_IP > 
  --env PASSWORD_HASH= ' <YOUR_ADMIN_PASSWORD_HASH> ' 
  --env PORT=51821 
  --env WG_PORT=51820 
  --volume ~ /.wg-easy:/etc/wireguard 
  --publish 51820:51820/udp 
  --publish 51821:51821/tcp 
  --cap-add NET_ADMIN 
  --cap-add SYS_MODULE 
  --sysctl ' net.ipv4.conf.all.src_valid_mark=1 ' 
  --sysctl ' net.ipv4.ip_forward=1 ' 
  --restart unless-stopped 
  ghcr.io/wg-easy/wg-easy

Ganti <YOUR_SERVER_IP> dengan IP WAN Anda, atau nama host DNS Dinamis.
Ganti <YOUR_ADMIN_PASSWORD_HASH> dengan hash kata sandi bcrypt untuk masuk ke UI Web. Lihat How_to_generate_an_bcrypt_hash.md untuk instruksi tentang cara membuat kata sandi hash.

UI Web sekarang akan tersedia di http://0.0.0.0:51821 .

Metrik Prometheus kini akan tersedia di http://0.0.0.0:51821/metrics . Dasbor Grafana 21733

File konfigurasi Anda akan disimpan di ~/.wg-easy

WireGuard Easy juga dapat diluncurkan dengan Docker Compose - cukup unduh docker-compose.yml , lakukan penyesuaian yang diperlukan dan jalankan docker compose up --detach .

3. Sponsor

Apakah Anda menikmati proyek ini? Belikan Emile bir! ?
Donasi untuk komponen inti: WireGuard

Pilihan

Opsi ini dapat dikonfigurasi dengan mengatur variabel lingkungan menggunakan -e KEY="VALUE" pada perintah docker run .

Env	Bawaan	Contoh	Keterangan
`PORT`	`51821`	`6789`	Port TCP untuk UI Web.
`WEBUI_HOST`	`0.0.0.0`	`localhost`	Alamat IP yang diikat oleh UI web.
`PASSWORD_HASH`	-	`$2y$05$Ci...`	Jika disetel, memerlukan kata sandi saat masuk ke UI Web. Lihat Cara menghasilkan bcrypt hash.md untuk mengetahui cara menghasilkan hash.
`WG_HOST`	-	`vpn.myserver.com`	Nama host publik server VPN Anda.
`WG_DEVICE`	`eth0`	`ens6f0`	Perangkat Ethernet yang lalu lintas wireguardnya harus diteruskan.
`WG_PORT`	`51820`	`12345`	Port UDP publik pada server VPN Anda. WireGuard akan mendengarkannya (jika tidak default) di dalam wadah Docker.
`WG_CONFIG_PORT`	`51820`	`12345`	Port UDP yang digunakan pada Plugin Home Assistant
`WG_MTU`	`null`	`1420`	MTU yang akan digunakan klien. Server menggunakan MTU WG default.
`WG_PERSISTENT_KEEPALIVE`	`0`	`25`	Nilai dalam hitungan detik untuk menjaga "koneksi" tetap terbuka. Jika nilainya 0, maka koneksi tidak akan tetap hidup.
`WG_DEFAULT_ADDRESS`	`10.8.0.x`	`10.6.0.x`	Rentang alamat IP klien.
`WG_DEFAULT_DNS`	`1.1.1.1`	`8.8.8.8, 8.8.4.4`	Klien server DNS akan menggunakan. Jika disetel ke nilai kosong, klien tidak akan menggunakan DNS apa pun.
`WG_ALLOWED_IPS`	`0.0.0.0/0, ::/0`	`192.168.15.0/24, 10.0.1.0/24`	IP yang diizinkan yang akan digunakan klien.
`WG_PRE_UP`	`...`	-	Lihat config.js untuk nilai default.
`WG_POST_UP`	`...`	`iptables ...`	Lihat config.js untuk nilai default.
`WG_PRE_DOWN`	`...`	-	Lihat config.js untuk nilai default.
`WG_POST_DOWN`	`...`	`iptables ...`	Lihat config.js untuk nilai default.
`WG_ENABLE_EXPIRES_TIME`	`false`	`true`	Aktifkan waktu kedaluwarsa untuk klien
`LANG`	`en`	`de`	Bahasa UI Web (Mendukung: en, ua, ru, tr, no, pl, fr, de, ca, es, ko, vi, nl, is, pt, chs, cht, it, th, hi, ja, si) .
`UI_TRAFFIC_STATS`	`false`	`true`	Aktifkan statistik klien RX / TX terperinci di UI Web
`UI_CHART_TYPE`	`0`	`1`	UI_CHART_TYPE=0 # Bagan dinonaktifkan, UI_CHART_TYPE=1 # Bagan garis, UI_CHART_TYPE=2 # Bagan area, UI_CHART_TYPE=3 # Bagan batang
`WG_ENABLE_ONE_TIME_LINKS`	`false`	`true`	Aktifkan tampilan dan pembuatan tautan unduhan singkat satu kali (kedaluwarsa setelah 5 menit)
`MAX_AGE`	`0`	`1440`	Usia maksimum sesi UI Web dalam hitungan menit. `0` berarti sesi akan tetap ada hingga browser ditutup.
`UI_ENABLE_SORT_CLIENTS`	`false`	`true`	Aktifkan klien pengurutan UI berdasarkan nama
`ENABLE_PROMETHEUS_METRICS`	`false`	`true`	Aktifkan metrik Prometheus `http://0.0.0.0:51821/metrics` dan `http://0.0.0.0:51821/metrics/json`
`PROMETHEUS_METRICS_PASSWORD`	-	`$2y$05$Ci...`	Jika disetel, Otentikasi Dasar diperlukan saat meminta metrik. Lihat Cara menghasilkan bcrypt hash.md untuk mengetahui cara menghasilkan hash.

Jika Anda mengubah WG_PORT , pastikan juga mengubah port yang terbuka.

Memperbarui

Untuk memperbarui ke versi terbaru, cukup jalankan:

docker stop wg-easy
docker rm wg-easy
docker pull ghcr.io/wg-easy/wg-easy

Dan kemudian jalankan kembali perintah docker run -d ... di atas.

Dengan Docker Compose WireGuard Easy dapat diperbarui dengan satu perintah: docker compose up --detach --pull always (jika tag gambar ditentukan dalam file Compose dan bukan latest , pastikan tag tersebut diubah ke yang diinginkan ; secara default dihilangkan dan defaultnya adalah latest ).
Kontainer WireGuared Easy akan dibuat ulang secara otomatis jika gambar yang lebih baru ditarik.