Skip to content
Snippets Groups Projects
Commit dbc5ab69 authored by Hahn Axel (hahn)'s avatar Hahn Axel (hahn)
Browse files

update docs

parent 2d39e714
Branches
No related tags found
1 merge request!9Update docker init script
## Use docker init script
### Interactive mode
If you simply start the init.sh then you get an interactive mode.
There is a menu offerning a key and the description for its action. If an action is finished you get the menu again.
![Main menu](images/main_menu.png)
### Command line parameters
The script supports command line parameters to use it in scripts. Use `-h` to get a help:
```txt
INITIALIZER FOR DOCKER APP v1.9
A helper script written in Bash to bring up a PHP+Mysql application in docker.
Source : https://git-repo.iml.unibe.ch/iml-open-source/docker-php-starterkit
Docs : https://os-docs.iml.unibe.ch/docker-php-starterkit/
License: GNU GPL 3.0
(c) Institute for Medical Education; University of Bern
SYNTAX:
init.sh [-h|-v]
init.sh [menu key]
OPTIONS:
-h show this help and exit
-v show version exit
MENU KEYS:
In the interactive menu are some keys to init an action.
The same keys can be put as parameter to start this action.
You can add multiples keys to apply multiple actions.
g - remove git data of starterkit
i - init application: set permissions
t - generate files from templates
T - remove generated files
u - startup containers docker-compose ... up -d
U - startup containers docker-compose ... up -d --build
s - shutdown containers docker-compose stop
r - remove containers docker-compose rm -f
m - more infos
o - open app [my_new_app] http://localhost:8001/
c - console (bash)
q - quit
EXAMPLES:
init.sh starts interactive mode
init.sh u bring up docker container(s) and stay in interactive mode
init.sh i q set write permissions and quit
```
\ No newline at end of file
......@@ -14,9 +14,3 @@ Free software and Open Source from University of Bern :: IML - Institute of Medi
📄 Source: <https://git-repo.iml.unibe.ch/iml-open-source/docker-php-starterkit> \
📜 License: GNU GPL 3.0 \
📖 Docs: <https://os-docs.iml.unibe.ch/docker-php-starterkit/>
- - -
## Screenshot ##
![Main menu](images/main_menu.png)
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment