search

omar-polo / gmid

a Gemini server
https://gmid.omarpolo.com
ISC License
102 stars 7 forks source link

How is it supposed to be used (not installed) #9

Open ffuentese opened 2 years ago

ffuentese commented 2 years ago

I didn't quite understand from the README or the website how to actually run the server. How does it run? What's the default config file name? I read the man page but I wonder if it could be run (or if it's supposed to be) from inetd or a service with rcctl (I'm using OpenBSD). I had no luck with vger either (which does require inetd and a proxy).

omar-polo commented 2 years ago

Hello :)

gmid doesn't need to be run behind inetd or relayd; it's a standalone daemon. There was a submission in the ports@ mailing list (which doesn't include a default configuration file, but is a fine submission otherwise) if you want to try it. There's also a rc script for OpenBSD in contrib/gmid.

There's a quickstart guide in the website: https://gmid.omarpolo.com/quickstart.html (also available over gemini: gemini://gmid.omarpolo.com/quickstart.gmi)

The TL;DR is to write a configuration file (you can start with the one in the quickstart guide) and save it where you want: gmid doesn't have a default search path for the configuration and the -c is mandatory when you want to run the daemon. A good place may be /etc/gmid.conf.

As a second step, you need to generate a TLS certificate. contrib/gencert is an handy script that can help with that.

Then you can either run it manually from the shell (maybe inside tmux) with something like

$ # -f to stay in the foreground
$ gmid -c /etc/gmid.conf -f

or, if you have installed contrib/gmid into /etc/rc.d/gmid

# rcctl start gmid

If you're aiming to deploy it as a system server, I'd suggest to build the port rather than gmid Makefile make install so its files are managed by pkg_add.

ffuentese commented 2 years ago

Even though I found the quickstart guide afterwards I'm glad I asked because otherwise I'd never realized that there was a rc script written already. I've already started it on my tilde pubnix server in Spanish and we're experimenting with it.

omar-polo commented 2 years ago

Sorry for the absurd delay, I thought I had replied back then but it isn't the case apparently.

I'm happy to hear that gmid is useful to an entire community! 🎉

Please don't refrain to report any troubles you had setting it up for a pubnix, be it in the functionalities or documentation, so that I can try to make things easier.

Thanks!