Skip to content

itdevsamurai/atlassian-plugin-remote-install

Repository files navigation

Atlassian Plugin Remote Install

Publish Docker Image

Remotely install Atlassian plugins to Jira, Confluence server/datacenter/cloud.

Documentation

Usage

Quick Start

docker run --rm -i \
    --pull=always \
    ghcr.io/itdevsamurai/atlassian-plugin-remote-install \
    install-plugin-server \
    -url https://jira.example.com \
    -u username \
    -p passwordhere \
    -n "slack://xoxb-token-here/#channel-name-here" \
    - < path/plugin-file.obr

This command will install plugin from path/plugin-file.obr to Jira instance https://jira.example.com with credentials username/passwordhere.

It will then notify you via Slack on channel #channel-name-here

For more info about commands & options, see CLI reference

Notification

Powered by Apprise, it supports a large number of services (SMS, email, Slack, Discord, Teams...)

See the list & configuration URL here: Apprise Wiki

In pipelines

Can be used in Bitbucket, Github Actions... to quickly build your plugin & deploy to staging instance.

See Pipelines

Non-Docker

See CONTRIBUTING to install the dependencies.

Invoke python src/main.py to see help.

Environment Variables

Only if you don't want to use arguments in the CLI.

  • LOG_LEVEL: log level, defaults to INFO
  • ATLAS_URL: base url of Atlassian instance. Can be override in command option.
  • ATLAS_USERNAME: username to login to Atlassian instance. Can be override in command option.
  • ATLAS_PASSWORD: password to login to Atlassian instance. Can be override in command option.

Supported platform

Our main focus is using it on pipelines via Docker image and it is hosted on Github Package.

Docker tags:

  • latest: latest stable release.
  • main: latest build on main branch. This is a beta build.
  • Semver tags (0.4.0, 0.3.1...): for archiving purpose, can be used to rollback if you have any issue with stable build.

Supported arch: amd64, arm64, arm/v7, arm/v6

Feature status

Status:

  • Server/datacenter
    • Jira
    • Confluence
  • Cloud
    • Jira
    • Confluence

Contributing

See CONTRIBUTING for development setup & contributing guide.