gmnifaq

FAQ-engine for cgi-enabled gemini servers
git clone git://git.clttr.info/gmnifaq.git
Log (Feed) | Files | Refs (Tags) | README | LICENSE

README.md (768B)


      1 # gmnifaq
      2 
      3 gmnifaq is going to be a simple, self-hostable FAQ-engine for the [gemini protocol](gemini://gemini.circumlunar.space).
      4 
      5 Visit the [demo](gemini://gmndemo.clttr.info/faq/).
      6 
      7 ## already implemented
      8 
      9 - tags
     10 - questions
     11 	- all
     12 	- by tag
     13 
     14 ## planned features
     15 
     16 - searching
     17 - admin site with auth
     18 
     19 # installation
     20 
     21 - setup your geminiserver with cgi enabled
     22 - `git clone` the repo to the directory
     23 - rename the files 
     24 	- `gmnifaq.conf.example` to `gmnifaq.conf`
     25 	- `data/data.sqlite.example` to `data/data.sqlite`
     26 - enter your FAQs into the db (with SQLiteStudio or similar) - only till admin site is finished
     27 
     28 ## requirements
     29 
     30 - gemini server with cgi enabled (like gmnisrv or stargazer)
     31 - Perl >= 5.28 with modules
     32 	- URI::Escape
     33 	- DBD
     34 	- DBI::SQLite
     35 - SQLite
     36