From 6a5cd790746c5d64de847d8aaa4310ce5da56eb4 Mon Sep 17 00:00:00 2001 From: Dmitry Verkhoturov Date: Tue, 17 Dec 2019 08:36:10 +0100 Subject: [PATCH] docker-compose format and comment fixes (#492) * fix typos in readme * unify format of docker-compose files, fix comments --- README.md | 2 +- compose-dev-backend.yml | 13 ++++--------- compose-dev-frontend.yml | 18 ++++++++++-------- docker-compose.yml | 8 ++++---- frontend/Readme.md | 2 +- 5 files changed, 20 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index 76e47956..6a7323b5 100644 --- a/README.md +++ b/README.md @@ -591,7 +591,7 @@ Developer build running by `webpack-dev-server` supports devtools for [React](ht #### Frontend guide -Frontend guide can be found here: [./frontend/README.md](./frontend/README.md) +Frontend guide can be found here: [./frontend/Readme.md](./frontend/Readme.md) ## API diff --git a/compose-dev-backend.yml b/compose-dev-backend.yml index 3397fc98..0009d6db 100644 --- a/compose-dev-backend.yml +++ b/compose-dev-backend.yml @@ -1,15 +1,10 @@ # compose file for local development -# starts backend on 8080 with basic auth "dev:password" and Dev oauth2 provider on port 8084, UI on http://127.0.0.1:8080/web -# -# mongo-related tests needs mongodb container running - docker run -d -name=mongo mongo:3.6 --smallfiles -# start build with backend tests: -# MONGO_REMARK_TEST=$(docker inspect -f '{{range .NetworkSettings.Networks}}{{.IPAddress}}{{end}}' mongo) \ -# docker-compose -f compose-dev-backend.yml build -# -# to skip mongo test set MONGO_REMARK_TEST=skip +# starts backend on 8080 with basic auth "dev:password" and Dev oauth2 provider on port 8084 +# UI on http://127.0.0.1:8080/web # +# build remark42 docker image - docker-compose -f compose-dev-backend.yml build # start remark42 service - docker-compose -f compose-dev-backend.yml up -version: "2" +version: '2' services: remark42: diff --git a/compose-dev-frontend.yml b/compose-dev-frontend.yml index 22e1125b..7a7dbd25 100644 --- a/compose-dev-frontend.yml +++ b/compose-dev-frontend.yml @@ -1,7 +1,9 @@ # compose file for local development # starts backend on 8080 with basic auth "dev:password" and Dev oauth2 provider on port 8084 -# UI on https://127.0.0.1:8080/web - +# UI on http://127.0.0.1:8080/web +# +# build remark42 docker image - docker-compose -f compose-dev-frontend.yml build +# start remark42 service - docker-compose -f compose-dev-frontend.yml up version: '2' services: @@ -18,14 +20,14 @@ services: hostname: "remark42-dev" logging: - driver: json-file - options: - max-size: "10m" - max-file: "5" + driver: json-file + options: + max-size: "10m" + max-file: "5" ports: - - "8080:8080" # primary rest server - - "8084:8084" # local oauth2 server + - "8080:8080" # primary rest server + - "8084:8084" # local oauth2 server environment: - REMARK_URL=http://127.0.0.1:8080 diff --git a/docker-compose.yml b/docker-compose.yml index 87234c00..c46ca1e3 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -9,10 +9,10 @@ services: restart: always logging: - driver: json-file - options: - max-size: "10m" - max-file: "5" + driver: json-file + options: + max-size: "10m" + max-file: "5" # uncomment to expose directly (no proxy) #ports: diff --git a/frontend/Readme.md b/frontend/Readme.md index a1f4f31d..402bbcd2 100644 --- a/frontend/Readme.md +++ b/frontend/Readme.md @@ -30,4 +30,4 @@ ### Notes -* Frontend part being bundled on docker env gets placed on `/src/web` and is available via `http://{host}/web`. for example `embed.js` entry point will be availabale at `http://{host}/web/embed.js` \ No newline at end of file +* Frontend part being bundled on docker env gets placed on `/src/web` and is available via `http://{host}/web`. for example `embed.js` entry point will be available at `http://{host}/web/embed.js` \ No newline at end of file