Skip to content

Latest commit

 

History

History
31 lines (19 loc) · 1.22 KB

README.adoc

File metadata and controls

31 lines (19 loc) · 1.22 KB
Raw

Confluence to AsciiDoc Exporter

This project contains a Python program that connects to a Confluence wiki and reads a series of page (referenced by their IDs), printing the output to the console.

It requires:

Security

This tool requires the username and password of a valid user to access the Confluence wiki. The values are passed to the tool as environment variables:

  • CONFLUENCE_USERNAME

  • CONFLUENCE_PASSWORD

Container Image

The Dockerfile bundled is used to create the vshn/asciidoctor-confluence-exporter image, which can be used as follows:

podman run --rm --env-file credentials --volume "${PWD}":/data ghcr.io/vshn/asciidoctor-confluence-exporter:1.2 --wiki=https://wiki.url 123 45 6789 --verbose

In the command above, "123", "45" and "6789" are valid page IDs in the Confluence wiki located in "wiki.url". The --help parameter provides more information about the use of the tool.

Also, in the example above, the container runtime passes the environment variables through a file simply named credentials, which might look like this:

CONFLUENCE_USERNAME=your.username
CONFLUENCE_PASSWORD=y0uR.p@ssw0Rd