diff --git a/README.md b/README.md index 9aa843fa..0e86a875 100644 --- a/README.md +++ b/README.md @@ -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 ``` +## 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. + + diff --git a/back/package.json b/back/package.json index 97290635..b86e21c8 100644 --- a/back/package.json +++ b/back/package.json @@ -14,7 +14,7 @@ "url": "git+https://github.com/thecodingmachine/workadventure.git" }, "author": "g.parant@thecodingmachine.com", - "license": "ISC", + "license": "AGPL", "bugs": { "url": "https://github.com/thecodingmachine/workadventure/issues" }, diff --git a/docker-compose.yaml b/docker-compose.yaml index 7aca504e..86923563 100644 --- a/docker-compose.yaml +++ b/docker-compose.yaml @@ -32,5 +32,5 @@ services: volumes: - ./back:/usr/src/app 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"