nynhex/Jekyll_Admin

Collection of Bash scripts for setting up private Git servers that emulate GitHub Pages.

Collection of Bash scripts for Jekyll and Git server administration and interaction via ssh or git command-line tools.

Unless otherwise stated both documentation and code are shared under the GNU AGPL version 3 license by default, a full copy of which is available under master:LICENSE

Documentation is hosted by GitHub Pages, the source code modifications and raw doc-files of which can be found under the gh-pages branch. Installation, and Update instructions are currently featured along with usage examples for Administrators and Git/Jekyll clients.

To add features or fix issues within this project; start with making a Fork of this repository, then make changes (testing if code related), and update the _contributers directory with a file about your self (and maybe a summery of changes) before issuing a Pull Request. See the Contributing collection for examples of development setup and other tips.

---

Directories

• .github contains templates for GitHub interactions such as opening Issues

• git_shell_commands/ contains Git/Jekyll client scripts that may be copied or linked via using jekyll_usermod.sh script

• make_scriptlets/ contains scripts used by Makefile for make install and make update commands; hint make list lists available make options

• shared_functions/ contains functions shared between scripts within root of project directory

Administration Scripts

• jekyll_usermod.sh, adds new user, with ssh-pub-key (git-shell access only), and installs the following to the home directory of the new user;

  • Jekyll, for translating MarkDown to HTML (HyperText Markup Language), just to list one of many things that Jekyll'll do
  • copy or link selected git-shell-command scripts, intended to simplify some of the repetitively redundant tasks involved with Git and Jekyll development
  • and initializes user named repo much like what GitHub makes available.

• jekyll_dnsconf.sh, adds A records for interface, group/domain, and TLD (Top Level Domain), currently wired for Unbound DNS (Domain Name Server); note, some usage examples have been published for this script

• jekyll_wwwconf.sh, adds {sub-}domain names to web server for given user/repo, currently wired for Nginx Web Server, check the published usage examples for examples of usage