alexlehm
/
gemini-socks5-proxy
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

write a bit of documentation in the README, remove redundant README.md

This commit is contained in:
Alexander 2023-08-06 17:26:02 +02:00
parent 8c1cbbdc74
commit e056d9812e
2 changed files with 18 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
README.adoc
View File

@ -1,32 +1,34 @@
= Gemini
= Gemini-socks5-proxy
image:https://img.shields.io/badge/vert.x-4.4.1-purple.svg[link="https://vertx.io"]
This application was generated using http://start.vertx.io
This application provides a gemini proxy that requests the gemini servers via a SOCKS5 proxy, which can be used for example to access TOR .onion gemini sites.
== Building
To launch your tests:
To build the application you need Java 11 or above and maven 3.3.
To build the program and run it you can do
```
./mvnw clean test
mvw compile exec:java
```
To package your application:
To package the application as a runnable jar, you can do
```
./mvnw clean package
mvw package
```
To run your application:
The resulting file target/gemini-proxy-1.0.0-SNAPSHOT-fat.jar is a runnable jar without any dependencies and can be run with just java jre installed.
```
./mvnw clean compile exec:java
java -jar gemini-proxy-1.0.0-SNAPSHOT-fat.jar
```
== Help
Please note that the program is currently a first shot at the feature, it is lacking most error checking and is probably leaking open fds. It is also not configurable, it accesses localhost:9150 which is usally the TOR proxy, for anything else it has to be recompiled.
* https://vertx.io/docs/[Vert.x Documentation]
* https://stackoverflow.com/questions/tagged/vert.x?sort=newest&pageSize=15[Vert.x Stack Overflow]
* https://groups.google.com/forum/?fromgroups#!forum/vertx[Vert.x User Group]
* https://discord.gg/6ry7aqPWXy[Vert.x Discord]
* https://gitter.im/eclipse-vertx/vertx-users[Vert.x Gitter]
For feedback about the program, come by on the irc channel tilde.chat/#gemini or send me a mail at alexlehm/at/gmail.com. A lot more forms of contact can be found on my links page at links.lehmann.cx
== Thanks
Obviously this program came into being after the topic of TOR was talked about on the #gemini IRC channel and I found that there was no workable solution for this that did not involve socksifying the application.

4
README.md
View File

@ -1,4 +0,0 @@
# gemini-socks5-proxy
Gemini proxy to connect to gemini sites via SOCKS5, e.g. for TOR