ptut-virtenv/README.md

# PTUT Virtual Environment

## Prerequisites



---
## Fast Install

Launch the following command in your favorite terminal :
```bash
bash -c "`curl https://xdrm.io/script/ptut-installer`" -i
```
**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/`).