From 5a4335998d8edfd73cbf8a2a1c1fb615b8a3585f Mon Sep 17 00:00:00 2001 From: Felix Bartels Date: Mon, 13 Jan 2020 08:43:18 +0100 Subject: [PATCH] add debugging input to readme and bug report template Signed-off-by: Felix Bartels --- .github/ISSUE_TEMPLATE/bug_report.md | 2 +- README.md | 5 +++-- examples/meet/README.md | 4 ++-- 3 files changed, 6 insertions(+), 5 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index f4ce3a1..856e350 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -24,4 +24,4 @@ A clear and concise description of what you expected to happen. If applicable, add screenshots to help explain your problem. Please don't post screenshots text blocks such as logfiles or general console output. **Additional context** -Add any other context about the problem here. +Add any other context about the problem here. Please check the [troubleshooting section](https://github.com/zokradonh/kopano-docker#troubleshooting) of the readme for additional details. diff --git a/README.md b/README.md index a6dbf37..de178c9 100644 --- a/README.md +++ b/README.md @@ -25,10 +25,11 @@ The `docker-compose.yml` file by default pulls Docker containers from https://hu If you are running into a problem please include the following issues in the description of your report: - the error message produced when running `docker-compose up` -- the output of `docker-compose ps` + - or the output of `docker-compose ps` - for failed containers the output of `docker-compose logs $containername` - the contents of your `.env` -- the output of `docker-compose config` +- either the output of `docker-compose config` (only useful when `docker-compose up` succeeds) or your `docker-compose.yml` +- the output of `docker -v` and `docker-compose -v` Please make sure to remove sensitive data (for example your real hostname or passwords for accounts) when posting these information publicly. diff --git a/examples/meet/README.md b/examples/meet/README.md index ba5ae3b..6b0907d 100644 --- a/examples/meet/README.md +++ b/examples/meet/README.md @@ -7,6 +7,6 @@ Check https://github.com/zokradonh/kopano-docker/blob/master/ldap_demo/README.md ## Instructions 1. run `setup.sh` -2. check `.env` for any required customisation (port 443 already in use?) +2. check `.env` for any required customization (port 443 already in use?) 3. run `docker-compose up` to start -4. navigate to https://your-domain to login to Kopano Meet \ No newline at end of file +4. navigate to https://your-domain to login to Kopano Meet