commit 06e8b8c3c39a445a1265671a58f867a3c6b0184f parent 169d32fe2f649246c182a58aa2976bf099252ca1 Author: pyratebeard <root@pyratebeard.net> Date: Mon, 12 Nov 2018 14:57:43 +0000 moved gollum info from vimwiki to gollum page Diffstat:
| M | documentation/gollum.md | | | 77 | +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ |
| M | documentation/vimwiki.md | | | 84 | ------------------------------------------------------------------------------- |
2 files changed, 77 insertions(+), 84 deletions(-)
diff --git a/documentation/gollum.md b/documentation/gollum.md @@ -6,6 +6,16 @@ gem install gollum gem install github-markdown #required for tables ``` +navigate to wiki dir and run gollum +``` +gollum --css --h1-title +``` +- using custom css file and setting first h1 header as page title +- see [gollum config][] docs for options +- look at [omnigollum][] for user auth +- [gollum reverse proxy][] + +## running as a service enter the following in `/etc/systemd/system/gollum-personal.service` ``` [Unit] @@ -20,3 +30,70 @@ Restart=on-abort [Install] WantedBy=multi-user.target ``` + +## installing gollum on jump-test +https://github.com/gollum/gollum # use --bare + +- configure omnigollum https://github.com/arr2036/omnigollum +- using azuread https://github.com/AzureAD/omniauth-azure-activedirectory + +### steps +- to enable [git server][] + - install git (duh!) + - create 'git' user + ``` + adduser git + mkdir ~git/.ssh + chmod 700 ~git/.ssh + touch ~git/.ssh/authorized_keys + chmod 600 ~git/.ssh/authorized_keys + ``` +- mkdir 'wiki' dir + ``` + mkdir /wiki + chown git. /wiki + ``` +- create git repo - [getting git on server][] + ``` + su - git + cd /wiki + git init --bare --shared + ``` +- clone repo and initial commit (on local machine) + ``` + git clone git@gitserver:/wiki wiki + cd wiki/ + echo "# wiki" > README.md + git add README.md + git commit -m "Initial commit" + git push -u origin master + ``` +- install gollum + ``` + apt install ruby ruby-dev build-essential zlib1g-dev libicu-dev + gem install gollum + ``` + + ``` + yum group install "Development Tools" + yum install ruby ruby-devel libicu libicu-devel zlib zlib-devel + gem install gollum + ``` +- enable gollum as a service + ``` + vi /etc/systemd/system/gollum.service + + [Service] + ExecStart=/usr/local/bin/gollum --show-all "/wiki" + ``` +- allow traffic + ``` + iptables -I INPUT -p tcp --dport 4567 -j ACCEPT -m comment --comment "Allow access to wiki" + ``` + +## ref +[gollum config]: https://github.com/gollum/gollum#configuration +[omnigollum]: https://github.com/arr2036/omnigollum/blob/master/config.rb.example +[gollum reverse proxy]: https://gist.github.com/spinpx/c46ea0b24157ca5f731f +[git server]: https://git-scm.com/book/en/v2/Git-on-the-Server-Setting-Up-the-Server +[getting git on server]: https://git-scm.com/book/en/v2/Git-on-the-Server-Getting-Git-on-a-Server diff --git a/documentation/vimwiki.md b/documentation/vimwiki.md @@ -27,89 +27,5 @@ pandoc -s -f markdown -t html -o uofu/azure_ad_requirements.html uofu/azure_ad_r i'm using :tags: under a #ref header to jump to links in page - switch to [pandoc markdown][] -## gollum -- install gollum - ``` - sudo gem install gollum - ``` - - requires 'icu' - ``` - sudo dnf install libicu-devel - ``` -- navigate to wiki dir and run gollum - ``` - gollum --css --h1-title - ``` - - using custom css file and setting first h1 header as page title - - see [gollum config][] docs for options -- look at [omnigollum][] for user auth -- [gollum reverse proxy][] - -## installing gollum on jump-test -https://github.com/gollum/gollum # use --bare - -- configure omnigollum https://github.com/arr2036/omnigollum -- using azuread https://github.com/AzureAD/omniauth-azure-activedirectory - -### steps -- to enable [git server][] - - install git (duh!) - - create 'git' user - ``` - adduser git - mkdir ~git/.ssh - chmod 700 ~git/.ssh - touch ~git/.ssh/authorized_keys - chmod 600 ~git/.ssh/authorized_keys - ``` -- mkdir 'wiki' dir - ``` - mkdir /wiki - chown git. /wiki - ``` -- create git repo - [getting git on server][] - ``` - su - git - cd /wiki - git init --bare --shared - ``` -- clone repo and initial commit (on local machine) - ``` - git clone git@gitserver:/wiki wiki - cd wiki/ - echo "# wiki" > README.md - git add README.md - git commit -m "Initial commit" - git push -u origin master - ``` -- install gollum - ``` - apt install ruby ruby-dev build-essential zlib1g-dev libicu-dev - gem install gollum - ``` - - ``` - yum group install "Development Tools" - yum install ruby ruby-devel libicu libicu-devel zlib zlib-devel - gem install gollum - ``` -- enable gollum as a service - ``` - vi /etc/systemd/system/gollum.service - - [Service] - ExecStart=/usr/local/bin/gollum --show-all "/wiki" - ``` -- allow traffic - ``` - iptables -I INPUT -p tcp --dport 4567 -j ACCEPT -m comment --comment "Allow access to wiki" - ``` - - ## ref [pandoc markdown]: http://pandoc.org/MANUAL.html#pandocs-markdown -[gollum config]: https://github.com/gollum/gollum#configuration -[omnigollum]: https://github.com/arr2036/omnigollum/blob/master/config.rb.example -[gollum reverse proxy]: https://gist.github.com/spinpx/c46ea0b24157ca5f731f -[git server]: https://git-scm.com/book/en/v2/Git-on-the-Server-Setting-Up-the-Server -[getting git on server]: https://git-scm.com/book/en/v2/Git-on-the-Server-Getting-Git-on-a-Server