~siegfriedehret/nimige

A Gemini server made with Nim
:memo: update readme
:gift: use a real dependency
:art: reformat code with nimpretty

refs

main
browse  log 

clone

read-only
https://git.sr.ht/~siegfriedehret/nimige
read/write
git@git.sr.ht:~siegfriedehret/nimige

You can also use your local clone with git send-email.

#nimige

A small gemini server to play with Nim.

Don't use it.

#configure

See the example/nimige.cfg file:

[Server]
port = 1965
cert = "cert.pem"
key = "key.pem"

[Dev]
logLevel = "debug"

[Routes]
noNimigeRoute = false

[StaticRoutes]
/something = "./content"
  • [Server]: groups some details for the server
    • port: set the port. Default value: 1965
    • cert: set the path to the certificate. Default value: "cert.pem"
    • key: set the path to the certificate key. Default value: "key.pem"
  • [Dev]: some stuff you should not need
    • logLevel: set the log level to use. Default value: "error"
  • [Routes]: nothing much yet
    • noNimigeRoute: allows to hide the /nimige route. Default value: false
  • [StaticRoutes]: don't put anything and nimige will serve your current folder
    • /<url path> = "./<file path>": a mapping of routes to local folders

You need to set up the certificate and key, the example ones were generated with mkcert.

#run

  1. Install Nim (the nimble command should be available)
  2. Clone nimige
  3. In the nimige folder, execute make
  4. Put nimige in your PATH

To run the example site, execute make run

For development:

  1. Install Nim (the nimble command should be available)
  2. Clone nmg
  3. In the nmg folder, execute nimble develop
  4. Clone nimige
  5. In nimige.nimble, replace requires "https://git.sr.ht/~siegfriedehret/nmg" with requires "nmg"
  6. In the nimige folder, execute make
  7. Put nimige in your PATH

#license

Licensed under the GNU Affero General Public License 3.0.