From f85a50d8c99077bc6f0f915a964a85eac61557b4 Mon Sep 17 00:00:00 2001 From: Philipp Matthes Date: Fri, 23 Feb 2024 13:12:17 +0100 Subject: [PATCH] Replace old link to kaestner/latex with working one - Closes: #9 --- .vscode/settings.json | 2 +- Dockerfile | 2 +- Makefile | 2 +- README.md | 8 ++------ 4 files changed, 5 insertions(+), 9 deletions(-) diff --git a/.vscode/settings.json b/.vscode/settings.json index c132516..ce2b136 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -6,6 +6,6 @@ "ltex.additionalRules.enablePickyRules": true, "ltex.checkFrequency": "edit", "latex-workshop.docker.enabled": true, - "latex-workshop.docker.image.latex": "kaestner/latex", + "latex-workshop.docker.image.latex": "ghcr.io/felix-kaestner/latex:1.0", "latex-workshop.latex.autoBuild.run": "never" } \ No newline at end of file diff --git a/Dockerfile b/Dockerfile index caa1108..9759c2b 100644 --- a/Dockerfile +++ b/Dockerfile @@ -2,7 +2,7 @@ ARG USER_ID=1000 ARG USER_NAME=latex ARG USER_HOME=/home/latex ARG USER_GECOS=LaTeX -ARG BASE_IMAGE=kaestner/latex +ARG BASE_IMAGE=ghcr.io/felix-kaestner/latex:1.0 FROM ${BASE_IMAGE} as latex diff --git a/Makefile b/Makefile index 59d5bb1..89ae555 100644 --- a/Makefile +++ b/Makefile @@ -4,7 +4,7 @@ DIR:=$(shell sh -c "pwd") USER_ID:=$(shell sh -c "id -u") USER_NAME:=$(shell sh -c "id -u -n") USER_HOME:=/home/latex -BASE_IMAGE:=kaestner/latex +BASE_IMAGE:=ghcr.io/felix-kaestner/latex:1.0 DOCKER_IMAGE:=mustermann/latex # Check if any of the args are empty. diff --git a/README.md b/README.md index f47322d..3aa6b91 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,6 @@ # better-tudscr A template for the tudscr (TUD-Script) LaTeX package. Contains an initial template for any thesis and a containerized build environment with Docker, so that you don’t have to fiddle around with the installation of LaTeX. Just build the Docker image _once_ in advance and use it to build your thesis. -## ⚠️ Help wanted - Docker build currently not functional - -Please see the Issues section of this repository, to help improve this template. Currently, the Docker image `kaestner/latex` seems to be no longer available, meaning that we have to upgrade to another image. In the meantime, this repository can still be used as a basic template for your LaTeX-based TU Dresden thesis. - ## Quickstart 1. Build the Docker image _once_ with `make container`. @@ -51,7 +47,7 @@ The following workspace settings are defined in `.vscode/settings.json`: - `"ltex.additionalRules.enablePickyRules": true` - enables warnings for picky rules such as passive voice or sentence length. - `"ltex.checkFrequency": "edit"` - will check spelling and grammar while you are typing. If you want you can set this value to `save`, if you only want to check after you saved the file. - `"latex-workshop.docker.enabled": true` - enables to docker mode of the `latex-workshop` extension. Thus, no local installation of LaTeX is needed, since it will use docker to build the thesis. -- `"latex-workshop.docker.image.latex": "kaestner/latex"` - defines the docker image, which is used to build the thesis using the `latex-workshop` extension. This will be [kaestner/latex](https://hub.docker.com/repository/docker/kaestner/latex) +- `"latex-workshop.docker.image.latex": "ghcr.io/felix-kaestner/latex:1.0"` - defines the docker image, which is used to build the thesis using the `latex-workshop` extension. This will be [felix-kaestner/latex](https://github.com/felix-kaestner/latex) - `"latex-workshop.latex.autoBuild.run": "never"` - disables automatic runs of the `latex-workshop` extension. You can manually trigger a build by using the command prompt in VS Code or by clicking on the Play-Button in the top right. ### Explanation @@ -60,4 +56,4 @@ Instead of keeping a local copy of LaTeX, this repository simplifies the process In order to avoid user permission problems, you build a custom docker image _once_ in advance, which will create a user which has the same name and user ID as your local user on your machine. As a result there will be no problems, since the files will have the correct permissions set. -This repository uses [kaestner/latex](https://hub.docker.com/repository/docker/kaestner/latex) as the base docker image which is created by [Felix Kästner](https://felix-kaestner.com) over [here](https://github.com/felix-kaestner/latex). This image is only 1.3GB in size, which results in faster build times using the CI. +This repository uses [felix-kaestner/latex](https://github.com/felix-kaestner/latex) as the base docker image which is created by [Felix Kästner](https://felix-kaestner.com) over [here](https://github.com/felix-kaestner/latex). This image is only 1.3GB in size, which results in faster build times using the CI.