Skip to content

Commit

Permalink
updated docker README
Browse files Browse the repository at this point in the history
  • Loading branch information
@i3rotlher
i3rotlher committed Sep 21, 2023
1 parent 67e0072 commit f56f6fc
Showing 1 changed file with 26 additions and 23 deletions.
49 changes: 26 additions & 23 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Behaviour-driven development (BDD) extends the Test-Driven Development (TDD) approach by the ‘desired behaviour’ of a software. It is designed to ensure a collaboration between business analysts and developers with explicitly written down scenarios.

* Check out the [Tutorial (english)](https://github.com/adessoAG/Seed-Test/wiki/Tutorial_eng) / [Tutorial (german)](https://github.com/adessoAG/Seed-Test/wiki/Tutorial_deu)
- Check out the [Tutorial (english)](https://github.com/adessoAG/Seed-Test/wiki/Tutorial_eng) / [Tutorial (german)](https://github.com/adessoAG/Seed-Test/wiki/Tutorial_deu)

## What is Seed-Test?

Expand Down Expand Up @@ -35,6 +35,7 @@ Once you have Docker installed, the process of setting up Seed is straightforwar

- Go to the [releases page](https://github.com/adessoSE/Seed-Test/releases) of Seed on GitHub.
- Download the `docker-compose.yml` file from the assets for the specific release you want.

2. **Navigate and Execute:**

- Open a terminal.
Expand Down Expand Up @@ -73,7 +74,8 @@ To configure anything when running seed via docker, you can simply adjust the en

| Variable | Description |
| :----------------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| DATABASE_URI* | The mongoDB Connection String URI. This can be replaced with your own mongoDB.<br />If you are using the MongoDB provided by docker-compose, this needs to match the values set for the mongoDB in the docker compose. |
| FRONTEND_URL | The frontend URL should be configured to match the server's URL where the frontend container is running. The default value is set to 'http://localhost:4200' (which is the default location of the frontend container). |
| DATABASE_URI\* | The mongoDB Connection String URI. This can be replaced with your own mongoDB.<br />If you are using the MongoDB provided by docker-compose, this needs to match the values set for the mongoDB in the docker compose. |
| REPORT_DELETION_TIME | Time (in minutes) after which the report is deleted. |
| SESSION_SECRET | Session secret to establish a secure connection and prevent session hijacking (used in /backend/src/server.js).<br />See https://www.npmjs.com/package/express-session |
| JIRA_SECRET | Jira Integration : values used for the encryption of sensible data.<br />Choose a strong Secret like for example generated by RandomKeygen. |
Expand All @@ -82,29 +84,30 @@ To configure anything when running seed via docker, you can simply adjust the en
| EMAIL_PW | Mail password credentials to send password reset mails (used in /backend/src/nodemailer.js) |
| EMAIL_PORT | Mail server port to send password reset mails (used in /backend/src/nodemailer.js) |
| EMAIL_HOST | Mail server adress to send password reset mails (used in /backend/src/nodemailer.js) |
| GITHUB_CLIENT_SECRET | GitHub integration. Check out GitHub´s Guide on Autorizing OAuth Apps. |
| GITHUB_CLIENT_ID | GitHub integration. Check out GitHub´s Guide on Autorizing OAuth Apps. |
| PASSPORT_GITHUB_LOCAL_PW_FIELD | GitHub integration. Check out GitHub´s Guide on Autorizing OAuth Apps. |
| GITHUB_CLIENT_SECRET | GitHub integration. Check out GitHub´s Guide on Autorizing OAuth Apps. |
| GITHUB_CLIENT_ID | GitHub integration. Check out GitHub´s Guide on Autorizing OAuth Apps. |
| PASSPORT_GITHUB_LOCAL_PW_FIELD | GitHub integration. Check out GitHub´s Guide on Autorizing OAuth Apps. |
| MAX_SAVED_REPORTS | The amount of maximum saved reports. |

*If you are not using the mongoDB provided by this docker-compose you can completely delete the seedmongodb section from the docker-compose.yml and remove the depends on part of the backend service.
\*If you are not using the mongoDB provided by this docker-compose you can completely delete the seedmongodb section from the docker-compose.yml and remove the depends on part of the backend service.

##### Frontend

| Variable | Meaning |
| :--------------- | :--------------------------------------------------------------------------------- |
| GITHUB_CLIENT_ID | GitHub integration. Check out GitHub´s Guide on Autorizing OAuth Apps. |
| VERSION | This controls if the demo warning is shown. Set this to "set" to make it disapear. |
| Variable | Meaning |
| :--------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| GITHUB_CLIENT_ID | GitHub integration. Check out GitHub´s Guide on Autorizing OAuth Apps. |
| VERSION | This controls if the demo warning is shown. Set this to "set" to make it disapear. |
| API_SERVER | The URL for the server or container hosting the backend. The default setting is 'http://localhost:8080/api' (which is the default location of the backend container). |

##### Database

| Variable | Meaning |
| :-------------------------- | :-------------------------------------------------- |
| MONGO_INITDB_ROOT_USERNAME* | The username which should be used for the database. |
| MONGO_INITDB_ROOT_PASSWORD* | The password which should be used for the database. |
| MONGO_INITDB_DATABASE* | The name which should be used for the database. |
| Variable | Meaning |
| :--------------------------- | :-------------------------------------------------- |
| MONGO_INITDB_ROOT_USERNAME\* | The username which should be used for the database. |
| MONGO_INITDB_ROOT_PASSWORD\* | The password which should be used for the database. |
| MONGO_INITDB_DATABASE\* | The name which should be used for the database. |

*By modifying any of these variables, remember to adjust the corresponding database URI in the backend configuration as well.
\*By modifying any of these variables, remember to adjust the corresponding database URI in the backend configuration as well.

### 🤙 By hand:

Expand All @@ -115,13 +118,13 @@ This requires some more steps to be done.

To install docker by hand [NodeJS](https://nodejs.org/en/) needs to be installed.

| Browser | |
| ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Chrome* | Download and install[Google Chrome](). Download the version of the [chromedriver](https://chromedriver.chromium.org/downloads) that matches your version of Google Chrome. Extract the "chromedriver.exe" and set a path to it. |
| Edge | Download and install[Microsoft Edge](https://www.microsoft.com/en-us/edge/download?form=MA13FJ). Download the corresponding [edgedriver](https://developer.microsoft.com/en-us/microsoft-edge/tools/webdriver/), unpack it and set a path to the "msedgedriver.exe". |
| Firefox | Download and install[Mozilla Firefox](https://www.mozilla.org/de/firefox/new/). Download the [geckodriver](https://github.com/mozilla/geckodriver/releases) in the assets, unpack it and set a path to the "geckodriver.exe". |
| Browser | |
| -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Chrome\* | Download and install [Google Chrome](). Download the version of the [chromedriver](https://chromedriver.chromium.org/downloads) that matches your version of Google Chrome. Extract the "chromedriver.exe" and set a path to it. |
| Edge | Download and install [Microsoft Edge](https://www.microsoft.com/en-us/edge/download?form=MA13FJ). Download the corresponding [edgedriver](https://developer.microsoft.com/en-us/microsoft-edge/tools/webdriver/), unpack it and set a path to the "msedgedriver.exe". |
| Firefox | Download and install [Mozilla Firefox](https://www.mozilla.org/de/firefox/new/). Download the [geckodriver](https://github.com/mozilla/geckodriver/releases) in the assets, unpack it and set a path to the "geckodriver.exe". |

*Seed-Test uses Google Chrome by default for executing selenium.
\*Seed-Test uses Google Chrome by default for executing selenium.

#### Installing Seed

Expand Down Expand Up @@ -220,4 +223,4 @@ Copyright (c) 2018 adesso SE Permission is hereby granted, free of charge, to an

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

0 comments on commit f56f6fc

Please sign in to comment.