Merge pull request #84 from bancodobrasil/feat/readme-mac-config

Feat/readme M1 config

README-PTBR.md

@@ -42,4 +42,39 @@ Em seguida rode no terminal do repositório o comando a seguir:
 godoc -http=:6060
 ````
 
-O GoDoc será executado em `localhost:6060`. Para acessar a documentação do GoDoc, basta [clicar aqui](http://localhost:6060/pkg/).
+O GoDoc será executado em `localhost:6060`. Para acessar a documentação do GoDoc, basta [clicar aqui](http://localhost:6060/pkg/).
+
+## MacOS config
+
+O MySQL usado no arquivo Docker compose não é compatível aos chips da Apple (M1 e M2). Para que funcione faça as seguintes alterações:
+
+### Arquivo .env
+
+Crie a variável `FEATWS_API_MYSQL_URI` e adicione o caminho como a seguir:
+
+``````
+FEATWS_API_MYSQL_URI=api:api@tcp(localhost:3307)/api
+``````
+
+### Docker Compose
+
+No docker compose será necessário que seja alterado o MySQL para o MariaDB. Apenas é necessário alterar o **db** do docker-compose.
+
+``````
+  db:
+    image: mariadb
+    restart: always
+    ports:
+      - 3307:3306
+    volumes:
+      - ./data/mysql:/var/lib/mysql:rw
+    user: mysql
+    environment:
+      MARIADB_ROOT_PASSWORD: "root"
+      MARIADB_DATABASE: "api"
+      MARIADB_USER: "api"
+      MARIADB_PASSWORD: "api"
+      TELEMETRY_HTTPCLIENT_TLS: "false"
+      TELEMETRY_EXPORTER_JAEGER_AGENT_HOST: "localhost"
+      TELEMETRY_ENVIRONMENT: local
+``````

README.md

@@ -39,4 +39,39 @@ Then run the following command in the repository terminal:
 godoc -http=:6060
 ````
 
-GoDoc will run on `localhost:6060`. To access the GoDoc documentation, just [click here](http://localhost:6060/pkg/).
+GoDoc will run on `localhost:6060`. To access the GoDoc documentation, just [click here](http://localhost:6060/pkg/).
+
+## MacOS config
+
+The MySQL used in the Docker Compose file isn't compatible with Apple's M1 and M2 chips. To make it work, perform the following modifications:
+
+### Arquivo .env
+
+Create the variable FEATWS_API_MYSQL_URI and set the path as follows:
+
+``````
+FEATWS_API_MYSQL_URI=api:api@tcp(localhost:3307)/api
+``````
+
+### Docker Compose
+
+In the Docker Compose file, it is necessary to change MySQL to MariaDB. Only the "db" section in the docker-compose file needs to be modified.
+
+``````
+  db:
+    image: mariadb
+    restart: always
+    ports:
+      - 3307:3306
+    volumes:
+      - ./data/mysql:/var/lib/mysql:rw
+    user: mysql
+    environment:
+      MARIADB_ROOT_PASSWORD: "root"
+      MARIADB_DATABASE: "api"
+      MARIADB_USER: "api"
+      MARIADB_PASSWORD: "api"
+      TELEMETRY_HTTPCLIENT_TLS: "false"
+      TELEMETRY_EXPORTER_JAEGER_AGENT_HOST: "localhost"
+      TELEMETRY_ENVIRONMENT: local
+``````