Add Vagarnt in project RADME and fix feeback @moufmouf

This commit is contained in:
gparant 2020-04-04 11:36:18 +02:00
parent 9bbfc3f371
commit 63dc515c5b
3 changed files with 47 additions and 2 deletions

View File

@ -30,3 +30,48 @@ Note: on some OSes, you will need to add this line to your `/etc/hosts` file:
workadventure.localhost 127.0.0.1 workadventure.localhost 127.0.0.1
``` ```
## MacOs developer, your environment with Vagrant
Increase Docker Performance with Vagrant. If you want more explain you can read: [this medium article](https://medium.com/better-programming/vagrant-to-increase-docker-performance-with-macos-25b354b0c65c).
### Prerequisites
- VirtualBox* 5.x Latest version https://www.virtualbox.org/wiki/Downloads
- Vagrant 2.2.7 Latest version https://www.vagrantup.com/downloads.html
### First steps
Create config file `Vagrantfile` with `Vagrantfile.template`
````bash
cp Vagrantfile.template Vagrantfile
````
In `Vagrantfile` Update `VM_HOST_PATH` with your local file path of your machine.
````
#VM_HOST_PATH# => your local machine path of the project
````
run `pwd` and copy the path in this variable.
To start your VM Vagrant, run
````bash
Vagrant up
````
To connect on your VM run
````bash
Vagrant ssh
````
To start project environment docker, run
````bash
docker-compose up
````
You environment run in you VM Vagrant. When you want stop your VM, you can run
````bash
Vagrant halt
````
If you want to destroy, you can run
````bash
Vagrant destroy
````
### Available commands
* `Vagrant up`: start your VM Vagrant.
* `Vagrant reload`: reload your VM Vagrant when you change Vagrantfile.
* `Vagrant ssh`: connect on your VM Vagrant.
* `Vagrant halt`: stop your VM Vagrant.
* `Vagrant destroy`: delete your VM Vagrant.

View File

@ -14,7 +14,7 @@
"url": "git+https://github.com/thecodingmachine/workadventure.git" "url": "git+https://github.com/thecodingmachine/workadventure.git"
}, },
"author": "g.parant@thecodingmachine.com", "author": "g.parant@thecodingmachine.com",
"license": "ISC", "license": "AGPL",
"bugs": { "bugs": {
"url": "https://github.com/thecodingmachine/workadventure/issues" "url": "https://github.com/thecodingmachine/workadventure/issues"
}, },

View File

@ -32,5 +32,5 @@ services:
volumes: volumes:
- ./back:/usr/src/app - ./back:/usr/src/app
labels: labels:
- "traefik.http.routers.back.rule=Host(`back.workadventure.localhost`)" - "traefik.http.routers.back.rule=Host(`api.workadventure.localhost`)"
- "traefik.http.services.back.loadbalancer.server.port=8080" - "traefik.http.services.back.loadbalancer.server.port=8080"