Skip to content

Commit

Permalink
📝 Updated .md files with docker compose V2
Browse files Browse the repository at this point in the history
  • Loading branch information
SilviaAmAm committed Apr 3, 2024
1 parent 26940bb commit b9985bf
Show file tree
Hide file tree
Showing 5 changed files with 11 additions and 11 deletions.
2 changes: 1 addition & 1 deletion docker/camunda/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ for production usage.
Start a Camunda instance in your local environment from the parent directory:

```bash
docker-compose -f docker-compose.camunda.yml up -d
docker compose -f docker-compose.camunda.yml up -d
```

This brings up the database and Camunda stack. The Camunda cockpit is accessible on
Expand Down
8 changes: 4 additions & 4 deletions docker/embedding/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,14 @@

The JS SDK is built to support embedding forms in third party pages, like CMS pages.

The files here and the docker-compose configuration in the parent folder (
The files here and the `docker compose` configuration in the parent folder (
`docker-compose.embedding.yml`) exist to test and demo this behaviour.

## Requirements

To succesfully run an embed test setup, you need:

- docker-compose
- `docker compose`
- an Open Forms 2.5.0+ instance, available over HTTPS. E.g. `https://openforms.example.com`
- the instance must allow CORS requests from `https://localhost:9000`
- the instance must have `localhost:9000` in the CSRF trusted origins
Expand All @@ -19,7 +19,7 @@ Consult the installation/configuration
[documentation](https://open-forms.readthedocs.io/en/stable/developers/sdk/embedding.html#backend-configuration)
on how to properly configure your backend for embedding.

## Bring up docker-compose
## Bring up docker compose

All instructions are relative to the top-level directory.

Expand All @@ -38,7 +38,7 @@ All instructions are relative to the top-level directory.
2. Then, bring up the docker services:

```bash
docker-compose -f ./docker/docker-compose.embedding.yml up
docker compose -f ./docker/docker-compose.embedding.yml up
```

## Embed test cases
Expand Down
4 changes: 2 additions & 2 deletions docker/keycloak/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,12 @@ an example of an Identity Provider that supports OIDC.
We include a compose stack for development and CI purposes. This is **NOT** suitable
for production usage.

## docker-compose
## docker compose

Start a Keycloak instance in your local environment from the parent directory:

```bash
docker-compose -f docker-compose.keycloak.yml up -d
docker compose -f docker-compose.keycloak.yml up -d
```

This brings up Keycloak, the admin interface is accessible at http://localhost:8080/.
Expand Down
2 changes: 1 addition & 1 deletion docker/objects-apis/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Start an instance in your local environment from the parent directory:
docker compose -f docker-compose.objects-apis.yml up -d
```

Create a super user:
Create a superuser:

```bash
docker compose -f docker-compose.objects-apis.yml exec objecttypes-web src/manage.py createsuperuser
Expand Down
6 changes: 3 additions & 3 deletions nlx/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

[NLX][NLX] integration is optional.

This directory contains the docker-compose tooling and instructions on how to enable
This directory contains the `docker compose` tooling and instructions on how to enable
NLX on the demo network and connect Open Forms services with it.

Ensure you are in the Open Forms repository `nlx` directory for any steps documented
Expand Down Expand Up @@ -45,10 +45,10 @@ sudo chmod go-rwx nlx-try-me/pki/certs/internal-cert-key.pem

## Running the NLX stack

Navigate to this (`nlx`) directory and start the components using docker-compose:
Navigate to this (`nlx`) directory and start the components using `docker compose`:

```bash
docker-compose up
docker compose up
```

and follow the rest of the guide at the
Expand Down

0 comments on commit b9985bf

Please sign in to comment.