forgejo-asciidoc/README.adoc

55 lines
2.8 KiB
Plaintext
Raw Normal View History

2022-12-17 15:08:35 +02:00
= Forgejo with AsciiDoc support
2022-06-11 15:10:57 +03:00
2024-02-28 19:29:48 +02:00
== 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.
2022-06-09 19:37:48 +03:00
2022-12-17 15:08:35 +02:00
== Pull from my Forgejo instance
2024-02-28 19:29:48 +02:00
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.
2022-06-09 20:13:10 +03:00
2022-06-09 19:37:48 +03:00
== Configuration
2024-02-28 19:29:48 +02:00
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]
----
2024-02-28 19:29:48 +02:00
[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
----
====
2022-06-09 19:37:48 +03:00
== Updates
2024-02-28 19:29:48 +02:00
The image will be link:/FunctionalHacker/forgejo-asciidoc/actions[built automatically] when I make changes to it,
2024-04-04 08:49:48 +03:00
or every day at midnight EET/EEST if there are new patch releases available upstream.
2024-02-28 19:29:48 +02:00
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.
2024-04-04 08:49:48 +03:00
2024-02-28 19:29:48 +02:00
* `latest` - The latest available release from upstream
* `x.y` - The latest release for any given minor version
* `x.y.z` - A patch release
2022-06-09 19:37:48 +03:00
== Support
2024-02-28 19:29:48 +02:00
2022-06-09 19:37:48 +03:00
This image comes with no support whatsoever. The Dockerfile is based on the
2024-02-28 19:29:48 +02:00
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.