Skip to content

Commit e041961

Browse files
committed
up
1 parent 474bc8a commit e041961

24 files changed

Lines changed: 1730 additions & 1457 deletions

File tree

‎.github/workflows/tests.yml‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
name: tests
2+
3+
# Run the Go test suite on every push and pull request.
4+
on:
5+
push:
6+
branches: ['**']
7+
pull_request:
8+
9+
permissions:
10+
contents: read
11+
12+
jobs:
13+
test:
14+
runs-on: ubuntu-latest
15+
steps:
16+
- uses: actions/checkout@v4
17+
18+
- uses: actions/setup-go@v5
19+
with:
20+
go-version-file: src/go.mod
21+
cache-dependency-path: src/go.sum
22+
23+
- name: go vet
24+
working-directory: src
25+
run: go vet ./...
26+
27+
- name: go test
28+
working-directory: src
29+
run: go test -race ./...

‎README.md‎

Lines changed: 21 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# decenzed-node — run your own proxy, share links with friends
22

3+
[![tests](https://github.com/icecube092/decenzed-node/actions/workflows/tests.yml/badge.svg)](https://github.com/icecube092/decenzed-node/actions/workflows/tests.yml)
4+
[![version](https://img.shields.io/github/v/release/icecube092/decenzed-node?sort=semver)](https://github.com/icecube092/decenzed-node/releases)
5+
[![license](https://img.shields.io/github/license/icecube092/decenzed-node)](LICENSE)
6+
37
`decenzed-node` is a **standalone** VLESS + REALITY proxy server you run on your
48
own machine (Windows, macOS, Linux). It scans for a camouflage domain, generates
59
its own REALITY keys, runs an embedded xray-core, and prints **share links** you
@@ -28,29 +32,33 @@ folder next to the executable (config, xray.json, stats, logs).
2832
- **One command** — `decenzed-node <command>`.
2933
- **Service** — once installed, it runs in the background on boot.
3034

31-
## 4. Check your machine
32-
```bash
33-
decenzed-node check
34-
```
35-
Shows your public IP, runs a speed test, and prints step-by-step **port-forward**
36-
instructions for your router. Fix forwarding/firewall until friends can reach the
37-
port. (A serving machine mostly uploads, so ≥10 Mbit/s upload is recommended.)
38-
39-
## 5. Setup
35+
## 4. Setup
4036
```bash
4137
decenzed-node setup
4238
```
4339
A wizard asks (Enter for the default):
4440
- **Port** (443 / 8443 / custom).
45-
- **Monthly traffic limit** (default: unlimited) + **reset day**.
46-
- **Blocked protocols** (default `bittorrent`).
41+
- **Blocked protocols** (default `bittorrent`; type `no` to block none).
4742
- **Per-user speed cap** (default 10 Mbit/s).
43+
- **DuckDNS token** (optional; keeps a stable domain pointed at your IP).
4844
- **Public IP** (blank = auto-detect for links).
4945

5046
Then it automatically **scans for a REALITY camouflage domain** (a live TLS 1.3 +
5147
HTTP/2 site near you), **generates your REALITY keypair**, creates your first
5248
client, and writes the xray config. It prints your first share link at the end.
5349

50+
## 5. Check your machine
51+
```bash
52+
decenzed-node check
53+
```
54+
Shows your public IP, runs a speed test, refreshes your DuckDNS record, and dials
55+
**back to your own domain/IP** on the node port to confirm it is reachable from
56+
outside. Then it prints step-by-step **port-forward** instructions for your
57+
router. Fix forwarding/firewall until the self-check passes and friends can reach
58+
the port. (A serving machine mostly uploads, so ≥10 Mbit/s upload is recommended;
59+
the loopback self-check may fail from inside your own LAN even when forwarding is
60+
correct — test from mobile data to be sure.)
61+
5462
## 6. Run it in the background
5563
```bash
5664
decenzed-node service install # enable autostart + start now (needs admin/root)
@@ -70,9 +78,10 @@ reloads the service automatically.
7078

7179
## 8. Monitor & tune
7280
```bash
73-
decenzed-node stats # traffic totals, quota, load, run status
81+
decenzed-node stats # traffic totals, load, run status
7482
decenzed-node logs # daemon log
7583
decenzed-node config node|xray # inspect app-config / generated xray JSON
84+
decenzed-node update # download the latest release and restart
7685
```
7786
**To change any setting, re-run `decenzed-node setup`** — it re-asks every field
7887
with the current value as the default and rebuilds `xray.json`. You never edit

0 commit comments

Comments
 (0)