= Forgejo with AsciiDoc support

== 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 link:/FunctionalHacker/-/packages/container/forgejo-asciidoc/latest[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 link:https://codeberg.org/forgejo/-/packages/container/forgejo/versions[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 link:https://forgejo.org/docs/latest/admin/config-cheat-sheet/#markup-markup[official docs] to achieve that.

.Configuration in use on this Forgejo instance
[%collapsible]
====
[source,ini]
----
[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 link:/FunctionalHacker/forgejo-asciidoc/actions[built automatically] when I make changes to it,
or every day at midnight EET if there are new patch releases available upstream.
link:https://codeberg.org/forgejo/forgejo/issues/984[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 link:https://t.me/korhonen_cc[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 xref:updates[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 link:https://codeberg.org/forgejo/forgejo/src/branch/forgejo/RELEASE-NOTES.md#1-21-6-0[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 link:/FunctionalHacker/forgejo-asciidoc/issues/new[open a new issue] in this repository.
