Skip to content

Commit a8a4c48

Browse files
committed
README: improved documentation
Ref: #490 Ref: #491
1 parent 3983a16 commit a8a4c48

File tree

1 file changed

+31
-10
lines changed

1 file changed

+31
-10
lines changed

README.md

Lines changed: 31 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3,28 +3,49 @@
33
Code for the backend of SSHOC Marketplace Portal
44

55
## Running application via Docker
6-
Requirements:
76

8-
```
9-
docker : 19.03.0
10-
docker-compose : 1.24.0
11-
```
7+
Minimal requirements:
8+
9+
* docker : 19.03.0
10+
* docker-compose : 1.24.0
1211

1312
Run:
1413

1514
```
16-
docker-compose build
17-
docker-compose up
15+
docker compose build
16+
export egi_id=dummy egi_secret=dummy token_secret=dummy recaptcha_site_key=dummy recaptcha_secret_key=dummy
17+
docker compose up
1818
```
1919

20-
OpenAPI specification:
20+
On earlier docker versions, you may need `docker-compose` (with hyphen) instead of `docker
21+
compose`.
22+
23+
When upgrading from an earlier version *in a development environment*, you may
24+
need to remove any outdated persistent volumes as follows:
2125

2226
```
23-
http://localhost:8080/v3/api-docs
24-
http://localhost:8080/swagger-ui/index.html?url=http://localhost:8080/v3/api-docs
27+
docker volume rm sshoc-marketplace-backend-media-data sshoc-marketplace-backend-psql-data sshoc-marketplace-backend-solr-data
2528
```
2629

30+
Also make ensure you are using the latest images after upgraded and no previously cached containers.
31+
You can also build with `docker compose build --no-cache`.
32+
33+
Once running, you can access the OpenAPI specification here:
34+
35+
* <http://localhost:8080/v3/api-docs>
36+
* <http://localhost:8080/swagger-ui/index.html?url=http://localhost:8080/v3/api-docs>
37+
38+
The development data has the following default users and passwords predefined:
39+
40+
| Username | Password |
41+
| -------- | -------- |
42+
| `Administrator` | `q1w2e3r4t5` |
43+
| `Moderator` | `q1w2e3r4t5` |
44+
| `Contributor` | `q1w2e3r4t5` |
45+
| `System importer` | `q1w2e3r4t5` |
46+
2747
## Running application to development
48+
2849
Requirements in addition to docker:
2950

3051
```

0 commit comments

Comments
 (0)