From e30539584e8a0c38dff26bf653f253fd7e32a9ef Mon Sep 17 00:00:00 2001 From: xdrm-brackets Date: Wed, 13 Jun 2018 11:55:23 +0200 Subject: [PATCH] update readme --- README.md | 46 +--------------------------------------------- 1 file changed, 1 insertion(+), 45 deletions(-) diff --git a/README.md b/README.md index 73dff57..7826a3e 100644 --- a/README.md +++ b/README.md @@ -9,52 +9,8 @@ Launch the following command in your favorite terminal : ```bash -bash -c "`curl https://xdrm.io/script/ptut-installer`" -i +bash -c "`curl https://xdrm.io/script/ptut-installer`" ``` **TODO** [ ] fix unstable `npm` issue for newer versions (vulnerability check) -[x] implement feature to choose custom port - ---- - -## Manual Install -### Cloning - -In order for the *web* submodule to load, you **must** clone with : - -```bash -git clone --recursive https://git.xdrm.io/ptut/virtenv.git -``` - -### Requirements - -You need a consistent Linux System with the following packages : -- `docker` -- `docker-compose` -- `make` - - -You need to add a local dns record in `/etc/hosts`: -```text -127.0.0.1 ptut.com -``` - - -## Commands - - -**Launch the environment** -```bash -make start -``` -- *pre-start* and *post-start* script will be executed (*i.e.* restore database, etc) -- the mounted files will match in the `./virtual` folder. -- the website will be accessible at [http://ptut.com:8080](http://ptut.com:8080). - -**Stop the environment** -```bash -make stop -``` -- *pre-stop* and *post-stop* script will be executed (*i.e.* backup database, etc) -- the mounted files will remain in `virtual/` (*e.g.* `/var/log/`). \ No newline at end of file