From 0a36415a9ca8b0212dc7371cb48b57d509ad1a9b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Robert=20Sch=C3=A4fer?= Date: Thu, 24 Jan 2019 13:41:24 +0100 Subject: [PATCH] Remove verbosity of README * Delete suggestions how to remove dangling images - I would suggest `docker system prune` * Use bullet points without numbers --- README.md | 57 +++++++++++++++---------------------------------------- 1 file changed, 15 insertions(+), 42 deletions(-) diff --git a/README.md b/README.md index 21cba8d..3929ada 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,6 @@ -### install docker -choose community edition CE +# Prerequisites + +Install docker community edition CE: https://docs.docker.com/engine/installation/ **example install docker ubuntu** @@ -8,58 +9,30 @@ https://docs.docker.com/engine/installation/linux/docker-ce/ubuntu/ **Post-installation steps for Linux** https://docs.docker.com/engine/installation/linux/linux-postinstall/ -### install docker-compose +Install docker-compose: https://docs.docker.com/compose/install/ -# WIP - -# auto install ubuntu - -* options stop container -``` -docker stop $(docker ps -a -q) -``` -* options delete container -``` -docker rm $(docker ps -a -q) -``` -* options delete images -``` -docker rmi $(docker images -q) -``` - -* auto install : docker , docker-compose and communecter -``` -wget -O - https://gist.githubusercontent.com/aboire/4c83ff97026b1a4fabaada09950b2fc8/raw/install.sh| bash -``` -* updating the user's permissions to edit files -``` -cd ~/pixelhumain-docker -sudo chown -R ${USER:=$(/usr/bin/id -run)}:$USER code/pixelhumain/ -sudo chown -R ${USER:=$(/usr/bin/id -run)}:$USER code/modules/ -sudo chown -R ${USER:=$(/usr/bin/id -run)}:$USER code/log/ -``` -# Initial setup -* 0 Clone this repository +# Installation +* Clone this repository ``` git clone https://github.com/pixelhumain/docker pixelhumain-docker ``` -* 1 Create a folder *code* *code/data/db* *code/log* that will be the source directory inside pixelhumain-docker +* Create a folder *code* *code/data/db* *code/log* that will be the source directory inside pixelhumain-docker ``` mkdir -p code/data/db mkdir -p code/log ``` -* 2 Put your source file in the *code* directory: - - see https://github.com/pixelhumain/pixelhumain/blob/master/README.md - - use the docker image provided below - - Your VCS / IDE / ... -* 3 Start the containers using: +* Put your source file in the *code* directory: + - see https://github.com/pixelhumain/pixelhumain/blob/master/README.md + - use the docker image provided below + - Your VCS / IDE / ... +* Start the containers using: ``` docker-compose -f docker-compose.yml up ``` -* 4 Access to the test service through http://127.0.0.1:5080/ -* 5 Access to communecter through http://127.0.0.1:5080/ -* 6 You can modify your sources code with your prefered editor in the code directory +* Access to the test service through http://127.0.0.1:5080/ +* Access to communecter through http://127.0.0.1:5080/ +* You can modify your sources code with your prefered editor in the code directory # Layout overview