summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJuan J. Martinez <jjm@usebox.net>2021-02-27 14:14:29 +0000
committerJuan J. Martinez <jjm@usebox.net>2021-07-22 19:49:50 +0100
commitaa745257f9cff7f63f67d48783a2ee63ba3a1574 (patch)
tree8d0750f07fa640ffe8aa843e12ed1f314565ca88 /README.md
parent117916eb4d1f50bd923794101a6221a510a6ffeb (diff)
downloadspacebeans-aa745257f9cff7f63f67d48783a2ee63ba3a1574.tar.gz
spacebeans-aa745257f9cff7f63f67d48783a2ee63ba3a1574.zip
Added Gemini link and a Debian "how to"
Diffstat (limited to 'README.md')
-rw-r--r--README.md9
1 files changed, 6 insertions, 3 deletions
diff --git a/README.md b/README.md
index 8ef2491..dc250ca 100644
--- a/README.md
+++ b/README.md
@@ -4,7 +4,8 @@
This is an experimental server for the [Gemini](https://gemini.circumlunar.space/) protocol.
-It is built using [Scala](https://www.scala-lang.org/) and [Akka Streams](https://doc.akka.io/docs/akka/current/stream/index.html). The name tries to link the Gemini *theme* with the fact that the
+It is built using [Scala](https://www.scala-lang.org/) and [Akka Streams](https://doc.akka.io/docs/akka/current/stream/index.html).
+The name tries to link the Gemini *theme* with the fact that the
server runs on the Java Virtual Machine.
Some of the **SpaceBeans** features:
@@ -18,6 +19,8 @@ Some of the **SpaceBeans** features:
Check [CHANGES](CHANGES.md) to see what's new in the latest release.
+If you have a Gemini browser, you can also visit: [gemini://capsule.usebox.net/spacebeans/](gemini://capsule.usebox.net/spacebeans/)
+
## How to run it
Download [the `jar` distribution file](https://github.com/reidrac/spacebeans/releases/) and install Java Runtime Environment 8 (or
@@ -35,7 +38,7 @@ how to configure the service.
### Running it as a service
-TODO: instructions with systemd or similar.
+Check this document on [Deployment.md](how to deploy on Debian).
## On security
@@ -58,7 +61,7 @@ Comment out the `key-store` section on your virtual host and you are done.
You can generate a self signed certificate using Java's `keytool`:
```
-keytool -genkey -keyalg RSA -alias ALIAS -keystore keystore.jks -storepass SECRET -validity 36500 -keysize 2048
+keytool -genkey -keyalg RSA -alias ALIAS -keystore keystore.jks -storepass SECRET -noprompt -validity 36500 -keysize 2048
```
When entering the certificate details, use the domain name as `CN`.