agate

Simple gemini server for static files
git clone https://github.com/mbrubeck/agate.git
Log | Files | Refs | README

README.md (1549B)


      1 If you want to run agate on a pretty much standard Debian install, this
      2 directory contains some additional materials that may help you.
      3 
      4 Please keep in mind that there is no warranty whatsoever provided for this
      5 software as specified in the disclaimer in the MIT license or section 7 of
      6 the Apache license respectively.
      7 
      8 To run Agate as a service with systemd, put the `gemini.service` file
      9 in the directory `/etc/systemd/system/` (copy or move it there).
     10 
     11 This service file has some comments you may want to look at before using it!
     12 
     13 If you use the service file and want the agate logs in a separate file,
     14 using the gemini.conf file and putting it in the directory
     15 `/etc/rsyslog.d/` will make the agate log messages appear in a file
     16 called `/var/log/gemini.log`.
     17 
     18 If you use Debians `logrotate` and want to automatically rotate these log files,
     19 you can use the `geminilogs` file and put it in `/etc/logrotate.d/`.
     20 
     21 You can also use the `install.sh` file which will check if these systems
     22 are installed (but not if they are running) and copy the files to their
     23 described locations. Please ensure your systems hostname is set correctly
     24 (i.e. `uname -n` should give your domain name).
     25 
     26 You will have to run this with elevated privileges, i.e. `sudo ./install.sh`
     27 to work correctly. This install script will also create the necessary content
     28 directories and the certificate and private key in the `/srv/gemini/`
     29 directory. After the script is done sucessfully, you can start by putting
     30 content in `/srv/gemini/content/`, the server is running already!