163 lines
6.2 KiB
Markdown
163 lines
6.2 KiB
Markdown
# Easy Docker Deployment (UBUNTU ONLY)
|
|
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.
|
|
When the values are **omitted** you will be _asked in the terminal_ to manually enter the required values as needed.
|
|
Furthermore, the use of **env variables** are also heavily used across the script.
|
|
There are more than one .env file and the script will set those up for you whenever you run a task that make use of env variables
|
|
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.
|
|
|
|
---
|
|
# Install
|
|
```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 chmod +x /usr/local/bin/docker-deploy
|
|
```
|
|
|
|
### 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.
|
|
|
|
|
|
|
|
The first time you use the program, it will ask for the access token again, so it can do updates in the future.
|
|
|
|
---
|
|
# Usage
|
|
|
|
> To see the usage help menu
|
|
```shell
|
|
$ docker-deploy -h
|
|
```
|
|
### Help Menu (docker-deploy)
|
|
```txt
|
|
Usage: docker-deploy [OPTION...]
|
|
Options
|
|
======================================================
|
|
--type <type>
|
|
set type you would like to work with
|
|
example: docker-deploy --type joomla
|
|
======================================================
|
|
--task <task>
|
|
set type of task you would like to perform
|
|
example: docker-deploy --task setup
|
|
======================================================
|
|
--container <container.domain.name>
|
|
Directly enabling or disabling a container with
|
|
the type=joomla and task=enable/disable set
|
|
The container must exist, which means it was
|
|
setup previously
|
|
Used without type and task Joomla-Enable is (default)
|
|
example: docker-deploy --container "io.vdm.dev"
|
|
======================================================
|
|
--update
|
|
to update your install
|
|
example: docker-deploy --update
|
|
======================================================
|
|
--access-token <token>
|
|
to update the program you will need an access token
|
|
from https://git.vdm.dev/user/settings/applications
|
|
example: docker-deploy --access-token xxxxxxxxxxx
|
|
======================================================
|
|
--uninstall
|
|
to uninstall this script
|
|
example: docker-deploy --uninstall
|
|
======================================================
|
|
AVAILABLE FOR TO ANY CONTAINER
|
|
======================================================
|
|
-k|--key <key>
|
|
set key for the docker compose container naming
|
|
!! no spaces allowed in the key !!
|
|
example: docker-deploy -k="vdm"
|
|
example: docker-deploy --key="vdm"
|
|
======================================================
|
|
-e|--env-key <key>
|
|
set key for the environment variable naming
|
|
!! no spaces allowed in the key & must be UPPERCASE !!
|
|
example: docker-deploy -e="VDM"
|
|
example: docker-deploy --env-key="VDM"
|
|
======================================================
|
|
-d|--domain <domain.com>
|
|
set key website domain
|
|
!! must be domain.tld !!
|
|
example: docker-deploy -d="joomla.org"
|
|
example: docker-deploy --domain="joomla.org"
|
|
======================================================
|
|
-s|--sub-domain <domain.com>
|
|
set key website sub domain
|
|
!! no spaces allowed in the sub domain !!
|
|
example: docker-deploy -s="jcb"
|
|
example: docker-deploy --sub-domain="jcb"
|
|
======================================================
|
|
AVAILABLE FOR JOOMLA CONTAINER
|
|
======================================================
|
|
-j|--joomla-version <version-tag>
|
|
see available tags here https://hub.docker.com/_/joomla
|
|
example: docker-deploy -j=3.10
|
|
example: docker-deploy --joomla-version=3.10
|
|
======================================================
|
|
AVAILABLE FOR OPENSSH CONTAINER
|
|
======================================================
|
|
-u|--username <username>
|
|
set username of the container
|
|
example: docker-deploy -u="ubuntu"
|
|
example: docker-deploy --username="ubuntu"
|
|
======================================================
|
|
--uid <id>
|
|
set container user id
|
|
example: docker-deploy --uid=1000
|
|
======================================================
|
|
--gid <id>
|
|
set container user group id
|
|
example: docker-deploy --gid=1000
|
|
======================================================
|
|
-p|--port <port>
|
|
set ssh port to use
|
|
!! do not use 22 !!
|
|
example: docker-deploy -p=2239
|
|
example: docker-deploy --port=2239
|
|
======================================================
|
|
--ssh-dir <dir>
|
|
set ssh directory name found in the .ssh dir
|
|
of this repo for the container keys
|
|
This directory has separate files for
|
|
each public key allowed to access
|
|
the container
|
|
example: docker-deploy --ssh-dir="teamname"
|
|
======================================================
|
|
--sudo
|
|
switch to add the container user to the
|
|
sudo group of the container
|
|
example: docker-deploy --sudo
|
|
======================================================
|
|
-t|--time-zone <time/zone>
|
|
set time zone of the container
|
|
!! must valid time zone !!
|
|
example: docker-deploy -t="Africa/Windhoek"
|
|
example: docker-deploy --time-zone="Africa/Windhoek"
|
|
======================================================
|
|
HELP ʕ•ᴥ•ʔ
|
|
======================================================
|
|
-h|--help
|
|
display this help menu
|
|
example: docker-deploy -h
|
|
example: docker-deploy --help
|
|
======================================================
|
|
Docker Deployment v2.1.0
|
|
======================================================
|
|
```
|
|
---
|
|
# Uninstall
|
|
|
|
```shell
|
|
$ docker-deploy --uninstall
|
|
```
|
|
---
|
|
# Free Software License
|
|
```txt
|
|
@copyright Copyright (C) 2021 Llewellyn van der Merwe. All rights reserved.
|
|
@license GNU General Public License version 2; see LICENSE
|
|
```
|
|
|