2021-04-23 23:45:16 +00:00
|
|
|
|
2021-04-25 04:51:02 +00:00
|
|
|
----
|
2021-04-25 05:23:12 +00:00
|
|
|
Hellgate is an extensible, general purpose http-\>gemini mirror with full
|
|
|
|
|
javascript support
|
2021-04-25 04:51:02 +00:00
|
|
|
|
|
|
|
|
## Requirements
|
2021-04-23 23:43:02 +00:00
|
|
|
- nodejs
|
|
|
|
|
- npm
|
|
|
|
|
- electron
|
|
|
|
|
- openssh
|
|
|
|
|
- sh
|
|
|
|
|
- libgtk-2-0
|
|
|
|
|
- libgconf-2-4
|
|
|
|
|
- xvfb (if you're running it headless)
|
|
|
|
|
|
2021-04-25 04:51:02 +00:00
|
|
|
## Setup
|
2021-04-23 23:43:02 +00:00
|
|
|
- `sudo apt install libgtk2.0-0 libgconf-2-4` (if you're on debian, other
|
|
|
|
|
distros idk)
|
|
|
|
|
- `sudo apt install xvfb` (again, on debian)
|
|
|
|
|
- `git clone https://tildegit.org/sose/hellgate`
|
|
|
|
|
- `cd hellgate`
|
|
|
|
|
- `sudo npm install -g electron --unsafe-perm=true`
|
|
|
|
|
- `npm install`
|
|
|
|
|
- `./gen_cert`
|
|
|
|
|
- `npm start` or `xvfb-run npm start`
|
2021-04-25 05:26:29 +00:00
|
|
|
- The server will listen on `localhost:1965` by default
|
2021-04-23 23:43:02 +00:00
|
|
|
|
2021-04-25 05:23:12 +00:00
|
|
|
## Sigils
|
2021-04-25 05:45:36 +00:00
|
|
|
- By default, more complex sites that are rendered by hellgate are not very
|
2021-04-25 05:23:12 +00:00
|
|
|
pretty, and sometimes downright unreadable
|
|
|
|
|
- For this, users can create website specific 'sigils' to display content in a
|
2021-04-25 05:26:29 +00:00
|
|
|
certain way, or to automate certain actions on a website
|
2021-04-25 05:23:12 +00:00
|
|
|
- Sigils are located in the `sigils` dir and are titled with the domain name of
|
2021-04-23 23:43:02 +00:00
|
|
|
their corresponding website
|
2021-04-25 05:23:12 +00:00
|
|
|
- See [writing sigils](writing_sigils.md) for more info on how to write sigils
|
|
|
|
|
and how they work
|
|
|
|
|
- If you write a new sigil for a specific website, don't hesitate to send it as
|
2021-04-23 23:43:02 +00:00
|
|
|
a pull request to this repo
|
2021-04-24 04:46:36 +00:00
|
|
|
|
2021-04-25 04:51:02 +00:00
|
|
|
## Notes
|
2021-04-25 05:23:12 +00:00
|
|
|
- As of right now the npm version of gemini-server is broken, use the version
|
2021-04-24 04:46:36 +00:00
|
|
|
from github or this will not work
|
