Skip to content
This repository was archived by the owner on Jan 24, 2026. It is now read-only.

Commit 6d7cbcd

Browse files
author
Teynar
committed
docs(readme): extend the how to use section
1 parent 6fe9f39 commit 6d7cbcd

1 file changed

Lines changed: 52 additions & 1 deletion

File tree

README.md

Lines changed: 52 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,59 @@ Streaming chat completion API only.
2626

2727
## How to use
2828

29-
This application is a proxy server, distributed as a fat runnable jar and a GraalVM native image (Windows x64).
29+
This application is a proxy server, and can be started in a few different ways depending on your workflow.
3030

31+
### Workflows
32+
33+
#### By source code
34+
35+
```sh
36+
# if you prefer running auto-downloading the required gradle version seamlessly (recommended)
37+
./gradlew run
38+
```
39+
40+
```sh
41+
# if you already have the required project gradle version installed
42+
gradle run
43+
```
44+
45+
#### By fat runnable jar
46+
47+
```sh
48+
# you can compile the app from the source code or download one of the github releases
49+
# if you compile it, the fat jar will be located at <repo-root>/build/libs
50+
java -jar ProxyAsLocalModel-0.0.7-all.jar
51+
```
52+
53+
#### By native GraalVM image
54+
55+
```sh
56+
# you can get download the executable from one of the github releases
57+
# either launch it through a shell or just double click it from the windows explorer
58+
./proxy.exe
59+
```
60+
61+
#### By docker compose
62+
63+
```sh
64+
# if you want to run it on the background
65+
docker compose up -d --build
66+
67+
# if you want to run it on the foreground
68+
docker compose up --build
69+
```
70+
71+
With docker compose, you can bind the config file from your local filesystem so that the config auto-reload works
72+
Replace the ./config.yml for your config.yml path
73+
74+
```yaml
75+
volumes:
76+
- './config.yml:/app/config.yml:ro'
77+
```
78+
79+
You will need to create a placeholder config.yml to start the app, check the next section for reference
80+
81+
### Start
3182
Run the application, and you will see a help message:
3283
3384
```

0 commit comments

Comments
 (0)