From 93a9e047b3c68b409e49a3c70514215222655533 Mon Sep 17 00:00:00 2001 From: Chris/Web Date: Sat, 24 Oct 2020 21:50:14 +0200 Subject: [PATCH] =?UTF-8?q?=E2=80=9EREADME.md=E2=80=9C=20=C3=A4ndern?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 62 ++++++++++++++++++++++++++++++++++++++++++++++++++----- 1 file changed, 57 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index a19addb..c7aef20 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ Die Kolleenrunden-Website besteht aus statischen Webseiten, die mittels dem Hugo-Framwork generiert werden. Es gibt zwei Repositories: kollegen-posts für die Inhalte der Blog-Beiträge und kollegen-hugo, was die Generierungsgrundlage beinhaltet. Um redaktionell mitzubloggen, benötigt man nur das Posts- Repository. Die Anleitung dazu findet man [dort](https://kollegen.uber.space/gitea/kollegenrunde/kollegen-posts.git). -Diese Repository wird für Website-Bearbeitung benötigt, was im Folgenden beschrieben ist. +Dieses Repository wird für Website-Bearbeitung benötigt, was im Folgenden beschrieben ist. ## Lokales Setup @@ -42,18 +42,70 @@ Nach erfolgreicher Installation sollte Hugo seine Version ausgeben können: Das Repository wird geklont und installiert sich im Unterverzeichnis: -> git clone https://kollegen.uber.space/gitea/kollegenrunde/kollegen-hugo.git -> ls kollegen-hugo +>$ git clone https://kollegen.uber.space/gitea/kollegenrunde/kollegen-hugo.git +>$ ls kollegen-hugo > archetypes config.toml data layouts LICENSE README.md resources static themes Als Theme wird Ananke verwendet. Dieses wurde einmalig als Submodul eingebunden: -> git submodule add https://github.com/budparr/gohugo-theme-ananke.git themes/ananke +>$ git submodule add https://github.com/budparr/gohugo-theme-ananke.git themes/ananke ### Content/Repository holen (Posts) Für die Post-Bearbeitung und ggf. auch zur Web-Entwicklung benötigt man noch den Content. Dieses Repository wird neben das Web-Repository installiert: -> git clone https://kollegen.uber.space/gitea/kollegenrunde/kollegen-posts.git +>$ git clone https://kollegen.uber.space/gitea/kollegenrunde/kollegen-posts.git Damit ist das Setup abgeschlossen. + +## Setup des Servers auf uberspace + +Die Pflege des Servers erfolgt über ssh: + +>$ ssh kollegen@despina.uberspace.de +>Password: +>... +>[kollegen@despina ~]$ + +**Gitea** wird im im Lab beschrieben installiert: (https://lab.uberspace.de/guide_gitea.html). Einzige Abweichung ist die Root-Url in der app.ini: + +>[kollegen@despina ~]$ cat gitea/custom/conf/app.ini | grep ROOT_URL +> ROOT_URL = https://%(DOMAIN)s/gitea/ + +Im Gitea ist die Organisation 'kollegenrunde' mit die beiden Repositories kollegen-hugo und kollegen-posts anzulegen. + +**Hugo** wird ebenfalls wie im Lab beschrieben installiert: (https://lab.uberspace.de/guide_hugo.html). Es wird lediglich ~/bin/hugo benötigt. + +>[kollegen@despina ~]$ ~/bin/hugo version +Hugo Static Site Generator v0.74.3-DA0437B4 linux/amd64 BuildDate: 2020-07-23T16:22:34Z + +Das Skript **generate.sh** zum automatischen Generieren beim git-update muss im Verzeichnis 'kollegengen' liegen. Das Skript ist aus dem Verzeichnis 'admin' des Repositories kollegen-hugo zu kopieren. + +>[kollegen@despina ~]$ mkdir ~/kollegengen +>[kollegen@despina ~]$ git clone https://kollegen.uber.space/gitea/kollegenrunde/kollegen-hugo.git ~/kollegengen/kollegen-hugo +>[kollegen@despina ~]$ cp ~/kollegengen/kollegen-hugo/admin/generate.sh ~/kollegengen/ + +Zur Erfolgskontrolle kann die Website nun generiert und gepublished werden: + +>[kollegen@despina ~]$ ~/kollegengen/generate.sh + +Es sollte die Ausgabe "Ready, Blog created in /var/www/virtual/kollegen/html/kollegenrunde!" erfolgen. + +### Git-Hook einrichten ### +Per **Gitea-Hook** wird das Skript generate.sh nun in das git-update-Event der beiden Repositories eingebunden. Damit wird die Website mit jeden Push neu erzeugt. + +Das Hook Skript ist für beide Repositories das gleiche und wird ebenfalls im admin-Verzeichnis von kollegen-hugo gepfelgt. Die Aktivierung kann entweder mit der Gitea-Webkonsole oder auf dem Server erfolgen. + +***Serverseitig*** installiert man das Script durch kopieren in die Hooks: + +>[kollegen@despina ~]$ cp ~/kollegengen/kollegen-hugo/admin/post-receive ~/gitea-repositories/kollegenrunde/kollegen-hugo.git/hooks/post-receive.d/ +>[kollegen@despina ~]$ cp ~/kollegengen/kollegen-hugo/admin/post-receive ~/gitea-repositories/kollegenrunde/kollegen-posts.git/hooks/post-receive.d/ + +In der Web-Konsole von Gitea kann man nun sehen, dass die post-receive-Hooks aktiv sind s. +(https://kollegen.uber.space/gitea/kollegenrunde/kollegen-hugo/settings/hooks/git) bzw. (https://kollegen.uber.space/gitea/kollegenrunde/kollegen-posts/settings/hooks/git). + + + + + +