Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
aschuhardt authored Oct 10, 2023
1 parent 2158db1 commit 115c546
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,16 @@

A HTTP proxy frontent for the gemini protocol.

## Overview
Loxy serves a website that proxies incoming requests to a preconfigured gemini capsule. Gemtext is transformed into HTML.

Links to external capsules are translated into links that will proxy requests to those capsules. For example:
- If Loxy is passed `-u geminiprotocol.net` then
- Loxy will proxy incoming requests to `gemini://geminiprotocol.net` by default
- A link that points to `gemini://geminispace.info` will be translated to `/lxy/external/geminispace.info`, and from that route Loxy will proxy requests to the external capsule

Loxy supports injecting CSS stylesheets, JavaScript, and `<head>` contents. By setting a content root directory, static files may be served.

## Usage
Execute the 'loxy' binary to start the service.
```
Expand Down

0 comments on commit 115c546

Please sign in to comment.