The Joomla Packager
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Llewellyn van der Merwe 4054508729
Fixed the version mismatch.
11 months ago
src Fixed the version mismatch. 11 months ago
.gitignore Initial commit of OctoJpack 11 months ago
LICENSE Initial commit of OctoJpack 11 months ago
README.md Initial commit of OctoJpack 11 months ago

README.md

Octojpack - Easy Joomla Extension Packaging

With this script we can easily package multiple extensions in an automated way from a json configuration file, and environment variables.

program only for ubuntu/debian and Gitea systems at this time (should you like to use it on other OS's please open and issue...)


Install

$ sudo curl -L "https://git.vdm.dev/api/v1/repos/octoleo/octojpack/raw/src/octojpack" -o /usr/local/bin/octojpack
$ sudo chmod +x /usr/local/bin/octojpack

Usage

To see the help menu

$ octojpack -h

Help Menu (octojpack)

Usage: octojpack [OPTION...]
	Options
	======================================================
   -p | --packager=<packager Name>
	Packager name
	example: octojpack -p="Vast Development Method"
	======================================================
   -pu | --packager-url=<//packager.url>
	Packager url
	example: octojpack -pu="https://git.vdm.dev/"
	======================================================
   -e | --env=<file>
	load the environment variables file
	example: octojpack --env=/src/.env
	======================================================
   --conf | --config=<path>
	load the configuration for the package in json format
	   file-example: src/example.json
	example: octojpack --config=config.json
	======================================================
   -t | --token=<access_token>
	load the global token
	example: octojpack --token=xxxxxxxxxxxxxxxxxxxxxxxxx
	======================================================
   -u | --url=<gitea>
	Global url of the Gitea instance
	example: octojpack --url="git.vdm.dev"
	======================================================
   -a | --api=<//gitea.api>
	Global api of the Gitea instance
	example: octojpack --api="https://git.vdm.dev/api/v1"
	======================================================
   -q | --quiet
	mute all output messages
	example: octojpack --quiet
	======================================================
   --update
	to update your install
	example: octojpack --update
	======================================================
   --uninstall
	to uninstall this script
	example: octojpack --uninstall
	======================================================
   -h|--help
	display this help menu
	example: octojpack -h
	example: octojpack --help
	======================================================
			Octojpack v1.0
	======================================================

Local Environment Variables File

Give the path to your .env file to the program like this:

$ octojpack --env="/home/username/.config/octojpack/custom.env"

Or with an environment variable you set before using the program like this:

$ export VDM_ENV_FILE_PATH="/home/username/.config/octojpack/custom.env"

Default path is: /home/$USER/.config/octojpack/.env

API ACCESS TOKEN (never share your token)

You can set your API access token for Gitea via the .env file like this:

VDM_GLOBAL_TOKEN="xxxxxxxxxxxxxxxxxxxxxxxxx"

Or you can pass the token directly to the script like this:

$ octojpack --token="xxxxxxxxxxxxxxxxxxxxxxxxx"

Or with an environment variable you set before using the program like this:

$ export VDM_GLOBAL_TOKEN="xxxxxxxxxxxxxxxxxxxxxxxxx"

Configuration File

To see the example of the json configuration options check out src/example.json.

You can set your configuration file path via the .env file like this:

VDM_PACKAGE_CONF_FILE="/home/username/.config/octojpack/package_name_config.json"

Or you can pass it to the program by URL:

$ octojpack --conf="https://git.vdm.dev/api/v1/repos/octoleo/octojpack/raw/src/example.json"

Or via a local file path:

$ octojpack --conf="/home/username/.config/octojpack/package_name_config.json"

Or with an environment variable you set before using the program like this:

$ export VDM_PACKAGE_CONF_FILE="/home/username/.config/octojpack/package_name_config.json"

Uninstall

$ octojpack --uninstall

Free Software License

@copyright  Copyright (C) 2021 Llewellyn van der Merwe. All rights reserved.
@license    GNU General Public License version 2; see LICENSE