Skip to content

Commit 95a4484

Browse files
committed
update README.md
1 parent 3b53255 commit 95a4484

File tree

5 files changed

+74
-74
lines changed

5 files changed

+74
-74
lines changed

README.md

Lines changed: 73 additions & 73 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<h4 align="right"><strong><a href="./README.zh-cn.md">中文</a></strong> | English </h4>
1+
<h4 align="right">English | <strong><a href="./README.zh-cn.md">中文</a></strong></h4>
22
<h1 align="center">Web Chains</h1>
33
<div align="center">
44
<img alt="downloads" src="https://img.shields.io/github/downloads/java-chains/web-chains/total"/>
@@ -18,6 +18,78 @@ extent.
1818
<img src="./img/main.png" />
1919
</p>
2020

21+
## Quick Start
22+
23+
**Special Note: We only provide random password login protection for port 8011 by default. Other ports may have the risk
24+
of being counter-exploited. Please remember to close the corresponding ports after using the relevant functions.**
25+
26+
### Method 1: Docker
27+
28+
You can start the `web-chains` project with a single `docker` command (recommended approach).
29+
30+
```shell
31+
docker run -d \
32+
--name web-chains \
33+
--restart=always \
34+
-p 8011:8011 \
35+
-p 58080:58080 \
36+
-p 50389:50389 \
37+
-p 50388:50388 \
38+
-p 13999:13999 \
39+
-p 3308:3308 \
40+
-p 11527:11527 \
41+
-p 50000:50000 \
42+
-e CHAINS_AUTH=true \
43+
-e CHAINS_PASS= \
44+
javachains/webchains:1.3.0
45+
```
46+
47+
Authentication or password can be configured through environment variables;
48+
49+
**CHAINS_AUTH**: `true` to enable authentication, `false` to disable authentication. Authentication is enabled by
50+
default.
51+
52+
**CHAINS_PASS**: Specify the web password. If this variable is empty, a random password will be generated. Random
53+
password generation is the default.
54+
55+
Note: Only port `8011` is required for the generation function. Other ports are used by the `exploit` module.
56+
57+
Use the following command to retrieve the randomly generated strong password from Docker:
58+
59+
```shell
60+
docker logs $(docker ps | grep javachains/webchains | awk '{print $1}') | grep -E 'password'
61+
```
62+
63+
Output example:
64+
65+
```text
66+
11-12 06:59:53.301 INFO [main] c.a.c.w.c.SecurityConfig | | password: XSsWerJFGcCjB8FU
67+
```
68+
69+
Login page: `http://your-ip:8011`
70+
71+
### Method 2: Jar Package Startup
72+
73+
⚠️ Only JDK8 is supported. Temurin8/Zulu8 JDK is recommended.
74+
75+
Use `java -jar web-chains.jar` to start. A randomly generated password will be printed after each startup.
76+
77+
Default listening address is 0.0.0.0. Login page: `http://your-ip:8011` (Use the username and password here to log in).
78+
79+
You can set the web login password through environment variables, for example:
80+
81+
Linux:
82+
83+
```bash
84+
export CHAINS_PASS=[your_password] && java -jar web-chains.jar
85+
```
86+
87+
Windows:
88+
89+
```cmd
90+
set CHAINS_PASS=[your_password] && java -jar web-chains.jar
91+
```
92+
2193
## Module Introduction
2294

2395
`Web-Chains` comprises the following six major modules:
@@ -146,78 +218,6 @@ of classes.
146218

147219
![SerializationDumper.png](./img/SerializationDumper.png)
148220

149-
## Quick Start
150-
151-
**Special Note: We only provide random password login protection for port 8011 by default. Other ports may have the risk
152-
of being counter-exploited. Please remember to close the corresponding ports after using the relevant functions.**
153-
154-
### Method 1: Docker
155-
156-
You can start the `web-chains` project with a single `docker` command (recommended approach).
157-
158-
```shell
159-
docker run -d \
160-
--name web-chains \
161-
--restart=always \
162-
-p 8011:8011 \
163-
-p 58080:58080 \
164-
-p 50389:50389 \
165-
-p 50388:50388 \
166-
-p 13999:13999 \
167-
-p 3308:3308 \
168-
-p 11527:11527 \
169-
-p 50000:50000 \
170-
-e CHAINS_AUTH=true \
171-
-e CHAINS_PASS= \
172-
javachains/webchains:1.3.0
173-
```
174-
175-
Authentication or password can be configured through environment variables;
176-
177-
**CHAINS_AUTH**: `true` to enable authentication, `false` to disable authentication. Authentication is enabled by
178-
default.
179-
180-
**CHAINS_PASS**: Specify the web password. If this variable is empty, a random password will be generated. Random
181-
password generation is the default.
182-
183-
Note: Only port `8011` is required for the generation function. Other ports are used by the `exploit` module.
184-
185-
Use the following command to retrieve the randomly generated strong password from Docker:
186-
187-
```shell
188-
docker logs $(docker ps | grep javachains/webchains | awk '{print $1}') | grep -E 'password'
189-
```
190-
191-
Output example:
192-
193-
```text
194-
11-12 06:59:53.301 INFO [main] c.a.c.w.c.SecurityConfig | | password: XSsWerJFGcCjB8FU
195-
```
196-
197-
Login page: `http://your-ip:8011`
198-
199-
### Method 2: Jar Package Startup
200-
201-
⚠️ Only JDK8 is supported. Temurin8/Zulu8 JDK is recommended.
202-
203-
Use `java -jar web-chains.jar` to start. A randomly generated password will be printed after each startup.
204-
205-
Default listening address is 0.0.0.0. Login page: `http://your-ip:8011` (Use the username and password here to log in).
206-
207-
You can set the web login password through environment variables, for example:
208-
209-
Linux:
210-
211-
```bash
212-
export CHAINS_PASS=[your_password] && java -jar web-chains.jar
213-
```
214-
215-
Windows:
216-
217-
```cmd
218-
set CHAINS_PASS=[your_password] && java -jar web-chains.jar
219-
```
220-
221221
## Detailed use
222222

223223
Detailed Documentation: https://www.yuque.com/shenjingwa-leuvd/wpqdhf/war0zkzgzg3c4bzg

README.zh-cn.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ JNDI 注入、MySQL JDBC 反序列化、JRMP 反序列化等漏洞进行方便
1515
> 我们站在巨人肩膀上,致力于打造最强的 Java 安全研究领域的瑞士军刀
1616
1717
<p align="center">
18-
<img src="./img/main.png" />
18+
<img src="./img/main.zh-cn.png" />
1919
</p>
2020

2121
## 模块介绍

img/main.png

-7.36 KB
Loading

img/main.zh-cn.png

478 KB
Loading

img/main_EN.png

-471 KB
Binary file not shown.

0 commit comments

Comments
 (0)