Compare commits
33 Commits
Author | SHA1 | Date | |
---|---|---|---|
ed147ece9e | |||
8cf856b35e | |||
1a83002c9d | |||
e627e7f4cd | |||
eaa5b217c8 | |||
b7973a0011 | |||
0d2649601a | |||
9566019630 | |||
2ca0fc61ce | |||
69f00e830e | |||
42c85ba582 | |||
67d808b40a | |||
0b01021137 | |||
81af237052 | |||
fad4a7cf6e | |||
7aa661aea4 | |||
f6d35ae9f7 | |||
4092c4beb5 | |||
af87697943 | |||
99d95c4d84 | |||
603804af74 | |||
ea1ff59177 | |||
5255b7bb25 | |||
fedcfc7c4f | |||
76db2f477b | |||
2918326c8c | |||
6a27e23f02 | |||
e55f4a31bc | |||
9535c3b74d | |||
a1f7c8fa39 | |||
e4a4714b0a | |||
66d20ef68d | |||
0dafdf00e1 |
89
README.md
89
README.md
|
@ -1,4 +1,9 @@
|
||||||
# Easy Docker Deployment (UBUNTU ONLY)
|
<h2><img align="middle" src="https://raw.githubusercontent.com/odb/official-bash-logo/master/assets/Logos/Icons/PNG/64x64.png" >
|
||||||
|
Octojoom - Easy Joomla! Docker Deployment
|
||||||
|
</h2>
|
||||||
|
|
||||||
|
Written by Llewellyn van der Merwe (@llewellynvdm)
|
||||||
|
|
||||||
With this script we can easily deploy docker containers of Joomla and Openssh. This combination of these tools give rise to a powerful and very secure shared development environment.
|
With this script we can easily deploy docker containers of Joomla and Openssh. This combination of these tools give rise to a powerful and very secure shared development environment.
|
||||||
|
|
||||||
This program has **command input** options as seen in the menus below, but these command are _not the only way_ to set these values.
|
This program has **command input** options as seen in the menus below, but these command are _not the only way_ to set these values.
|
||||||
|
@ -8,40 +13,36 @@ There are more than one .env file and the script will set those up for you whene
|
||||||
the script will check if those values exist, and if they don't it will ask for them, and store them automatically for future use.
|
the script will check if those values exist, and if they don't it will ask for them, and store them automatically for future use.
|
||||||
That same time the output message to the terminal will show you where the specific .env file can be found.
|
That same time the output message to the terminal will show you where the specific .env file can be found.
|
||||||
|
|
||||||
|
Linted by [#ShellCheck](https://github.com/koalaman/shellcheck)
|
||||||
|
|
||||||
|
> program only for ubuntu/debian systems at this time (should you like to use it on other OS's please open and issue...)
|
||||||
|
|
||||||
---
|
---
|
||||||
# Install
|
# Install
|
||||||
```shell
|
```shell
|
||||||
$ sudo curl -L "https://git.vdm.dev/api/v1/repos/octoleo/docker-deploy/raw/src/docker-deploy?access_token=xxxx" -o /usr/local/bin/docker-deploy
|
$ sudo curl -L "https://git.vdm.dev/api/v1/repos/octoleo/octojoom/raw/src/octojoom" -o /usr/local/bin/octojoom
|
||||||
$ sudo chmod +x /usr/local/bin/docker-deploy
|
$ sudo chmod +x /usr/local/bin/octojoom
|
||||||
```
|
```
|
||||||
|
|
||||||
### How to get the Access Token
|
|
||||||
Sign in to [https://git.vdm.dev/](https://git.vdm.dev/user/login) with your **GitHub** or **Gitlab** account.
|
|
||||||
Then open your [applications settings](https://git.vdm.dev/user/settings/applications) and create a new access token.
|
|
||||||
|
|
||||||
![image](https://user-images.githubusercontent.com/5607939/143513412-946843be-acd8-4973-be44-00902226f6ba.png)
|
|
||||||
|
|
||||||
The first time you use the program, it will ask for the access token again, so it can do updates in the future.
|
|
||||||
|
|
||||||
---
|
---
|
||||||
# Usage
|
# Usage
|
||||||
|
|
||||||
> To see the usage help menu
|
> To see the usage help menu
|
||||||
```shell
|
```shell
|
||||||
$ docker-deploy -h
|
$ octojoom -h
|
||||||
```
|
```
|
||||||
### Help Menu (docker-deploy)
|
### Help Menu (octojoom)
|
||||||
```txt
|
```txt
|
||||||
Usage: docker-deploy [OPTION...]
|
Usage: octojoom [OPTION...]
|
||||||
Options
|
Options
|
||||||
======================================================
|
======================================================
|
||||||
--type <type>
|
--type <type>
|
||||||
set type you would like to work with
|
set type you would like to work with
|
||||||
example: docker-deploy --type joomla
|
example: octojoom --type joomla
|
||||||
======================================================
|
======================================================
|
||||||
--task <task>
|
--task <task>
|
||||||
set type of task you would like to perform
|
set type of task you would like to perform
|
||||||
example: docker-deploy --task setup
|
example: octojoom --task setup
|
||||||
======================================================
|
======================================================
|
||||||
--container <container.domain.name>
|
--container <container.domain.name>
|
||||||
Directly enabling or disabling a container with
|
Directly enabling or disabling a container with
|
||||||
|
@ -49,74 +50,74 @@ Usage: docker-deploy [OPTION...]
|
||||||
The container must exist, which means it was
|
The container must exist, which means it was
|
||||||
setup previously
|
setup previously
|
||||||
Used without type and task Joomla-Enable is (default)
|
Used without type and task Joomla-Enable is (default)
|
||||||
example: docker-deploy --container "io.vdm.dev"
|
example: octojoom --container "io.vdm.dev"
|
||||||
======================================================
|
======================================================
|
||||||
--update
|
--update
|
||||||
to update your install
|
to update your install
|
||||||
example: docker-deploy --update
|
example: octojoom --update
|
||||||
======================================================
|
======================================================
|
||||||
--access-token <token>
|
--access-token <token>
|
||||||
to update the program you will need an access token
|
to update the program you will need an access token
|
||||||
from https://git.vdm.dev/user/settings/applications
|
from https://git.vdm.dev/user/settings/applications
|
||||||
example: docker-deploy --access-token xxxxxxxxxxx
|
example: octojoom --access-token xxxxxxxxxxx
|
||||||
======================================================
|
======================================================
|
||||||
--uninstall
|
--uninstall
|
||||||
to uninstall this script
|
to uninstall this script
|
||||||
example: docker-deploy --uninstall
|
example: octojoom --uninstall
|
||||||
======================================================
|
======================================================
|
||||||
AVAILABLE FOR TO ANY CONTAINER
|
AVAILABLE FOR TO ANY CONTAINER
|
||||||
======================================================
|
======================================================
|
||||||
-k|--key <key>
|
-k|--key <key>
|
||||||
set key for the docker compose container naming
|
set key for the docker compose container naming
|
||||||
!! no spaces allowed in the key !!
|
!! no spaces allowed in the key !!
|
||||||
example: docker-deploy -k="vdm"
|
example: octojoom -k="vdm"
|
||||||
example: docker-deploy --key="vdm"
|
example: octojoom --key="vdm"
|
||||||
======================================================
|
======================================================
|
||||||
-e|--env-key <key>
|
-e|--env-key <key>
|
||||||
set key for the environment variable naming
|
set key for the environment variable naming
|
||||||
!! no spaces allowed in the key & must be UPPERCASE !!
|
!! no spaces allowed in the key & must be UPPERCASE !!
|
||||||
example: docker-deploy -e="VDM"
|
example: octojoom -e="VDM"
|
||||||
example: docker-deploy --env-key="VDM"
|
example: octojoom --env-key="VDM"
|
||||||
======================================================
|
======================================================
|
||||||
-d|--domain <domain.com>
|
-d|--domain <domain.com>
|
||||||
set key website domain
|
set key website domain
|
||||||
!! must be domain.tld !!
|
!! must be domain.tld !!
|
||||||
example: docker-deploy -d="joomla.org"
|
example: octojoom -d="joomla.org"
|
||||||
example: docker-deploy --domain="joomla.org"
|
example: octojoom --domain="joomla.org"
|
||||||
======================================================
|
======================================================
|
||||||
-s|--sub-domain <domain.com>
|
-s|--sub-domain <domain.com>
|
||||||
set key website sub domain
|
set key website sub domain
|
||||||
!! no spaces allowed in the sub domain !!
|
!! no spaces allowed in the sub domain !!
|
||||||
example: docker-deploy -s="jcb"
|
example: octojoom -s="jcb"
|
||||||
example: docker-deploy --sub-domain="jcb"
|
example: octojoom --sub-domain="jcb"
|
||||||
======================================================
|
======================================================
|
||||||
AVAILABLE FOR JOOMLA CONTAINER
|
AVAILABLE FOR JOOMLA CONTAINER
|
||||||
======================================================
|
======================================================
|
||||||
-j|--joomla-version <version-tag>
|
-j|--joomla-version <version-tag>
|
||||||
see available tags here https://hub.docker.com/_/joomla
|
see available tags here https://hub.docker.com/_/joomla
|
||||||
example: docker-deploy -j=3.10
|
example: octojoom -j=5.0
|
||||||
example: docker-deploy --joomla-version=3.10
|
example: octojoom --joomla-version=5.0
|
||||||
======================================================
|
======================================================
|
||||||
AVAILABLE FOR OPENSSH CONTAINER
|
AVAILABLE FOR OPENSSH CONTAINER
|
||||||
======================================================
|
======================================================
|
||||||
-u|--username <username>
|
-u|--username <username>
|
||||||
set username of the container
|
set username of the container
|
||||||
example: docker-deploy -u="ubuntu"
|
example: octojoom -u="ubuntu"
|
||||||
example: docker-deploy --username="ubuntu"
|
example: octojoom --username="ubuntu"
|
||||||
======================================================
|
======================================================
|
||||||
--uid <id>
|
--uid <id>
|
||||||
set container user id
|
set container user id
|
||||||
example: docker-deploy --uid=1000
|
example: octojoom --uid=1000
|
||||||
======================================================
|
======================================================
|
||||||
--gid <id>
|
--gid <id>
|
||||||
set container user group id
|
set container user group id
|
||||||
example: docker-deploy --gid=1000
|
example: octojoom --gid=1000
|
||||||
======================================================
|
======================================================
|
||||||
-p|--port <port>
|
-p|--port <port>
|
||||||
set ssh port to use
|
set ssh port to use
|
||||||
!! do not use 22 !!
|
!! do not use 22 !!
|
||||||
example: docker-deploy -p=2239
|
example: octojoom -p=2239
|
||||||
example: docker-deploy --port=2239
|
example: octojoom --port=2239
|
||||||
======================================================
|
======================================================
|
||||||
--ssh-dir <dir>
|
--ssh-dir <dir>
|
||||||
set ssh directory name found in the .ssh dir
|
set ssh directory name found in the .ssh dir
|
||||||
|
@ -124,34 +125,34 @@ Usage: docker-deploy [OPTION...]
|
||||||
This directory has separate files for
|
This directory has separate files for
|
||||||
each public key allowed to access
|
each public key allowed to access
|
||||||
the container
|
the container
|
||||||
example: docker-deploy --ssh-dir="teamname"
|
example: octojoom --ssh-dir="teamname"
|
||||||
======================================================
|
======================================================
|
||||||
--sudo
|
--sudo
|
||||||
switch to add the container user to the
|
switch to add the container user to the
|
||||||
sudo group of the container
|
sudo group of the container
|
||||||
example: docker-deploy --sudo
|
example: octojoom --sudo
|
||||||
======================================================
|
======================================================
|
||||||
-t|--time-zone <time/zone>
|
-t|--time-zone <time/zone>
|
||||||
set time zone of the container
|
set time zone of the container
|
||||||
!! must valid time zone !!
|
!! must valid time zone !!
|
||||||
example: docker-deploy -t="Africa/Windhoek"
|
example: octojoom -t="Africa/Windhoek"
|
||||||
example: docker-deploy --time-zone="Africa/Windhoek"
|
example: octojoom --time-zone="Africa/Windhoek"
|
||||||
======================================================
|
======================================================
|
||||||
HELP ʕ•ᴥ•ʔ
|
HELP ʕ•ᴥ•ʔ
|
||||||
======================================================
|
======================================================
|
||||||
-h|--help
|
-h|--help
|
||||||
display this help menu
|
display this help menu
|
||||||
example: docker-deploy -h
|
example: octojoom -h
|
||||||
example: docker-deploy --help
|
example: octojoom --help
|
||||||
======================================================
|
======================================================
|
||||||
Docker Deployment v2.1.0
|
Octojoom
|
||||||
======================================================
|
======================================================
|
||||||
```
|
```
|
||||||
---
|
---
|
||||||
# Uninstall
|
# Uninstall
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
$ docker-deploy --uninstall
|
$ octojoom --uninstall
|
||||||
```
|
```
|
||||||
---
|
---
|
||||||
# Free Software License
|
# Free Software License
|
||||||
|
|
File diff suppressed because it is too large
Load Diff
Loading…
Reference in New Issue
Block a user