From 6409627daeb7ce6a131bd7205409c3f8c07f9986 Mon Sep 17 00:00:00 2001 From: Jon Date: Mon, 22 May 2023 16:39:19 +0930 Subject: [PATCH] feat(docs): add website static page building !10 nofusscomputing/projects/gitlab-ci!25 --- .gitlab-ci.yml | 1 + .gitmodules | 4 ++ mkdocs.yml | 57 ++++++++++++++++++++++++ pages/{ => projects/docker-mail}/dkim.md | 5 +++ pages/projects/docker-mail/index.md | 7 +++ pages/{ => projects/docker-mail}/spf.md | 5 +++ pages/projects/index.md | 0 website-template | 1 + 8 files changed, 80 insertions(+) create mode 100644 mkdocs.yml rename pages/{ => projects/docker-mail}/dkim.md (98%) create mode 100644 pages/projects/docker-mail/index.md rename pages/{ => projects/docker-mail}/spf.md (92%) create mode 100644 pages/projects/index.md create mode 160000 website-template diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 4ea9437..043d142 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -7,6 +7,7 @@ include: file: - .gitlab-ci_common.yaml - template/docker-image.gitlab-ci.yaml + - template/website.gitlab-ci.yaml variables: diff --git a/.gitmodules b/.gitmodules index cc4d8a5..de6bfdd 100644 --- a/.gitmodules +++ b/.gitmodules @@ -2,3 +2,7 @@ path = gitlab-ci url = https://gitlab.com/nofusscomputing/projects/gitlab-ci.git branch = development +[submodule "website-template"] + path = website-template + url = https://gitlab.com/nofusscomputing/infrastructure/website-template.git + branch = development diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..5f21c84 --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,57 @@ +INHERIT: website-template/mkdocs.yml + +repo_name: Gitlab-CI +repo_url: https://gitlab.com/nofusscomputing/projects/docker-mail +edit_uri: '/-/ide/project/nofusscomputing/projects/docker-mail/edit/development/-/pages/' + +nav: +- Home: index.md + +- Articles: + + - articles/index.md + +- Projects: + + - projects/index.md + + - Gitlab CI: + + - Build: + + - projects/gitlab-ci/mkdocs-build.md + + - Linting: + + - projects/gitlab-ci/markdown_lint.md + + - projects/gitlab-ci/yaml_lint.md + + - Templates: + + - projects/gitlab-ci/templates/index.md + + - projects/gitlab-ci/templates/ansible_roles.md + + - projects/gitlab-ci/templates/docker_container.md + + - projects/gitlab-ci/templates/website.md + + - Validation: + + - projects/gitlab-ci/conventional_commits.md + + - projects/gitlab-ci/index.md + + - projects/gitlab-ci/git_mirror.md + + - projects/gitlab-ci/gitlab_release.md + + - projects/gitlab-ci/python.md + +- Operations: + + - operations/index.md + +- Contact Us: contact.md + diff --git a/pages/dkim.md b/pages/projects/docker-mail/dkim.md similarity index 98% rename from pages/dkim.md rename to pages/projects/docker-mail/dkim.md index 22811af..69bf73c 100644 --- a/pages/dkim.md +++ b/pages/projects/docker-mail/dkim.md @@ -1,6 +1,9 @@ --- title: Amavis DKIM Signing configuration Description: How to configure DKIM for No Fuss Computings mail server. +date: 2022-02-16 +template: project.html +about: https://gitlab.com/nofusscomputing/projects/docker-mail --- To utilise DKIM message signing for outbound mail (leaving the server), you will need to configure dkim to use your certificates. @@ -19,6 +22,7 @@ $ amavisd-new genrsa /certs/amavis/dkim/example.org.dkim.pem 2048 # (1)! $ chmod g+r /certs/amavis/dkim/example.org.dkim.pem # (2)! $ chgrp amavis /certs/amavis/dkim/example.org.dkim.pem # (2)! + ``` 1. create your DKIM Key @@ -51,6 +55,7 @@ To configure amavis, you will be required to create a confiuguration file with y ``` conf title="/etc/amavis/conf.d/99-dkim-keys" + dkim_key( 'example.org', # (1)! 'dkim', # (2)! diff --git a/pages/projects/docker-mail/index.md b/pages/projects/docker-mail/index.md new file mode 100644 index 0000000..44b65f8 --- /dev/null +++ b/pages/projects/docker-mail/index.md @@ -0,0 +1,7 @@ +--- +title: No Fuss Computings Dockr Mail Server +description: How to use No Fuss Computings Dcokerized E-Mail Server +date: 2023-05-22 +template: project.html +about: https://gitlab.com/nofusscomputing/projects/docker-mail +--- diff --git a/pages/spf.md b/pages/projects/docker-mail/spf.md similarity index 92% rename from pages/spf.md rename to pages/projects/docker-mail/spf.md index fa90fc7..50abd2e 100644 --- a/pages/spf.md +++ b/pages/projects/docker-mail/spf.md @@ -1,6 +1,9 @@ --- title: SPF configuration Description: How to configure SPF for No Fuss Computings docker mail server. +date: 2022-02-17 +template: project.html +about: https://gitlab.com/nofusscomputing/projects/docker-mail --- Sender Policy Framework (SPF) is defined in [RFC7208, Sender Policy Framework (SPF) for Authorizing Use of Domains in Email](https://datatracker.ietf.org/doc/html/rfc7208). @@ -8,8 +11,10 @@ Sender Policy Framework (SPF) is defined in [RFC7208, Sender Policy Framework (S DNS SPF text record example: ``` text + IN TXT "v=spf1 mx a ip4:192.168.0.100 ip6:2001:ef3:2911::/64" " a:mail.example.org a:mail2.example.org -all" + ``` 1. `v=spf1` Version attribute. only v1 available. diff --git a/pages/projects/index.md b/pages/projects/index.md new file mode 100644 index 0000000..e69de29 diff --git a/website-template b/website-template new file mode 160000 index 0000000..cb55c6b --- /dev/null +++ b/website-template @@ -0,0 +1 @@ +Subproject commit cb55c6bdca3c2853996452b89504b7e58129ab6f