Sign inSign up

ascendntnu/upload-docs

By ascendntnu

•Updated over 8 years ago

Upload documents to our Confluence community.

Image
1

461

ascendntnu/upload-docs repository overview

⁠Generate DoxyGen docs to Confluence

This image can be used by anyone who wants to automate uploading of DoxyGen docs to an Confluence server through the Confluence Docs⁠ plugin.

⁠Usage

⁠Docker
docker run --rm \
    -e CRED={credentials} \
    -e CONFLUENCE_URL={url_to_confluence:-http://confluence.ascendntnu.no}
    -v `pwd`:/upload-docs \
    ascendntnu/upload-docs:1.0 {category} {document-name} {path/to/doxyfile:-./}
⁠Docker Compose
version: '3'

services:
  upload-docs:
    image: ascendntnu/upload-docs:latest
    environment:
      - CRED
      - CONFLUENCE_URL={CONFLUENCE_URL:-http://confluence.ascendntnu.no}
    volumes:
      - .:/upload-docs:rw
    command: {category} {document-name} {path/to/doxyfile:-./}
⁠Parameter description:
ParameterDescription
credentialsAn authorized user login.
url_to_confluenceIf you use a custom Confluence server, then you are free to do so. If not set, this default to http://confluence.ascendntnu.no⁠.
categoryUsed by plugin on Confluence to identify a category.
document-nameThe name used in the category on Confluence for identifying a document.
path/to/doxyfileThis is the path to the Doxyfile in the project. We can read everything else from this file, so it is very important to spesify. The default path is the root of the project.

Tag summary

Content type

Image

Digest

Size

18.6 MB

Last updated

over 8 years ago

docker pull ascendntnu/upload-docs