From d0aafa5d6370307bdf0abe470be16f6a15f15162 Mon Sep 17 00:00:00 2001 From: Ian Kelling Date: Fri, 10 Mar 2017 05:34:48 -0800 Subject: [PATCH] cleanup readme --- README | 35 +++++++++++++++++++---------------- get-comments | 2 +- setup.sh | 1 + 3 files changed, 21 insertions(+), 17 deletions(-) diff --git a/README b/README index fafdc64..7bde51a 100644 --- a/README +++ b/README @@ -1,25 +1,28 @@ Content and automated setup of iankelling.org +* Dependencies -* Setup +Requires a modern debian based OS, tested on debian 8 & 9. + +Some programs need to be in PATH: +https://iankelling.org/git/?p=basic-https-conf;a=summary +https://iankelling.org/git/?p=acme-tiny-wrapper;a=summary +chost from +https://iankelling.org/git/?p=fai;a=summary + + +* Installation I use a submodule, so git clone --recursive. -setup.sh sets up apache and gitweb -build.rb does static site generation +./setup.sh +./build.rb -Dependencies for running ./setup.sh DOMAIN: A modern debian based system -(tested on debian 8, and debian 8 testing). -Some shell scripts need to be sourced before running setup.sh: -https://iankelling.org/git/?p=distro-functions;a=summary -And some programs need to be in PATH: -https://iankelling.org/git/?p=basic-https-conf;a=summary -https://sallymae.club/git/?p=acme-tiny-wrapper;a=summary -chost from -https://iankelling.org/git/?p=fai;a=summary +* Usage notes -This repo does not include the repos under /git. In my own version, under /git are links to the .git dirs of the respective repos under the +This repo does not include the repos under /git. In my setup, +under /git are links to the .git dirs of the respective repos under the hardcoded directory in setup.sh: gitroot=/a/bin/githtml. These directories are managed separately, mostly by rsyncing them. @@ -32,12 +35,12 @@ files specific to my site that it expects. Dates in the blog directory can be generated with date +%F -* Comments +* Blog Comments New comments are stored in a sqlite database. There is a system for moderating, rate limiting, and handling comments based on previously -seen ips. See _site/cgi/comment. Ones that are not moderated for spam -etc, are stored to disk for checkin on the next run of build.rb. +seen ips. See _site/cgi/comment. Comments that are not spam etc, are +stored to disk for git commit on the next run of build.rb. get-comments, set-comments, and iank-mod.el are for moderating new comments. With one emacs command, you get a buffer of the new comments, with keybinds to mark them for publishing, moderatation, banning, and diff --git a/get-comments b/get-comments index 0710319..541ce3c 100755 --- a/get-comments +++ b/get-comments @@ -1,4 +1,4 @@ -#!/bin/bash -l +#!/bin/bash # Copyright (C) 2016 Ian Kelling # This program is free software: you can redistribute it and/or modify diff --git a/setup.sh b/setup.sh index aafb072..aa3501f 100755 --- a/setup.sh +++ b/setup.sh @@ -28,6 +28,7 @@ Setup dependencies, apache, and gitweb. Then call build.rb. Default DOMAIN_NAME is iankelling.org. Domain is expected to resolve so we can get a let's encrypt cert. + -h|--help Print help and exit. Note: Uses GNU getopt options parsing style -- 2.30.2