From 7679c06a1ba552c711ceb3f12e65693be08d5ff6 Mon Sep 17 00:00:00 2001
From: urosm <urosm@kompot.si>
Date: Mon, 5 Feb 2024 17:22:31 +0100
Subject: [PATCH] add `README.md`

---
 README.md | 134 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 134 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..3dcccb6
--- /dev/null
+++ b/README.md
@@ -0,0 +1,134 @@
+# kontrakurs.org
+
+```
+## clone this repository
+git clone gitea@git.kompot.si:urosm/kontrakurs.org.git
+## install ikiwiki
+sudo apt install ikiwiki
+sudo apt install libfile-mimeinfo-perl libhighlight-perl libhtml-tree-perl libimage-magick-perl liblocale-gettext-perl libmailtools-perl libnet-amazon-s3-perl libnet-inet6glue-perl libsearch-xapian-perl libsort-naturally-perl libtext-csv-perl libtext-multimarkdown-perl libtext-textile-perl libtext-typography-perl libtext-wikicreole-perl libtext-wikiformat-perl libxml-feed-perl libxml-writer-perl
+## allow serving from user dirs
+chmod 711 $HOME
+sudo a2enmod userdir
+sudo systemctl reload apache2
+## enable cgi
+sudo a2enmod cgi
+sudo systemctl restart apache2
+## configure and enable virtual host for kontrakurs.org
+sudo vi /etc/apache2/sites-available/kontrakurs.org.conf
+------------------------------------------------------------------------
++ <VirtualHost *:80>
++ 	ServerName kontrakurs.org
++ 	ServerAlias www.kontrakurs.org
++ 	RewriteEngine on
++ 	RewriteCond %{SERVER_NAME} =www.kontrakurs.org [OR]
++ 	RewriteCond %{SERVER_NAME} =kontrakurs.org
++ 	RewriteRule ^ https://%{SERVER_NAME}%{REQUEST_URI} [END,NE,R=permanent]
++ </VirtualHost>
++ 
++ <VirtualHost *:443>
++ 	ServerName kontrakurs.org
++ 	ServerAlias www.kontrakurs.org
++ 	DocumentRoot /home/urosm/public_html/kontrakurs.org
++ 	ErrorLog ${APACHE_LOG_DIR}/error.log
++ 	CustomLog ${APACHE_LOG_DIR}/access.log combined
++ 	<Directory "/home/urosm/public_html/kontrakurs.org">
++ 		AddHandler cgi-script .cgi
++ 		Options +ExecCGI
++ 	</Directory>
++ 	ErrorDocument 404 /home/urosm/public_html/kontrakurs.org/ikiwiki.cgi
++ </VirtualHost>
+------------------------------------------------------------------------
+sudo a2ensite kontrakurs.org
+sudo systemctl reload apache2
+## configure ikiwiki setupfile
+vi kontrakurs.org.setup
+------------------------------------------------------------------------
+# IkiWiki::Setup::Yaml - YAML formatted setup file
+wikiname: kontrakurs.org
+#adminemail: ''
+adminuser:
+- admin
+#banned_users: []
+srcdir: /home/admin/kontrakurs.org
+destdir: /home/admin/public_html/kontrakurs.org
+url: https://kontrakurs.org
+cgiurl: https://kontrakurs.org/ikiwiki.cgi
+#reverse_proxy: 0
+cgi_wrapper: /home/admin/public_html/kontrakurs.org/ikiwiki.cgi
+#cgi_wrappermode: 06755
+#cgi_overload_delay: ''
+#cgi_overload_message: ''
+#only_committed_changes: 0
+rcs: git
+add_plugins:
+- img
+- map
+- remove
+- rename
+- toc
+disable_plugins:
+- openid
+- recentchanges
+templatedir: /home/admin/kontrakurs.org/tmpl
+underlaydir: ''
+verbose: 1
+#syslog: 1
+#usedirs: 1
+#prefix_directives: 1
+#indexpages: 0
+discussion: 0
+discussionpage: ''
+html5: 1
+#sslcookie: 0
+#default_pageext: mdwn
+#htmlext: html
+#timeformat: '%c'
+locale: sl_SI.UTF-8
+#userdir: ''
+#numbacklinks: 10
+#hardlink: 0
+#umask: public
+#wrappergroup: ikiwiki
+#libdirs: []
+#libdir: ''
+#ENV: {}
+#timezone: :/etc/localtime
+#include: ^\.htaccess$
+#exclude: ^(*\.private|Makefile)$
+#wiki_file_chars: -[:alnum:]+/.:_
+#allow_symlinks_before_srcdir: 0
+#cookiejar:
+#  file: ''
+#useragent: ikiwiki/3.20200202.3-1
+#responsive_layout: 1
+#deterministic: 0
+
+# git plugin
+git_wrapper: /home/admin/kontrakurs.org.git/hooks/post-update
+#git_wrapper_background_command: git push github
+#git_wrappermode: 06755
+#git_test_receive_wrapper: /git/wiki.git/hooks/pre-receive
+#untrusted_committers: []
+#historyurl: http://git.example.com/gitweb.cgi?p=wiki.git;a=history;f=[[file]];hb=HEAD
+#diffurl: http://git.example.com/gitweb.cgi?p=wiki.git;a=blobdiff;f=[[file]];h=[[sha1_to]];hp=[[sha1_from]];hb=[[sha1_commit]];hpb=[[sha1_parent]]
+gitorigin_branch: origin
+#gitmaster_branch: master
+
+# inline plugin
+rss: 0
+atom: 0
+#allowrss: 0
+#allowatom: 0
+#pingurl: http://rpc.technorati.com/rpc/ping
+
+# passwordauth plugin
+account_creation_password: s3cr1t
+#password_cost: 8
+
+# mdwn plugin
+multimarkdown: 1
+#nodiscount: 0
+mdwn_footnotes: 1
+#mdwn_alpha_lists: 0
+------------------------------------------------------------------------
+```