FunctionalHacker/forgejo-asciidoc
FunctionalHacker/forgejo-asciidoc
1
0
Fork 0
Code Issues Pull requests Actions Packages Releases Activity
Forgejo with AsciiDoc support https://forgejo.org
71 commits 1 branch 0 tags 92 KiB
Dockerfile 100%
Go to file
Marko Korhonen bd2aa1d13f
All checks were successful
Build Docker image / Build image (push) Successful in 48s
Details
Update to 7.0
2024-04-24 22:31:08 +03:00
.forgejo/workflows Update to 7.0 2024-04-24 22:31:08 +03:00
.dockerignore Add dockerignore 2022-06-11 15:20:28 +03:00
Dockerfile Implement automatic build when upstream updates 2024-02-25 00:04:36 +02:00
README.adoc Fixes to README 2024-04-04 08:49:48 +03:00

README.adoc

Forgejo with AsciiDoc support

Table of Contents

Motivation

The official Forgejo Docker image does not support AsciiDoc rendering, so I wanted to create an image which has all the needed dependencies out of the box.

Pull from my Forgejo instance

Visit the packages section for more information. The server is running behind 4G broadband so it might be a bit slow to download. Consider pulling the other layers first from the official image to speed up the download.

Configuration

In addition to pulling this image instead of the official one, you need to configure the renderer. You can follow the official docs to achieve that.

Configuration in use on this Forgejo instance 
[markup.asciidoc]
ENABLED = true
FILE_EXTENSIONS = .adoc,.asciidoc
RENDER_COMMAND = "asciidoctor -b html5 -s -a skip-front-matter -a showtitle -a source-highlighter=rouge -a allow-uri-read -a toc --embedded --safe-mode server -o - -"
IS_INPUT_FILE = false

Updates

The image will be built automatically when I make changes to it, or every day at midnight EET/EEST if there are new patch releases available upstream. Forgejo doesn’t supply a latest tag so whenever there is a new major (X.y) or minor (y.X) release, I will have to manually update it when I have to time, so there might be a longer delay in those cases.

If you want to get notified when there is a new version available, you can subscribe to the Korhonen.cc News Telegram channel. A notification will be sent there whenever a new image is built.

Tags

Images are tagged following upstream versioning, with the addition of the latest tag for convenience. As mentioned in the previous section, Forgejo doesn’t support or encourage the usage of the latest tag, because upgrades might require manual intervention. If you decide to use the latest tag, be sure to read the upstream release notes before upgrading.

  • latest - The latest available release from upstream

  • x.y - The latest release for any given minor version

  • x.y.z - A patch release

Support

This image comes with no support whatsoever. The Dockerfile is based on the official Forgejo image and it is literally 3 lines long and only one layer on top of upstream so there is not much to go wrong here. If, for whatever reason you feel that there must be something wrong with my image, you can open a new issue in this repository.