From 442c4da0703c01dfe3c4bc2bb4b6ee4e04efafc4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Yannik=20R=C3=B6del?= Date: Sun, 12 Jun 2022 17:59:06 +0200 Subject: [PATCH] Add deployment documentation --- README.md | 22 ++++++++++++++++++---- 1 file changed, 18 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index e312f0b..691e313 100644 --- a/README.md +++ b/README.md @@ -16,11 +16,11 @@ Note that this repository contains code to build different sites with some share - **playground/** – This directory contains anything that shouldn't be included directly but might be relevant to the project. - **sites/** – Each site gets a subdirectory here containing its content. - **<name>** - - **_assets/** – Site-specific static content. This will also be copied into the `assets` directory of the final output. - - **_data/** – Directory for Eleventy [global data files](https://www.11ty.dev/docs/data-global/). - - **_images/** – Place images that should be rendered by the build system in some way here. + - **\_assets/** – Site-specific static content. This will also be copied into the `assets` directory of the final output. + - **\_data/** – Directory for Eleventy [global data files](https://www.11ty.dev/docs/data-global/). + - **\_images/** – Place images that should be rendered by the build system in some way here. - **httpd.conf** – Configuration file for [lighttpd](https://redmine.lighttpd.net/projects/lighttpd/wiki#Documentation), which will serve the final site. - - *Anything else* is actual content for the site (usually in the form of markdown files). + - _Anything else_ is actual content for the site (usually in the form of markdown files). - **styles/** – SCSS stylesheets. Anything directly in this directory that doesn't begin with an underscore will be available in the final build. - **.eleventy.js** – Base Eleventy configuration. This is set up so that the correct paths for the selected site (according to the environment variable `SITE`) are selected automatically. - **.eleventyignore** – Eleventy ignore file. Place paths in here that should be excluded in the final build. @@ -58,3 +58,17 @@ The flake also contains a second package for building the production output: ```shell nix build # Will create an output derivation in 'result' ``` + +## Deployment + +Deploy the container from the image automatically by the CI server. +Ask @yrd for the URL. + +The container will expose the site under port 80. +Further configuration is available via environment variables. + +- `ZAMMAD_URL=https://ticket.z31.it` – URL of the Zammad server to use. +- `ZAMMAD_GROUP=` – Set this variable to override the group all Zammad tickets go in. If empty (the default), different forms will be sorted into different groups. +- `ZAMMAD_TOKEN` – This is the only mandatory option. Set it to a Zammad access token with the `ticket.agent` permission. + +See https://codeberg.org/angestoepselt/homepage/issues/6#issuecomment-419104 for details.