https://github.com/vshn/asciidoctor-confluence-exporter

Command and Docker image to export Confluence wiki content to AsciiDoc
https://github.com/vshn/asciidoctor-confluence-exporter

asciidoc asciidoctor confluence vshn-project-ignore

Last synced: 3 months ago
JSON representation

Command and Docker image to export Confluence wiki content to AsciiDoc

• Host: GitHub
• URL: https://github.com/vshn/asciidoctor-confluence-exporter
• Owner: vshn
• License: bsd-3-clause
• Created: 2020-04-03T14:58:44.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2024-10-23T17:39:17.000Z (12 months ago)
• Last Synced: 2024-10-24T01:39:14.331Z (12 months ago)
• Topics: asciidoc, asciidoctor, confluence, vshn-project-ignore
• Language: Python
• Homepage:
• Size: 78.1 KB
• Stars: 5
• Watchers: 4
• Forks: 1
• Open Issues: 6
• Metadata Files:
  • Readme: README.adoc
  • License: LICENSE

Awesome Lists containing this project

README

          
= Confluence to AsciiDoc Exporter

This project contains a Python program that connects to a https://www.atlassian.com/software/confluence[Confluence] wiki and reads a series of page (referenced by their IDs), printing the output to the console.

It requires:

* Python 3

* https://pandoc.org/[Pandoc]

== 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:

[source]

----

CONFLUENCE_USERNAME=your.username

CONFLUENCE_PASSWORD=y0uR.p@ssw0Rd

----