slondr
/
egalaxyd
1
1
Fork 0
Code Issues Pull Requests Packages Projects Releases 5 Wiki Activity

update alternate-format readme files

This commit is contained in:
Eric S. Londres 2022-08-17 22:52:38 -04:00
parent a43e9fe66a
commit 3e035d399b
Signed by: slondr
GPG Key ID: A2D25B4D5CB970E4
2 changed files with 32 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
README.gmi
View File

@ -25,7 +25,22 @@ No special attention is paid to the interactive portions of the Spartan protocol
# Setup instrutions
Run `mix release', navigate to the build directory, and then run `egalaxyd start'. egalaxyd is now serving files on both Gemini and Spartan from your current working directory.
## Quickstart with docker
Just `docker run -it -p 1965:1965 -p 300:3000 tildegit.org/slondr/egalaxyd:latest `. Boom, you are now serving content on Gemini at port 1965 and on Spartan at port 300. Yeah, it's that easy! (Assuming you had rights to port 300).
Note that the docker setup command creates an SSL certificate that is very well-known. It's useful to check your network setup by hitting localhost:1965 with a gemini client and seeing the hello world message, but if you get beyond that point you must delete the `server.crt' and `server.key' files and re-generate them using your actual domain information.
The container will serve files directly out of the `/root' directory by default, so just put more gmi files (or whatever you want to serve) there.
## Installing from source
This is the recommended way to install production instances of egalaxyd.
Run `MIX_ENV=prod mix deps.get; mix release', and then executed the indicated start command (by default, `_build/prod/rel/egalaxyd/bin/egalaxyd start `). egalaxyd is now serving files on both Gemini and Spartan from your current working directory!
Make sure you start the application from a working directory containing the toml config file and your SSL certificate.
# History

18
README.md
View File

@ -25,9 +25,23 @@ No special attention is paid to the interactive portions of the Spartan protocol
# Setup instrutions
Run `MIX_ENV=prod mix release`, and then executed the indicated start command (by default, `_build/prod/rel/egalaxyd/bin/egalaxyd start`). egalaxyd is now serving files on both Gemini and Spartan from your current working directory!
Make sure you start the application from a working directory containing the toml config file and your SSL certificates.
## Quickstart with docker
Just `docker run -it -p 1965:1965 -p 300:3000 tildegit.org/slondr/egalaxyd:latest`. Boom, you are now serving content on Gemini at port 1965 and on Spartan at port 300. Yeah, it's that easy! (Assuming you had rights to port 300).
Note that the docker setup command creates an SSL certificate that is very well-known. It's useful to check your network setup by hitting localhost:1965 with a gemini client and seeing the hello world message, but if you get beyond that point you must delete the `server.crt` and `server.key` files and re-generate them using your actual domain information.
The container will serve files directly out of the `/root` directory by default, so just put more gmi files (or whatever you want to serve) there.
## Installing from source
This is the recommended way to install production instances of egalaxyd.
Run `MIX_ENV=prod mix deps.get; mix release`, and then executed the indicated start command (by default, `_build/prod/rel/egalaxyd/bin/egalaxyd start`). egalaxyd is now serving files on both Gemini and Spartan from your current working directory!
Make sure you start the application from a working directory containing the toml config file and your SSL certificate.
# History